【WordPress】WordPressの命名規則について

WordPressのプラグインやテーマ等の開発において命名規則について調べました。

キャメルケースは使わない

変数、アクション、関数の名前にはアルファベット小文字を使います。camelCase は使いません。単語はアンダースコアで区切ります。

https://ja.wordpress.org/team/handbook/coding-standards/wordpress-coding-standards/php/#%e5%91%bd%e5%90%8d%e8%a6%8f%e5%89%87

個人的に衝撃だったんですけど、Wordpressに関する開発にはキャメルケースは使用しないとのこと。

キャメルケース
(camelCase
複数の単語を連結する際に、単語の最初を大文字で書き表すこと命名規則。全ての単語の先頭を大文字にするのがアッパーキャメルケースもしくはパスカルケースで、先頭の単語だけ小文字にするのがローワーキャメルケースと呼ぶ。
スネークケース
(snake_case)
複数の単語を連結する際に、単語をアンダースコアでつなぐ命名規則
ケバブケース
(kebab-case)
複数の単語を連結する際に、単語をハイフンでつなぐ命名規則

WordPressの開発はキャメルケースは使わず、スネークケースを使用して開発する基準のようです。

不必要に変数名を省略しないでください。コードは明確に、理解可能なものにしてください。

https://ja.wordpress.org/team/handbook/coding-standards/wordpress-coding-standards/php/#%e5%91%bd%e5%90%8d%e8%a6%8f%e5%89%87

単語は略語を使用せず、明確に作成するとのこと。

メソッド例

function some_name( $some_variable ) { [...] }

クラス名は先頭を大文字

クラス名は大文字で始まる単語をアンダースコアで区切ります。省略語はすべて大文字にします。

https://ja.wordpress.org/team/handbook/coding-standards/wordpress-coding-standards/php/#%e5%91%bd%e5%90%8d%e8%a6%8f%e5%89%87
class Walker_Category extends Walker { [...] }
class WP_HTTP { [...] }

定数は大文字

define( 'DOING_AJAX', true );

ファイル名はケバブケース

ファイル名はアルファベットの小文字を使用して、内容を説明する名前にしてください。単語はハイフンで区切ります。

my-plugin-name.php

ファイル名に関しては「ケバブケース」を使用します。

クラスファイルは先頭に「 class- 」をつけます 。

クラスファイルの名前はクラス名を基にして、前に「class-」を付け、クラス名内部のアンダースコアはハイフンで置き換えます。 たとえば「WP_Error」の場合

class-wp-error.php

まとめ

WordPressのコード命名規則は下記

・アンダースコアでつなぐスネークケース

・ファイル名は、ハイフンでつなぐケバブケース

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA