クエリー API
WordPress Playground は、ブラウザで Playground を構成するために使用できるシンプルな API を公開しています。
これは、設定オプションをクエリパラメータとして Playground URL に渡すことで機能します。例えば、pendant テーマをインストールするには、次の URL を使用します。
https://playground.wordpress.net/?theme=pendant
ぜひお試しください。Playground が自動的にテーマをインストールし、管理者としてログインします。<iframe>タグを使って、この URL をウェブサイトに埋め込むこともできます。
<iframe src="https://playground.wordpress.net/?theme=pendant"></iframe>
利用可能なオプション
| オプション | デフォルト値 | 説明 |
|---|---|---|
php | 8.0 | 指定された PHP バージョンをロードします。 7.0, 7.1, 7.2, 7.3, 7.4, 8.0, 8.1, 8.2, 8.3, 8.4 or latest. |
wp | latest | 指定された WordPress バージョンを読み込みます。直近 3 つのメジャー WordPress バージョンに対応しています。2024 年 6 月 1 日時点では、6.3、6.4、6.5が該当します。また、汎用的な値としてlatest、nightly、betaも使用できます。 |
blueprint-url | この Playground インスタンスを構成するために使用されるブループリントの URL。 | |
networking | yes | Playground のネットワークサポートを有効または無効にします。yes または no を指定します。 |
plugin | 指定されたプラグインをインストールします。プラグイン名は WordPress プラグインディレクトリの URL から取得してください。例えば、URL が「https://wordpress.org/plugins/wp-lazy-loading/」の場合、プラグイン名は「wp-lazy-loading」になります。「plugin=coblocks&plugin=wp-lazy-loading&…」と指定することで、複数のプラグインを事前にインストールできます。プラグインをインストールすると、ユーザーは自動的に管理者としてログインします。URL の「plugin」属性を繰り返すだけで、複数のプラグインをインストールできます。 | |
theme | 指定されたテーマをインストールします。テーマ名は WordPress テーマディレクトリの URL から取得してください。例えば、URL が「https://wordpress.org/themes/disco/」の場合、テーマ名は「disco」になります。テーマをインストールすると、ユーザーは自動的に管理者としてログインします。URLに「theme」属性を繰り返すだけで、複数のテーマをインストールできます。 | |
url | /wp-admin/ | この Playground インスタンスに指定された初期 WordPress ページを読み込みます。 |
mode | browser-full-screen | WordPress インスタンスの表示方法を指定します。ブラウザ UI にラップするか、シームレスにフルスクリーンで表示するかを選択します。browser-full-screen または seamless を指定できます。 |
lazy | Playground アセットの読み込みを、「実行」ボタンがクリックされるまで延期します。値は指定できません。URL パラメータに「lazy」を追加した場合、読み込みは延期されます。 | |
login | yes | ユーザーを管理者としてログインします。「はい」または「いいえ」で受け付けます。 |
multisite | no | WordPress マルチサイトモードを有効にします。yes または no を指定します。 |
import-site | URL で指定された ZIP ファイルからサイト ファイルとデータベースをインポートします。 | |
import-wxr | URL で指定された WXR ファイルからサイトコンテンツをインポートします。WordPress Importer プラグインを使用するため、デフォルトの管理者ユーザーでログインする必要があります。 | |
site-slug | ブラウザのストレージから読み込むサイトを選択します。 | |
language | en_US | WordPress インスタンスのロケールを設定します。これは networking=yes と組み合わせて使用 する必要があります。そうしないと、WordPress は翻訳をダウンロードできません。 |
core-pr | https://github.com/WordPress/wordpress-develop の特定のコア PR をインストールします。PR 番号を指定します。例: core-pr=6883。 | |
gutenberg-pr | https://github.com/WordPress/gutenberg の特定の PR をインストールします。PR 番号を指定します。例：gutenberg-pr=65337。 | |
if-stored-site-missing | site-slugパラメータが存在しないサイトを指定した場合の処理 方法を示します。if-stored-site-missing=promptを使用すると、指定されたサイト名で新しいサイトを保存するかどうかをユーザーに確認することができます。site-slug. |
たとえば、次のコードは、プリインストールされた Gutenberg プラグインを含む Playground を埋め込み、投稿エディターを開きます。
<iframe src="https://playground.wordpress.net/?plugin=gutenberg&url=/wp-admin/post-new.php&mode=seamless"> </iframe>
CORS ポリシー
サイトの ZIP パッケージなどの URL からファイルをインポートするには、Access-Control-Allow-Origin ヘッダーを設定した状態で提供する必要があります。参考資料として、クロスオリジンリソース共有（CORS）をご覧ください。
GitHub エクスポート オプション
次の追加のクエリ パラメータを使用して、GitHub エクスポート フォームを事前構成できます。
gh-ensure-auth:yesに設定すると、Playground は続行する前にユーザーが GitHub で認証されていることを確認するためのモーダルを表示します。ghexport-repo-url: エクスポート先の GitHub リポジトリの URL。ghexport-pr-action: エクスポート時に実行するアクション (作成または更新)。ghexport-playground-root: エクスポート元の Playground のルートディレクトリ。ghexport-repo-root: エクスポート先のリポジトリのルートディレクトリ。ghexport-content-type: エクスポートのコンテンツタイプ (plugin、theme、wp-content、custom-paths)。ghexport-plugin: プラグインのパス。コンテンツタイプがpluginの場合、エクスポートするプラグインを事前に選択します。ghexport-theme: テーマのディレクトリ名。コンテンツタイプが「theme」の場合、エクスポートするテーマを事前に選択します。ghexport-path:ghexport-playground-rootからの相対パス。複数回指定できます。 コンテンツタイプが「custom-paths」の場合、エクスポートするパスのリストが事前に入力されます。ghexport-commit-message: エクスポート時に使用するコミットメッセージ。ghexport-allow-include-zip: GitHub エクスポートに zip ファイルを含めるオプションを提供するかどうか (yes、no)。オプション。デフォルトは「yes」です。