WordPressのコーディングスタンダードって知ってるかい?

2012.12.20 | 覚えておきたい
スポンサードリンク

こんにちは!

こないだ、「うんこって浮くんですね。流れなくてどうしようかと思った。。。」ってツイートしたらフォロワーが一気に減ったクロです。

みんな油物の取り過ぎには注意しようね!

コーディングスタンダードって知ってる?

みなさんWordPressを使ってテーマとかプラグインとかソースを書きますよね!

なかには「おまえのソース見にくいんじゃーっ!」って上司から怒られたことがある人もいるはず。

実はプログラミング業界にはコーディングスタンダードって言う物があって、製品や企業などによって、変数名をどうつけるべきかとか、1行は何文字までとか、はなくそをほじりながらプログラミングをしちゃいけないとか、いろいろルールが決められています。

このコーディングスタンダードを覚えておくと、プログラムのソースコードが見やすくなるだけじゃなくて、ソースを検索するときなんかも、とても役に立つので、ノンプラグラマーの人もざくっと覚えておくと便利かもよ!

WordPressのコーディングスタンダード

WordPressのコーディングスタンダードは以下のページにまとめられています。

Codexは、WordPressを使った開発に関するガイドラインがほかにもいろいろまとめられているので、ざざっとでいいから目を通した方がいいよ!

全部を紹介するのはめんどくさいので、ここでは、一部のルールだけ紹介しますね。

それぞれ賛否が分かれるところでしょうが、まー、こう決まってると言うことでさらっと流しましょう。笑

どうしても納得がいかない方はTracに殴り込みをかけるのもよいかもしれません。

インデント

ソースコードのインデントは、スペースを使わずに本物のタブを使いましょう!

また、以下のように=の場所をそろえたい場合は、タブの後にスペースを挿入してそろえましょう。

	$foo   = 'somevalue';
	$foo2  = 'somevalue2';
	$foo34 = 'somevalue3';
	$foo5  = 'somevalue4';

スペースの使い方

WordPress界では、以下のように、スペースをいれることが望まれています。

コンマの後ろや、論理演算子、代入演算子の両側には、常にスペースを入れてください。例えば、”x == 23“, “foo && bar“, “array( 1, 2, 3 )” のようにです。同様に、ifelseifforeachfor andswitch ブロックの開きかっこ、閉じかっこの両側にも入れてください (例: foreach ( $foo as $bar ) { ...)。

add_filter( 'the_content', 'my_content_filter' );

PHPショートタグは禁止

より多くの環境でそのまんま動作することを目的とするため以下のようなPHPショートタグを使用することは禁止されています。

× <? echo $foo; ?>
× <?=$foo?>
○ <?php echo $foo; ?>

関数名

関数名はアルファベット小文字を使い、単語の区切りはアンダースコアを使用しましょう。
CamelCaseは禁止です。

function my_filter_cunction() {
    // do something
}

関数の引数

関数の引数には、意味の分かる値を使用しましょう。

悪い例

//BAD
function eat( $what, $slowly = true ) {
    ...
}
eat( 'mushrooms' );
eat( 'mushrooms', true ); // trueだとどう動くんだ!?
eat( 'dogfood', false ); // falseだとどうなん? trueとなにがかわるんだ!?

よい例

//GOOD
function eat( $what, $speed = 'slowly' ) {
    ...
}
eat( 'mushrooms' );
eat( 'mushrooms', 'slowly' );
eat( 'dogfood', 'fast' );

そんなわけで、コーディングスタンダードを守ると、あなたもほんとのWordPress通になれます!

書いてるうちに飽きちゃったので、詳しく知りたい人はCodexをちゃんと読みましょう!