WordPress制作マニュアル

WordPressのテーマやプラグインの制作を行う上で実行すべき事項や規約、便利なプラグインなど自分の中で定めているルールをまとめておこうと思います。随時更新。

コーディング規約

WordPress.org で定めてある Cording Standards に則ってコーディングを行います。
WordPress Coding Standards

PHP / HTML / CSS / JavaScript が対象となります。その他の言語を使用する場合は、その言語に応じてコーディング規約を提示します。

変数や関数・クラス名などの命名規則も定めてありますので、規約に則ってコーディングを行います。
WordPress コーディング規約

Typo Error がなるべく出ないように命名します。

制作対象ページ（基本テーマ制作）

「基本テンプレートページ制作」と呼ぶ対象は以下の12ファイルを指します。
テンプレート階層

wp-content
┗ themes
　　┗ xxxxxxx（テーマ名）
　　　 ┣ js （JavaScriptが必要な場合はこのディレクトリに保存）
　　　 ┣ css （style.css以外に個別にページで指定する場合はこのディレクトリに保存）
　　　 ┗ images （テーマで使用する画像を保存）※変更が行われる可能性がある画像がメディアアップローダーを使用

外部ファイル（JavaScript・StyleSheet）の読み込み

JavaScriptやStyleSheetは、必ず外部ファイルにします。HTML埋め込みやインラインでの記述は行わないようにします。
外部ファイルの読込も header.php などのテンプレートファイルに直接書き込まず、functions.php で登録・挿入の記述を行うようにします。

• StyleSheet 登録 : wp_register_style
  Function Reference/wp_register_style
• JavaScript 登録 : wp_register_script
  Function Reference/wp_register_script

カスタマイズ

テーマに対してカスタマイズを実装する場合は、原則 fucntions.php にまとめて記述をします。

セキュリティポリシー

WordPressには、セキュリティに関するガイドラインが定めてあります。セキュリティコンポーネントとこのソフトウェアのベストプラクティスとして習熟すべきです。必ず内容を確認しておきましょう。
WordPress セキュリティ白書

デバッグモード

ローカル環境で制作を行う際に必ずデバッグモードをONにして作業を行って下さい。wp-config.php に設定がある以下の値をfalseからtrueに設定。ログは/wp_content/debug.log に記録されます。

define('WP_DEBUG', true); // デバッグモードを有効化

// ログファイルに保存する場合は、以下を書き足します。
if ( WP_DEBUG ) {
    // debug.log ファイルに記録
    define( 'WP_DEBUG_LOG', true );
    // ブラウザ上に表示しない
    define( 'WP_DEBUG_DISPLAY', false );
    // ブラウザ上に表示しない
    @ini_set( 'display_errors',0 );
}

テーマやプラグインの制作中に非推奨関数を使用したり、Notice,Warningエラーを表示するために設定します。このエラーが出ない状態で完了させてください。（一部、こちらから指定してプラグインで発生するものは除きます。）

テスト

制作中は、テストデータをインポートした状態で制作してください。テストデータが入力されている状態で表示崩れなど起こさないようにコーディングを行って下さい。

• ※テストデータのインポート時はデバッグモードを一時的にFALSEに設定してください。警告が出て取り込めない場合があります。
• ※vccwでローカル開発を行う場合は、インポートプラグイン以外を停止して取り込んで下さい。

• Theme Unit Test
• Theme Test Data(Japanese)