カスタム・モジュール開発: モジュール・スケルトンの作成

カスタム・モジュールを作成することで、 開発者ポータル ・サイトを拡張できます。 新規モジュールの開始点として、モジュール・スケルトンを作成します。

1. カスタム・モジュールのショート・ネーム (マシン名とも呼ばれる) を選択します。
   マシン名は、モジュール内の複数のファイルおよび関数で使用されるとともに、Drupal コアがプログラムでモジュールを参照する際にも使用されます。 この名前は、以下のルールに準拠している必要があります。

   • 先頭は文字でなければなりません。
   • 含めることができるのは、小文字と下線のみです。 (この名前で大文字を使用した場合、モジュールのフック実装が Drupal で認識されなくなるので注意してください)。
   • スペースが含まれていてはなりません。
   • これは、 開発者ポータル ・サイト内で固有でなければなりません。
   • これは、 src、 lib、 vendor、 assets、 css、 files、 images、 js、 misc、 templates、 includes、 fixtures、 Drupalの予約語であってはなりません。
2. 任意の場所 ( /modules/module_nameなど) にモジュール・フォルダーを作成します。
   フォルダーにモジュールのマシン名と同じ名前を付ける必要はありませんが、モジュールのコードやファイル名の中では、マシン名をプログラムで使用する必要があることに留意してください。
3. モジュール・フォルダーに module_name.info.yml ファイルを作成します。
   ここで、 module_name は、ステップ 1で選択したショート・ネームまたはマシン名です。
4. 以下のように、カスタム・モジュールのメタデータを module_name.info.yml ファイルに挿入します。

   name: Example module name
   description: Description of the module.
   package: Custom
   
   type: module
   core: 8.x
   core_version_requirement: '^8 || ^9'
   version: 1.0
   
   dependencies:
     - module_name
   
   test_dependencies:
     - module_name
   
   configure: example.settings
   
   php: 7.1
   
   hidden: true

   ここで

   • name (必須) は、モジュールの名前であり、 「開発者ポータル」 UI のモジュール管理ページに表示されるテキストです。
   • description (オプション) は、モジュールの説明であり、 「開発者ポータル」 UI のモジュール管理ページに表示されるテキストです。
   • package (オプション) は、類似のモジュールを一緒にグループ化できるようにするキーです。
   • type (必須) は、作成する拡張のタイプです。例えば、モジュール、テーマ、またはプロファイルなどです。 この例では、モジュールを作成します。
   • core (オプション) モジュールと互換性のある Drupal コア・バージョンを指定します。
   • core_version_requirement (必須) は、モジュールがどのバージョンの Drupal と互換性があるかを指定します。 この例では、モジュールが Drupal 8 および 9 のすべてのバージョンと互換性があることを指定しています。
   • version (必須) は、モジュールのバージョン番号です。 なお、Drupal.org でモジュールを公開する場合は、version は必要ありません。
   • dependencies (オプション) は、モジュールが依存しているすべてのモジュールの YAML リストです。 module_name の形式の名前空間を使用する必要があります。ここで、module_name はモジュールのマシン名です。
   • test_dependencies (オプション) は、Drupal の自動化テスト実行プログラム (DrupalCI) でモジュールに対して特定の自動化テストを実行するために必要であるが、一般的なモジュール依存関係としては必要ではない (dependencies と同じ形式の) すべてのモジュールのリストです。
   • configure (オプション)。モジュールが構成フォームを提供する場合、ここでそのフォームへの経路を指定します。
   • php (オプション) は、モジュールに必要とされる PHP の最低バージョンです。 開発者ポータル の場合、PHP の最小バージョンは 7.1です。
   • hidden (オプション) は、設定されている場合、 開発者ポータル UI の管理者ダッシュボードの 「拡張」 セクションでモジュールを非表示にするオプションです。 このオプションは、モジュールに含まれているのがテストのみである場合やモジュールが他の開発者に対するサンプル用である場合に役立つことがあります。
5. module_name.info.ymlを保存します。

name: User field example
type: module
description: Developer Portal tutorial about a user field example
package: IBM API Connect Tutorials
core: 8.x
core_version_requirement: '^8 || ^9'
version: 8.x-0.0.1
dependencies:
  - ibm_apim
  - auth_apic