モジュールを作成していて、補助(ヘルパー)関数を作成する必要がありますが、関数に最適な名前がどれかわかりません。
関数に次のような名前を付けますか?
_function _MODULE_my_function
_
または:
_function MODULE_my_function()
_
私は通常_MODULE_my_function()
を使用しますが、これには標準がありますか?
Drupal Coding Standards や モジュール、関数、変数の命名 の記事には、これに関する言及はありません。
関数の命名方法は 命名規則 で説明されています。
関数は小文字を使用して名前を付け、単語はアンダースコアで区切る必要があります。さらに、モジュール間の名前の衝突を回避するために、関数はグループ化/モジュール名を接頭辞として持つ必要があります。
これは、モジュールから実装されたフックおよびその他の関数に有効です。
フックではない関数の場合は、グループ化/モジュール名の直前にアンダースコアを付けることもできます。これを行うと、他のモジュールの開発者に、関数が他のモジュールから呼び出されることは想定されていないが、privateそれを定義するモジュール。
ヘルパー関数の前にアンダースコアを付ける必要があるいくつかの場所でそれを見たと思います。これは、これらと他のコールバック/メイン関数を区別する方法です。さらに、フックの後に誤って名前を付けることを不可能にします。
私はこのシステムを長年使用しており、私の カスタムモジュールボイラープレート にも含まれています。
お役に立てれば。