WordPressにおけるJavaScriptコーディング標準

WordPressコーディング標準は、テーマやプラグインのJavaScriptコードの書式やスタイルに関するガイドラインも提供しています。さらに、これらの標準は、コア PHP、HTML、CSS コードとのコードの一貫性を促進するのに役立ちます。

ワードプレス JavaScriptコーディング標準をベースにjQuery JavaScriptスタイルガイド2012年に発表されたjQueryガイドラインに基づくこのガイドは、コードの一貫性と可読性を高めるコーディング仕様の包括的なセットです。当初、このガイドラインはjQueryプロジェクトに特化したものでしたが、その成功により、jQueryフレームワーク以外でも広く採用されるようになりました。

jQueryのガイドはWordPressの標準を参考にしていますが、WordPressの開発には大きな違いがあります：

• WordPressでは、文字列の宣言にシングルクォートを使用します。
• case文はswitchブロックの中でインデントされている。
• 関数の内容は、完全なファイル・クロージャ・ラッパーを含め、一貫してインデントされる。
• PHP WordPress の標準と一致させるために、タブの使用やインデントなど、空白のルールの一部が異なっています。
• jQueryの100文字というハードリミットは、推奨はされていますが、厳密には実施されていません。

WordPressのJavaScriptコーディング標準は、以下の領域をカバーしています：

• コード・リファクタリング.
• コード間隔オブジェクト宣言、配列、関数呼び出しなど：

// オブジェクト宣言
// DO
var obj = {
    name: 'John'、
    name: 'John', age: 27, height: 179
    name: 'John', age: 27, height: 179
}
// しない
var obj = {
    name: 'John', age: 27, height: 179 }.
    name: 'John', age: 27, height: 179
}
// 配列と関数呼び出し
// 要素や引数の周りには余分なスペースを入れてください。
foo( arg1, arg2 ).
// オブジェクト宣言
// DO
var obj = {
    name: 'John'、
    name: 'John', age: 27, height: 179
    name: 'John', age: 27, height: 179
}

// しない
var obj = {
    name: 'John', age: 27, height: 179 }.
    name: 'John', age: 27, height: 179
}

// 配列と関数呼び出し
// 要素や引数の周りには余分なスペースを入れてください。

foo( arg1, arg2 ).
// オブジェクト宣言
// DO
var obj = {
    name: 'John'、
    name: 'John', age: 27, height: 179
    name: 'John', age: 27, height: 179
}

// しない
var obj = {
    name: 'John', age: 27, height: 179 }.
    name: 'John', age: 27, height: 179
}

// 配列と関数呼び出し
// 要素や引数の周りには余分なスペースを入れてください。

foo( arg1, arg2 ).

セミコロンの使用：

// 常にセミコロンを使用する
array = [ 1, 2 ]；
// 常にセミコロンを使用する
array = [ 1, 2 ]；
// 常にセミコロンを使用する
array = [ 1, 2 ]；

インデントと改行ブロックや中括弧、複数行のステートメント、連鎖したメソッド呼び出しなど：

