bitrix-modules について
Bitrix 開発者向けのモジュール開発リファレンススキルです。モジュール構成、インストール時のマイグレーション、オプション画面、自動読み込み、ルートを扱い、登録や再実行可能なインストール、対称的なアンインストールの要件を示します。
主な機能
- 01モジュール構成とインストーラー規則
- 02マイグレーションでのテーブル、イベント、エージェント
- 03オプション画面と PSR-4 自動読み込み
- 04モジュールルーティングの指針
- 05対称的なインストールとアンインストールの制約
活用シーン
- 01新しい Bitrix モジュールの骨組み作成
- 02モジュールのインストールとアンインストール処理
- 03オプション画面と自動読み込みの設定
- 04モジュール登録やルーティングの問題調査
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ bxmaximum/ bitrix-framework-skills --skill bitrix-modulesインストール後、Claude Code で/bitrix-modulesを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
rules/install-migrations.mdinstaller.mdoptions-autoload.md詳細
Bitrix モジュール
ベースライン:main 23.0+ · 検証済み:main 26.800.0
| タスク | 参照先 |
|---|---|
新しいモジュール:ID、スケルトン、install/index.php、バージョン、言語、アンインストール | rules/installer.md |
install/migrations/*.php でのテーブル、イベント、エージェント(main 26.600+) | rules/install-migrations.md |
オプションページ、default_option.php、PSR-4 オートロード、モジュールのルート | rules/options-autoload.md |
不変条件
- モジュールのディレクトリは
/local/modules/<vendor>.<module>/、ID は小文字のvendor.module、インストーラークラスはvendor_module、名前空間はVendor\Moduleです(ID が1語のmymoduleの場合はBitrix\Mymodule)。 - モジュールが
b_moduleに登録されるまでは、何も動作しません。Loader::includeModule()はfalseを返し、モジュールの.settings.php(services、controllers、console、messenger)も読み込まれません。 - インストールとアンインストールは対称にします。作成するテーブル、ハンドラー、エージェント、オプションにはすべて削除処理を用意し、インストールを再実行しても失敗しないようにします。
- イベントの登録には、カーネルのパラメーター名(
fromModuleId:)または位置引数を使用します。ハンドラーのシグネチャーはディスパッチャーによって異なります —bitrix-events。 - モジュールのルートは
/local/routes/web.phpからrequireされます。モジュールの.settings.phpにあるroutingセクションは無視されます(bitrix-routing)。 - プロジェクトのデータ/コンテンツのマイグレーション(iblock、環境ごとのオプション)はインストーラーではなく、
bitrix-sprint-migrationに属します。
コメント
Markdown 対応