カスタム WordPress Blueprints の作成方法

このテキストは AI を使用して翻訳されました。英語の原文を表示するには、こちらをクリックしてください。

WordPress Studio は WordPress Playground を基盤としており、Blueprints をサポートしています。Studio の Blueprints を使うと、次のことができます：

• 繰り返しのセットアップを効率化： 一般的なサイトタイプ（ブログ、ポートフォリオ、ストアなど）用の Blueprints を作成し、新しい Studio プロジェクトをより効率的に開始できます。 
• チームの足並みを揃える： プラグイン、テーマ、またはフルサイトを構築する場合でも、プロジェクトの GitHub リポジトリに blueprint.json ファイルを追加できます。毎回同じ環境がスキャフォールドされるため、チームメンバーは数分でプラグイン、テーマ、またはフルサイトの構築を開始でき、バージョン管理により変更のレビューと一貫性が保たれます。
• デモとテストを簡素化： 必要なテーマ、プラグイン、サンプルコンテンツを正確に指定して Studio を起動できます。信頼性の高い再現可能なセットアップで、バグの再現や修正の確認が行えます。

このガイドでは、カスタム Blueprint の作成の基本を学び、さらに詳しく学べる追加リソースを紹介します。

Blueprints とは？

Blueprint は、WordPress サイトのセットアップを定義する JSON ファイルです。Blueprint 内では、希望する WordPress や PHP のバージョンなどの設定を構成できます。また、サイト作成時に実行するステップのリストを指定することもできます。たとえば、プラグインやテーマのインストールと有効化、サイトオプションの設定、デモコンテンツのインポート、PHP や SQL クエリの実行などが可能です。

Blueprints は公開 JSON スキーマを使用して記述され、Playground、WordPress Studio、およびその他のツール間で標準化されています。

この最小限の例では、希望する WordPress と PHP のバージョンを設定し、WooCommerce プラグインと Pendant テーマをインストールして有効化し、管理画面の配色を「Modern」に設定しています。

{
  "$schema": "https://playground.wordpress.net/blueprint-schema.json",
  "landingPage": "/wp-admin/",
  "login": true,
  "preferredVersions": {
    "php": "8.3",
    "wp": "latest"
  },
  "steps": [
    {
      "step": "installPlugin",
      "pluginData": {
        "resource": "wordpress.org/plugins",
        "slug": "woocommerce"
      },
      "options": {
        "activate": true
      }
    },
    {
      "step": "installTheme",
      "themeData": {
        "resource": "wordpress.org/themes",
        "slug": "pendant"
      },
      "options": {
        "activate": true
      }
    },
    {
      "step": "updateUserMeta",
      "meta": {
        "admin_color": "modern"
      },
      "userId": 1
    }
  ]
}

知っておくべき重要なポイント：

• preferredVersions では、PHP と WordPress のバージョンを事前に定義できます。
• steps が実際の処理を行う部分です。ログイン、プラグインやテーマのインストール・有効化、WXR コンテンツのインポート、オプションの設定、PHP の実行などが可能です。たとえば、上記の例では WooCommerce のインストール、サイトの言語をスペイン語に設定、管理画面の配色の変更を行っています。利用可能なアクションと例については、ステップライブラリをご覧ください。

WordPress Playground にはインタラクティブな Blueprint ビルダーがあり、さまざまな Blueprint の設定をテストできます。Studio で実行する前にカスタム Blueprint を���証するのに最適な方法です。

上のボタンを使って、この Blueprint をプレビューおよびダウンロードできます。ダウンロード後、Studio で新しいサイトを作成する際に使用できます。詳しい手順については、Studio でのサイト作成フローをご参照ください。

Studio における Blueprint の制限事項

以下の表は、バージョン 1.6.0 時点で、Blueprint が playground.wordpress.net と比較して Studio でどのように異なる動作をするかを示しています。

その他のリソース

Blueprint は上記の例のようにシンプルなものから、ワークフローに応じた高度なものまで作成できます。Playground のドキュメントでは、Blueprint の JSON フォーマットの概要、クイックスタートチュートリアル、詳細なリファレンスが提供されています。独自の Blueprint を作成したい場合や、WordPress コミュニティの例を参考にしたい場合は、以下のリソースをご覧ください。

• Blueprints の概要���クイックスタートチュートリアル
• データ形式とスキーマ
• ステップリファレンスとビジュアルステップライブラリ
• Blueprints の例とコミュニティギャラリー

Studio アシスタントのような AI ツールを活用すると、カスタム Blueprints の作成に役立ちます。Blueprint を書いてほしいと依頼するだけで簡単に作成できます：

Blueprints を作成するためのユーザーインターフェースを提供するコミュニティプロジェクトもいくつかあり、チェックする価値があります：

• WordPress Playground Step Library
• Pootle Playground
• Block Based Visual Blueprint Builder