WordPressコーディング規約抜粋

WordPressのコーディング規約から覚えるべきことをいくつか抜粋してみた。

コメント

<?php

/**
 * ファイルのタイトル
 *
 * ファイルの説明.
 *
 * @category   Components
 * @package    WordPress
 * @subpackage Theme Name
 * @author     Name <hoge@example.com>
 * @license    https://www.gnu.org/licenses/gpl-3.0.txt GNU/GPLv3
 * @link       https://example.com
 * @since      1.0.0
 */

**
 * Undocumented function
 *
 * @param [type] $arg
 * @return void
 */
function hoge() {
  return true;
}

echoでの出力

// echoで出力する際は、必ずエスケープ
echo esc_url($url);

ヨーダ記法

// 値を先に記載するヨーダ記法が求められる
if (true === $hoge) {

スーパーグローバル変数を使用する場合

WordPress で $_GET、$_POST、$_REQUEST、$_COOKIE、$_SERVER といった PHP のスーパーグローバルの値を扱う場合、まず wp_unslash()を使用して不要なバックスラッシュを取り除いてやる必要がある。
これは WordPress 内部において PHP のマジッククオートと同等の処理が行われているためである。

update_post_meta( sanitize_text_field( wp_unslash( $_GET['hoge'] ) ) );

また$_GETを使用する場合、get_query_varでクエリを登録しておくことが推奨されている。