参照リソース

「リソース参照」を使用すると、ブループリントで外部ファイルを使用できるようになります。

情報

installPlugin や installTheme などのブループリントステップでは、インストールするプラグインまたはテーマの場所を指定する必要があります。

その場所は、テーマまたはプラグインを含む .zip ファイルの URL リソースとして定義できます。また、公式 WordPress ディレクトリに公開されているプラグイン/テーマの場合は、wordpress.org/plugins または wordpress.org/themes リソースとして定義することもできます。

次のリソース参照が利用可能です。

URL 参照
コアテーマリファレンス
コアプラグインリファレンス
VFS リファレンス
リテラル参照
バンドルリファレンス

URL 参照

URLReference リソースは、リモートサーバーに保存されているファイルを参照するために使用されます。URLReference リソースは次のように定義されます。

type URLReference = {
	resource: 'url';
	url: string;
};

URLReference リソースを使用するには、ファイルの URL を指定する必要があります。例えば、リモートサーバーに保存されている「index.html」という名前のファイルを参照するには、次のように URLReference を作成します。

{
	"resource": "url",
	"url": "https://example.com/index.html"
}

リソース url タイプは、installPlugin や installTheme などのブループリントステップと組み合わせて使用します。これらのステップでは、インストールするプラグインまたはテーマの場所を定義する ResourceType が必要です。

"resource": "url" を使用すると、GitHub リポジトリを直接ポイントできる URL を介して、プラグイン/テーマを含む .zip の場所を定義できます。

ヒント

Playground プロジェクトはGitHub Proxyを提供しています。これを使用すると、プラグインやテーマを含むリポジトリ（またはリポジトリ内のフォルダ）から .zip ファイルを生成できます。このツールは、CORS の問題などを回避するのに非常に便利です。

コアテーマリファレンス

CoreThemeReference リソースは、WordPress コアテーマを参照するために使用されます。CoreThemeReference リソースは以下のように定義されています。

type CoreThemeReference = {
	resource: 'wordpress.org/themes';
	slug: string;
	version?: string;
};

CoreThemeReference リソースを使用するには、テーマのスラッグを指定する必要があります。例えば、「Twenty Twenty-One」テーマを参照するには、次のように CoreThemeReference を作成します。

{
	"resource": "wordpress.org/themes",
	"slug": "twentytwentyone"
}

コアプラグインリファレンス

CorePluginReference リソースは、WordPress コアプラグインを参照するために使用されます。CorePluginReference リソースは以下のように定義されています。

type CorePluginReference = {
	resource: 'wordpress.org/plugins';
	slug: string;
	version?: string;
};

CorePluginReference リソースを使用するには、プラグインのスラッグを指定する必要があります。例えば、「 Akismet 」プラグインを参照するには、次のように CorePluginReference を作成します。

{
	"resource": "wordpress.org/plugins",
	"slug": "akismet"
}

VFS リファレンス

VFSReference リソースは、仮想ファイルシステム (VFS) に格納されているファイルを参照するために使用されます。VFS はメモリに格納されるファイルシステムであり、オペレーティングシステムのファイルシステムに含まれないファイルを格納できます。VFSReference リソースは次のように定義されています。

type VFSReference = {
	resource: 'vfs';
	path: string;
};

VFSReference リソースを使用するには、VFS 内のファイルへのパスを指定する必要があります。例えば、VFS のルートに保存されている「index.html」という名前のファイルを参照するには、次のように VFSReference を作成します。

{
	"resource": "vfs",
	"path": "/index.html"
}

リテラル参照

LiteralReference リソースは、コード内でリテラルとして保存されているファイルを参照するために使用されます。LiteralReference リソースは次のように定義されます。

type LiteralReference = {
	resource: 'literal';
	name: string;
	contents: string | Uint8Array;
};

LiteralReference リソースを使用するには、ファイル名とその内容を指定する必要があります。例えば、「Hello, World!」というテキストを含む「index.html」という名前のファイルを参照するには、次のように LiteralReference を作成します。

{
	"resource": "literal",
	"name": "index.html",
	"contents": "Hello, World!"
}

バンドルリファレンス

BundledReference リソースは、ブループリント自体にバンドルされているファイルを参照するために使用されます。これは、必要なリソースをすべて含む自己完結型のブループリントバンドルを作成する場合に特に便利です。BundledReference リソースは次のように定義されます。

type BundledReference = {
	resource: 'bundled';
	path: string;
};

BundledReference リソースを使用するには、バンドル内のファイルへの相対パスを指定する必要があります。例えば、ブループリントにバンドルされている「plugin.php」というファイルを参照するには、次のように BundledReference を作成します。

{
	"resource": "bundled",
	"path": "plugin.php"
}

ブループリントバンドルは、次のようなさまざまな形式で配布できます。

トップレベルに blueprint.json ファイルを含む ZIP ファイル
blueprint.json ファイルと関連リソースを含むディレクトリ
ブループリントとそのリソースが一緒にホストされているリモート URL

ブループリントバンドルの詳細については、ブループリントバンドルドキュメントを参照してください。

URL 参照​

コアテーマリファレンス​

コアプラグインリファレンス​

VFS リファレンス​

リテラル参照​

バンドルリファレンス​