// インデントにタブを使用する
( function ( $ ) { )
    // 式をインデントする
    関数 doSomething() {
        // 式をインデント
    }
} ) ( jQuery )
// if、else、for、while、tryブロックは複数行にまたがるようにする。
if ( 条件 ) { // 式
    // 式
} else if ( ( 条件 && 条件 ) || 条件 ) { // 式
    } else if ( 条件 && 条件 ) || 条件 ) { // 式
} else { // 式
    // 式
}
// 文が1行に収まりきらない場合は、演算子の後で改行する必要があります。
// 1行に収めるには長すぎる場合、改行が必要です。
var html = '<p>a + ' と ' + b + ' の和に ' + c + ' を足したものは ' + ( a + b + c ) + ' である。
    ' は ' + ( a + b + c ) + ' です。</p>'; /* メソッド呼び出しの連鎖が長すぎて1行に収まらない場合
/* メソッド呼び出しの連鎖が長すぎて1行に収まらない場合は、1行に1つの呼び出しを使用します。
   最初の呼び出しは、メソッドが呼び出されるオブジェクトとは別の行にする。
   最初の呼び出しは、メソッドが呼び出されるオブジェクトとは別の行にする必要があります。
要素
    .addClass( 'foo' )
    .children()
        .html( 'hello' )
    .children() .html( 'hello' ) .end()
    .appendTo( 'body' )；
// インデントにタブを使用する
( function ( $ ) { )
    // 式をインデントする
    関数 doSomething() {
        // 式をインデント
    }
} ) ( jQuery )

// if、else、for、while、tryブロックは複数行にまたがるようにする。
if ( 条件 ) { // 式
    // 式
} else if ( ( 条件 &amp;&amp; 条件 ) || 条件 ) { // 式
    } else if ( 条件 &amp;&amp; 条件 ) || 条件 ) { // 式
} else { // 式
    // 式
}

// 文が1行に収まりきらない場合は、演算子の後で改行する必要があります。
// 1行に収めるには長すぎる場合、改行が必要です。
var html = '<p>a + ' と ' + b + ' の和に ' + c + ' を足したものは ' + ( a + b + c ) + ' である。
    ' は ' + ( a + b + c ) + ' です。</p>'; /* メソッド呼び出しの連鎖が長すぎて1行に収まらない場合
/* メソッド呼び出しの連鎖が長すぎて1行に収まらない場合は、1行に1つの呼び出しを使用します。
   最初の呼び出しは、メソッドが呼び出されるオブジェクトとは別の行にする。
   最初の呼び出しは、メソッドが呼び出されるオブジェクトとは別の行にする必要があります。
要素
    .addClass( 'foo' )
    .children()
        .html( 'hello' )
    .children() .html( 'hello' ) .end()
    .appendTo( 'body' )；
// インデントにタブを使用する
( function ( $ ) { )
    // 式をインデントする
    関数 doSomething() {
        // 式をインデント
    }
} ) ( jQuery )

// if、else、for、while、tryブロックは複数行にまたがるようにする。
if ( 条件 ) { // 式
    // 式
} else if ( ( 条件 &amp;&amp; 条件 ) || 条件 ) { // 式
    } else if ( 条件 &amp;&amp; 条件 ) || 条件 ) { // 式
} else { // 式
    // 式
}

// 文が1行に収まりきらない場合は、演算子の後で改行する必要があります。
// 1行に収めるには長すぎる場合、改行が必要です。
var html = '<p>a + ' と ' + b + ' の和に ' + c + ' を足したものは ' + ( a + b + c ) + ' である。
    ' は ' + ( a + b + c ) + ' です。</p>'; /* メソッド呼び出しの連鎖が長すぎて1行に収まらない場合
/* メソッド呼び出しの連鎖が長すぎて1行に収まらない場合は、1行に1つの呼び出しを使用します。
   最初の呼び出しは、メソッドが呼び出されるオブジェクトとは別の行にする。
   最初の呼び出しは、メソッドが呼び出されるオブジェクトとは別の行にする必要があります。
要素
    .addClass( 'foo' )
    .children()
        .html( 'hello' )
    .children() .html( 'hello' ) .end()
    .appendTo( 'body' )；

• 割り当てとグローバル変数これには変数の使用と宣言が含まれるコンストグローバル変数とパブリックライブラリレット変数を宣言する。変化
• という命名規則がある。略語や頭字語、クラスの定義、定数など：

// 略語はキャメルケースで書くこと。
// 頭字語の文字はすべて大文字にする。
const userId = 1; const currentDOMDocument = window.document; // 略語の文字はすべて大文字にする。
const currentDOMDocument = window.document; const userId = 1; const currentDOMDocument = window.
const userId = 1; const currentDOMDocument = window.document; // クラス定義では、UpperCamelCaseConvention を使用する必要があります。
クラス Human {
    ...
}
// 定数にはSCREAMING_SNAKE_CASEを使用する必要があります。
const SESSION_DURATION = 60
// 略語はキャメルケースで書くこと。
// 頭字語の文字はすべて大文字にする。
const userId = 1; const currentDOMDocument = window.document; // 略語の文字はすべて大文字にする。
const currentDOMDocument = window.document; const userId = 1; const currentDOMDocument = window.

const userId = 1; const currentDOMDocument = window.document; // クラス定義では、UpperCamelCaseConvention を使用する必要があります。
クラス Human {
    ...
}

// 定数にはSCREAMING_SNAKE_CASEを使用する必要があります。
const SESSION_DURATION = 60
// 略語はキャメルケースで書くこと。
// 頭字語の文字はすべて大文字にする。
const userId = 1; const currentDOMDocument = window.document; // 略語の文字はすべて大文字にする。
const currentDOMDocument = window.document; const userId = 1; const currentDOMDocument = window.

const userId = 1; const currentDOMDocument = window.document; // クラス定義では、UpperCamelCaseConvention を使用する必要があります。
クラス Human {
    ...
}

// 定数にはSCREAMING_SNAKE_CASEを使用する必要があります。
const SESSION_DURATION = 60

平等だ。

// 厳密な等号/非等号チェック（===と！==)
// を使用する！==).
if ( name === "John" ) { ...
    ...
}
if ( result ！== false ) { .
    ...
}
// また、否定の場合： if ！
if ！( result === false ) { ...
    ...
}
// 厳密な等号/非等号チェック（===と！==)
// を使用する！==).
if ( name === "John" ) { ...
    ...
}
if ( result ！== false ) { .
    ...
}

// また、否定の場合： if ！
if ！( result === false ) { ...
    ...
}
// 厳密な等号/非等号チェック（===と！==)
// を使用する！==).
if ( name === "John" ) { ...
    ...
}
if ( result ！== false ) { .
    ...
}

// また、否定の場合： if ！
if ！( result === false ) { ...
    ...
}

ストリング::

// 文字列リテラルにはシングルクォートを使用する。
    var myString = 'Hello world！
// 文字列リテラルにはシングルクォートを使用する。
    var myString = 'Hello world！
// 文字列リテラルにはシングルクォートを使用する。
    var myString = 'Hello world！

スイッチング・ステートメント::

// デフォルト以外のケースにはブレークを使用する。
// switch ( event.keyCode ) { event.
switch ( event.keyCode ) { // ENTERとSPACEはどちらもx()をトリガーします。
    // case $.ui.keyCode.
    case $.ui.keyCode.ENTER.
    ENTER: case $.ui.keyCode.SPACE: // ENTERとSPACEの両方がx()をトリガーする。
        SPACE。
        SPACE: x(); x(); x(); x()
    case $.ui.keyCode.ESCAPE.
        ESCAPE: y(); break; case $.ui.keyCode.ESCAPE.
        ESCAPE: y(); break; case $.ui.keyCode.
    default: z(); break; case $.ui.keyCode.
        y(); break; default: z()；
}
// デフォルト以外のケースにはブレークを使用する。
// switch ( event.keyCode ) { event.
switch ( event.keyCode ) { // ENTERとSPACEはどちらもx()をトリガーします。
    // case $.ui.keyCode.
    case $.ui.keyCode.ENTER.
    ENTER: case $.ui.keyCode.SPACE: // ENTERとSPACEの両方がx()をトリガーする。
        SPACE。
        SPACE: x(); x(); x(); x()
    case $.ui.keyCode.ESCAPE.
        ESCAPE: y(); break; case $.ui.keyCode.ESCAPE.
        ESCAPE: y(); break; case $.ui.keyCode.
    default: z(); break; case $.ui.keyCode.
        y(); break; default: z()；
}
// デフォルト以外のケースにはブレークを使用する。
// switch ( event.keyCode ) { event.
switch ( event.keyCode ) { // ENTERとSPACEはどちらもx()をトリガーします。
    // case $.ui.keyCode.
    case $.ui.keyCode.ENTER.
    ENTER: case $.ui.keyCode.SPACE: // ENTERとSPACEの両方がx()をトリガーする。
        SPACE。
        SPACE: x(); x(); x(); x()
    case $.ui.keyCode.ESCAPE.
        ESCAPE: y(); break; case $.ui.keyCode.ESCAPE.
        ESCAPE: y(); break; case $.ui.keyCode.
    default: z(); break; case $.ui.keyCode.
        y(); break; default: z()；
}

さらに、WordPressのコーディング標準では、JavaScriptコードを記述するいくつかの方法を概説しています。ベストプラクティス。

PHP と同様に、WordPress は JavaScript コードをインラインドキュメンテーション規格.これらのインライン標準は、書式化されたドキュメントブロックか、インラインJavaScriptドキュメントのJSDoc 3 スタンダード.インライン標準は、関数、クラス・メソッド、オブジェクト、クロージャ、オブジェクト・プロパティ、イベント、ファイル・ヘッダをカバーしている。

概要

コーディング標準は、効率的な共同ソフトウェア開発のバックボーンである。コードの一貫性と可読性を確保し、コーディングプロセスを簡素化し、保守性を向上させ、チームワークを促進します。WordPress の開発者にとって、コーディング標準の遵守は、堅牢で拡張性の高いウェブサイトを作成するために不可欠です。