コンテンツへスキップ

Composer

BlockstudioはPackagistで入手できます。プロジェクトの構成に応じて、Composerでいくつかの方法でインストールできます。

プラグインとして

composer/installersを使ってBlockstudioをwp-content/plugins/ディレクトリに直接インストールします。BedrockのようなComposer管理のWordPressプロジェクトで標準的な方法です。

JSON
{
  "require": {
    "composer/installers": "^2.0",
    "blockstudio/blockstudio": "^7.0"
  },
  "extra": {
    "installer-paths": {
      "wp-content/plugins/{$name}/": ["type:wordpress-plugin"]
    }
  }
}

BlockstudioをWordPress管理画面またはWP-CLIから有効化します:

シェル
wp plugin activate blockstudio

ComposerがWordPressを登録できるよう、プロジェクトのComposerオートローダーをBlockstudioアプリで読み込む必要があります。Bedrockでは自動的に処理されます。それ以外の環境では、必須プラグインを使用してください:

PHP
<?php
require_once dirname( __DIR__, 2 ) . '/vendor/autoload.php';

BlockstudioがWordPressによるプラグインの読み込み開始前にComposerのオートローダー経由で読み込まれると、Composerのブートストラップはプラグインを読み込める環境が整うまで初期化を延期します。これにより、BedrockなどのサイトレベルのComposer環境では、WordPressのプラグインAPIが使えるようになる前にBlockstudioを起動せずに、パッケージを早期に読み込めます。

必須プラグインとして

Blockstudioをmu-plugins/にインストールすると、有効化せずに自動読み込みできます。インストーラーのパスを変更し、mu-pluginsディレクトリを指定します:

JSON
{
  "require": {
    "composer/installers": "^2.0",
    "blockstudio/blockstudio": "^7.0"
  },
  "extra": {
    "installer-paths": {
      "wp-content/mu-plugins/{$name}/": ["type:wordpress-plugin"]
    }
  }
}

WordPressはmu-plugins/直下のPHPファイルだけを自動読み込みし、サブディレクトリ内のファイルは読み込みません。ローダーファイルを追加してください:

PHP
<?php
require_once WPMU_PLUGIN_DIR . '/blockstudio/blockstudio.php';

有効化は不要です。Blockstudioは各リクエストで自動的に読み込まれます。

テーマに同梱する

Blockstudioをテーマ内の依存パッケージとしてインストールします。別のプラグインを必要とせず、すべてをテーマ内にまとめられます。

JSON
{
  "require": {
    "blockstudio/blockstudio": "^7.0"
  }
}

テーマのfunctions.phpで読み込みます:

PHP
<?php
require_once __DIR__ . '/vendor/autoload.php';

BlockstudioはWordPressによって読み込まれると、Composerのオートローダーを通じて自動的に起動します。アセットのURLは正しいテーマディレクトリを参照します。テーマのblockstudio/フォルダーに定義されたブロックは、プラグインとしてインストールした場合と同じように動作します。公開テーマディレクトリがシンボリックリンクの場合も機能します。Blockstudioはサーバーのパスを公開せず、アクティブテーマまたは親テーマのURLを通じてパッケージの物理パスを解決します。

プラグインに同梱する

Blockstudioを別のプラグイン内の依存パッケージとしてインストールします。同じオートロードブートストラップが適用されます。

JSON
{
  "require": {
    "blockstudio/blockstudio": "^7.0"
  }
}

プラグインのメインファイルで読み込みます:

PHP
<?php
/*
Plugin Name: My Plugin
*/
require_once __DIR__ . '/vendor/autoload.php';

アセットのURLは正しいプラグインのvendorディレクトリを参照します。

サポートされる読み込みモードの確認

Blockstudioは、サポートされる4つの実行時配置で同じパッケージを継続的に検証します:

モード Bootstrap
WordPressプラグイン WordPressがblockstudio.phpを有効化
Must-useプラグイン ルートローダーがパッケージのエントリーポイントを読み込みます
テーマ内のComposer依存関係 テーマがComposerのオートローダーを読み込みます
プラグイン内のComposer依存関係 ホストプラグインがComposerのオートローダーを読み込みます

どのモードでもWordPressは同じ状態で起動します。BLOCKSTUDIO_VERSIONが定義されたBlockstudioのインスタンスが1つだけ存在し、その下に別のホスト抽象化レイヤーはありません。

カスタムパッケージURL

通常のプラグイン、必須プラグイン、同梱プラグイン、アクティブテーマ、親テーマ、シンボリックリンクされたテーマへのインストールでは、パスが自動的に解決されます。パッケージを別の公開URL経由で公開するカスタム環境では、ComposerがBlockstudioを読み込む前にBLOCKSTUDIO_URLを定義してください。末尾のスラッシュも含めます:

PHP
<?php
define(
    'BLOCKSTUDIO_URL',
    get_stylesheet_directory_uri() . '/packages/blockstudio/'
);

require_once __DIR__ . '/vendor/autoload.php';

代わりに、Composerのオートローダーを読み込む前にblockstudio/urlを登録する方法もあります:

PHP
<?php
add_filter(
    'blockstudio/url',
    function (string $url, string $directory): string {
        return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
    },
    10,
    2
);

require_once __DIR__ . '/vendor/autoload.php';

フィルターには、解決済みのURLとパッケージの物理ディレクトリが渡されます。

依存関係

Blockstudioの実行時依存関係(TailwindPHP、ScssPhp、Minify)はプラグイン内に同梱され、名前空間が設定されています。vendor/ディレクトリにインストールされる唯一のComposer依存関係はyahnis-elsts/plugin-update-checkerです。バージョン間の競合は内部で解決されます。

コード
composer.json requires:
  php >= 8.2
  yahnis-elsts/plugin-update-checker ^5.6

更新

Composerでインストールした場合、更新もComposer経由で行われます。Blockstudioがvendor/ディレクトリから読み込まれると、組み込みのGitHubアップデーターは自動的に無効になります。