開発者

Page Builder Sandwich アビリティリファレンス

Page Builder Sandwich はそのアクションを WordPress Abilities API に登録します。これらと同じアビリティは、サイト自身のサーバー上の MCP ツールとして、また /wp-json/wp-abilities/v1 配下の REST ルートとしても機能します。このページはプラグイン自体のレジストリから生成されています。

ユーザーガイド: AI アプリを接続する

エンドポイント

アビリティREST
MCP over HTTP (ストリーミング対応)/wp-json/pbs/v1/mcp
MCP over WP-CLI (標準入出力)wp mcp-adapter serve --server=page-builder-sandwich --user=<login>
REST: アビリティの一覧表示/wp-json/wp-abilities/v1/abilities?category=page-builder-sandwich
REST: アビリティの実行/wp-json/wp-abilities/v1/abilities/<name>/run (GET with ?input= for read-only abilities, POST {"input": {...}} otherwise)

認証と権限

HTTP リクエストは WordPress アプリケーションパスワード (HTTP Basic) で認証します。MCP サーバーへの接続には、以下に示す権限が必要です。その後、各アビリティがオブジェクトごとに独自の権限をチェックします。読み取り専用のアビリティは GET とクエリ文字列の入力で実行され、それ以外は POST と JSON 本文 ‘{“input”: {…}}’ で実行されます。

WordPress アプリケーションパスワード(HTTP)または --user(WP-CLI)。ユーザーには各アビリティが指定する権限が必要です · 設定: AI エージェント (MCP) を許可、デフォルトでオン

すべてのアビリティ

アビリティエディションREST権限パラメーター
pbs/activate-custom-font
アップロードされたカスタムフォント (メディアライブラリ内のフォントファイル、ID 指定) をフォントピッカーで利用可能にします。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/activate-custom-font/runedit_theme_options (REST ルート独自のチェック)id 整数 (必須)
pbs/add-local-font
Google フォントファミリー (ファミリー、ウェイト、斜体) をダウンロードし、このサイトから配信します。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/add-local-font/runmanage_options (REST ルート独自のチェック)family 文字列 (必須)
weights 配列
italic 真偽値
pbs/add-section
作成済みのセクションを固定ページに追加します (先頭、末尾、または指定位置のセクションの後ろ)。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/add-section/runそのページの edit_postid 整数 (必須)
section 文字列 (必須)
position 文字列: start、end、after
after 整数
pbs/add-shop-block
投稿の末尾に WooCommerce ブロックを追加します: 商品要素 (part: title、gallery、image、price、rating、excerpt、description、add_to_cart、meta、tabs、related、upsells、sale_badge、stock。productId、または表示中商品の場合は 0)、またはミニカート (label)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/add-shop-block/runedit_post (REST ルート独自のチェック)post 整数 (必須)
block 文字列 (必須): product-element、mini-cart
part 文字列: title、gallery、image、price、rating、excerpt、add_to_cart、meta、tabs、related、upsells、sale_badge、stock、description
productId 整数
label 文字列
pbs/ai-check-accessibility
ページのアクセシビリティの問題を一覧表示します: alt テキストのない画像、レベルを飛ばした見出し、それ単体では意味が通じないリンクテキスト、テキストのないリンク。それぞれ自動修正が可能かどうかも示します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/ai-check-accessibility/runページの edit_postpost_id 整数 (必須)
pbs/ai-create-block
説明 (料金カード、チームカード、バナーなど) から再利用可能なコンポーネントを設計し、エディターの「マイパターン」内に同期パターンとして保存します (配置ごとに各テキストの上書きが可能)。その ID と配置用ブロックを返します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-create-block/runedit_posts および publish_posts、AI 設定のロールおよび利用枠ルールdescription 文字列 (必須)
title 文字列
pbs/ai-css-help
1つの要素のカスタム CSS を説明、生成、または修正します (`selector` は要素を表します)。CSS と説明を返します。保存は行われません。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/ai-css-help/runedit_posts およびビルダーのコード編集権限action 文字列 (必須): explain、write、fix
css 文字列
instruction 文字列
block 文字列
pbs/ai-design-from
スクリーンショット (メディアライブラリ内の画像) または公開ウェブページ (URL) のレイアウトを、新しい下書きページ内の編集可能なブロックとして再現します (同一のセクション、カラム、見出し、テキスト、リスト、ボタン)。ロゴや画像はコピーされません。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-design-from/runedit_pages (スクリーンショットに対する edit_post)、AI 設定のロールおよび利用枠ルールattachment_id 整数
url 文字列
title 文字列
instruction 文字列
pbs/ai-edit-page
平易な言葉による指示どおりにページを変更します (「ヒーローテキストを短くする」「料金の後ろに配送に関する FAQ を追加する」「ページをドイツ語に翻訳する」など)。AI が編集操作を提案し、適用前にページのブロックと設定に対して検証します。拒否された操作は理由とともに一覧表示されます。変更前にリビジョンが保存され、その ID が undo_revision として返されます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-edit-page/runページの edit_post、AI 設定のロールおよび利用枠ルールpost_id 整数 (必須)
instruction 文字列 (必須)
pbs/ai-fix-accessibility
修正可能なアクセシビリティの問題を修正します (すべて、または指定された問題 ID): 各画像を確認して alt テキストを生成、見出しレベルを修正、曖昧なリンクテキストを書き直します。変更前にリビジョンが保存され、その ID が undo_revision として返されます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-fix-accessibility/runページの edit_post、AI 設定のロールおよび利用枠ルールpost_id 整数 (必須)
issues 配列
pbs/ai-generate-image
サイトの画像モデル (OpenAI または Google) を使用して説明から画像を生成し、代替テキスト付きでメディアライブラリに保存します。ID とアドレスを返します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-generate-image/runupload_files、AI 設定のロールおよび利用上限ルールprompt 文字列 (必須)
size 文字列: square、landscape、portrait
alt 文字列
title 文字列
post_id 整数
pbs/ai-generate-section
1文の説明文から、テキストを含めてデザイン済みのセクション (サイトのブランドスタイルに合わせた編集可能な本物のブロック) に変換します。ブロックのマークアップを返し、post_id が指定されている場合はページの先頭または末尾に追加します (リビジョンにより以前の内容が保持されます)。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/ai-generate-section/runedit_posts、ページに追加するための edit_post、AI 設定のロールおよび利用上限ルールdescription 文字列 (必須)
section 文字列
post_id 整数
position 文字列: start、end
pbs/ai-plan-site
ビジネスの説明から、Web サイトに必要なページを一覧表示します (トップページが先頭、お問い合わせが最後)。各ページにはタイトルと概要が含まれます。何も作成されません。その後、概要をもとに各ページを構築できます。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/ai-plan-site/runedit_pages、AI 設定のロールおよび利用上限ルールbrief 文字列 (必須)
pbs/ai-save-seo-meta
サイトで使用している SEO プラグイン (Yoast SEO、Rank Math、SEOPress、または All in One SEO) にメタタイトルとメタディスクリプションを保存し、どれが書き込まれたかを表示します。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/ai-save-seo-meta/run該当ページの edit_postpost_id 整数 (必須)
title 文字列 (必須)
description 文字列 (必須)
pbs/ai-suggest-seo-meta
ページを読み取り、メタタイトル (最大60文字) とメタディスクリプション (最大155文字) を提案します。フォーカスキーワードの指定も可能です。何も保存されません。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/ai-suggest-seo-meta/run該当ページの edit_post、AI 設定のロールおよび利用上限ルールpost_id 整数 (必須)
keyword 文字列
pbs/ai-undo
AI による変更で返された undo_revision を使用して、ページを変更前の状態に戻します。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/ai-undo/run該当ページの edit_postpost_id 整数 (必須)
revision 整数 (必須)
pbs/ai-write-alt-text
画像を確認し、代替テキストを保存します。単一の画像 (attachment_id)、またはページ内の未設定の全画像 (post_id) を対象にします。1回の呼び出しにつき最大20画像です。レスポンスに残数が表示されます。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/ai-write-alt-text/run画像またはページの upload_files および edit_post、AI 設定のロールおよび利用上限ルールattachment_id 整数
post_id 整数
only_missing 真偽値
language 文字列
pbs/ai-write-text
サイト自身の AI プロバイダーを使用して、新しいテキストの作成、改善、要約、拡張、トーンの変更、文法の修正を行います。新しいテキストを返します。サイト上の内容は変更されません。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/ai-write-text/runedit_posts (post_id 指定時は edit_post)、AI 設定のロールおよび利用上限ルールaction 文字列 (必須): write、improve、shorten、expand、tone、fix、custom
text 文字列
tone 文字列: professional、friendly、confident、playful、formal、simple
instruction 文字列
context 文字列
pbs/apply-brand-kit
保存されたブランドキットの色とフォントをサイトデザインに適用します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/apply-brand-kit/runedit_theme_options (REST ルート独自のチェック)なし
pbs/apply-kit
Web サイトキットのページ (すべて、または指定したもの) をインポートし、任意で公開、ホームページへの設定、メニューへの追加を行います。再度インポートすると同じページが更新されます。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/apply-kit/runedit_pages および publish_pages、ホームページ設定のための manage_options、メニュー作成のための edit_theme_optionsslug 文字列 (必須)
pages 配列
publish 真偽値
front 真偽値
menu 真偽値
pbs/apply-replace
プレビューしたジョブを適用します。変更されたすべての投稿にはバックアップが保持されるため、ジョブを取り消すことができます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/apply-replace/runmanage_options (REST ルート独自のチェック)id 文字列 (必須)
pbs/build-landing-page
ガイド付きワークフロー: エージェントがビジネスに合ったセクションを選択し、ページを下書きとして構築し、テキストを作成します。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/build-landing-page/runedit_pagesbusiness 文字列 (必須)
pbs/build-pages
1回の呼び出しで最大50ページをセクションやブロックコンテンツから作成します。各ページは個別に検証・作成され、レスポンスには作成された全ページと拒絶されたページ (理由付き) が一覧表示されます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/build-pages/runedit_pages (各ページ個別に検証、公開には publish_pages)pages 配列 (必須)
pbs/check-performance
ページコンテンツが容量に与える影響をレポートします。画像 (バイト数、サイズ超過のものと適切な縮小サイズ)、使用しているブロックのスタイルシート、外部埋め込みについて、それぞれの問題点と修正方法を提示します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/check-performance/run対象ページの edit_postpost_id 整数 (必須)
pbs/connect-adobe-fonts
Kit ID を使って Adobe Fonts (Typekit) Web プロジェクトを連携し、フォント選択ツールにフォントを表示します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/connect-adobe-fonts/runedit_theme_options (REST ルート固有のチェック)kit 文字列 (必須)
pbs/connect-marketing-service
API キーを使ってメーリングリストサービスを連携 (service、key、サービスに応じて account)、または空のキーを指定して連携を解除します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/connect-marketing-service/runmanage_options (REST ルート固有のチェック)service 文字列 (必須)
key 文字列
account 文字列
pbs/connect-support
このサイトを Zinn Digital® サポートに連携します (name、email、consent)。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/connect-support/runmanage_options (REST ルート固有のチェック)email 文字列 (必須)
name 文字列
consent 真偽値 (必須)
pbs/convert-builder-export
エクスポートデータ (builder: elementor、divi、beaver、wpbakery、content: エクスポートされたテキスト) をブロックで構成された新規下書きページに変換します。オプションで画像をメディアライブラリにコピーできます (media)。下書きと変換レポートを返します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/convert-builder-export/runedit_pages (REST ルート固有のチェック)builder 文字列 (必須): elementor, divi, beaver, wpbakery
content 文字列 (必須)
title 文字列
media 真偽値
dryRun 真偽値
status 文字列: draft, pending, private, publish
pbs/convert-builder-page
Elementor、Divi、Beaver Builder、WPBakery で作成された1つのページ (id) を、レイアウト、タイポグラフィ、色、画像を維持したままブロック構成の新規下書きに変換します。元のページは変更されません。下書きと、変換された項目・近似変換された項目・変換されなかった項目のレポートを返します。dryRun は保存せずに変換のみを行います。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/convert-builder-page/runedit_pages および edit_post (REST ルート固有のチェック)id 整数 (必須)
dryRun 真偽値
status 文字列: draft, pending, private, publish
pbs/convert-post
5.x のページ1つをブロックに変換します (事前にバックアップされます)。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/convert-post/runREST ルート固有の項目別権限チェックid 文字列 (必須)
pbs/create-ab-test
セクションの2つのバージョンのテストを投稿の末尾に追加します (post、name、a、b、split および goal は任意)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-ab-test/runedit_post (REST ルート固有のチェック)post 整数 (必須)
name 文字列
a 文字列 (必須)
b 文字列 (必須)
split 整数
goal 文字列
pbs/create-class
再利用可能なグローバルスタイルクラスを作成します: label、slug、およびそのスタイル (s)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-class/runedit_theme_options (REST ルート固有のチェック)label 文字列 (必須)
slug 文字列
s オブジェクト
cat 文字列
pbs/create-cookie-banner
ベースとして使用できる、あらかじめ用意された同意バナーのデザインを作成します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-cookie-banner/runmanage_options (REST ルート固有のチェック)なし
pbs/create-form
新規ページまたは既存の投稿 (post) の末尾にフォームを作成します (お問い合わせ、見積もり、登録、マルチステップなど: fields、steps、設定、および email、save、webhook、メーリングリストなどの actions)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-form/runedit_pages (REST ルート固有のチェック)title 文字列
fields 配列 (必須)
steps 配列
actions オブジェクト
submitText 文字列
successMessage 文字列
redirectUrl 文字列
trackEvent 文字列
post 整数
pageTitle 文字列
status 文字列: draft, publish, private
pbs/create-page
ライブラリのセクションやブロックコンテンツから固定ページを作成します。別のステータスを指定しない限り、新規ページは下書きになります。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/create-page/runedit_pages。公開または非公開にするには publish_pagestitle 文字列 (必須)
status 文字列: draft、pending、publish、private
sections 配列
content 文字列
pbs/create-popup
ポップアップ、スライドイン、またはバーを作成します (コンテンツ、トリガー (離脱意図、スクロール、時間、クリック)、表示頻度、表示対象ページ)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-popup/runedit_pages (REST ルート独自のチェック)title 文字列 (必須)
content 文字列 (必須)
status 文字列: draft、publish
settings オブジェクト
pbs/create-query-loop
新規ページ (pageTitle、status) または投稿の末尾 (post) に、作成済みのカード付きクエリーループを追加します: 取得元 (posts|users|terms|field)、postType (ショップグリッド用の product など)、perPage、columns、orderBy、order、ページネーション、ライブフィルター [{type: search|taxonomy|meta|sort|price|onsale|instock, taxonomy, key, label, ui}]。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-query-loop/runedit_post および edit_posts (REST ルート独自のチェック)post 整数
pageTitle 文字列
status 文字列: draft、publish、private
source 文字列: posts、users、terms、field
postType 文字列
perPage 整数
columns 整数
orderBy 文字列
order 文字列: ASC、DESC
pagination 文字列: none、numbers、prevnext
taxonomy 文字列
fieldKey 文字列
filters 配列
pbs/create-team
招待コードを使って他のサイトも参加できるチームライブラリ (name) を作成します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-team/runmanage_options (REST ルート独自のチェック)name 文字列 (必須)
pbs/create-theme-template
クラシックテーマおよびブロックテーマで、一致するすべての該当部分を置き換えるテンプレート (title、type) を作成します。content がない場合は、そのタイプ用の作成済みデザインから開始します。include/exclude は表示条件ルール ({kind, values, key, value, from, to, days}、このサイトのテーマビルダーが提供する種別) です。競合時は priority で優先度を決定します。status は publish (公開) または draft。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-theme-template/runREST ルート独自の項目別権限チェックtitle 文字列 (必須)
type 文字列 (必須)
content 文字列
include 配列
exclude 配列
priority 整数
status 文字列: publish、draft
pbs/deactivate-custom-font
フォント選択ツールからカスタムフォント (slug 指定) を削除します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/deactivate-custom-font/runedit_theme_options (REST ルート独自のチェック)slug 文字列 (必須)
pbs/delete-class
グローバルクラスを削除します。使用していた要素のコンテンツは保持されますが、スタイルは失われます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/delete-class/runedit_theme_options (REST ルート独自のチェック)id 文字列 (必須)
pbs/delete-icon
アップロードされたアイコンを削除します。使用していたブロックにはそれぞれのコピーが保持されます。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/delete-icon/rundelete_post (REST ルート独自のチェック)id 文字列 (必須)
pbs/delete-library-item
クラウドライブラリからデザインを削除します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/delete-library-item/runedit_posts (REST ルート独自のチェック)item 文字列 (必須)
team 文字列
pbs/delete-page
固定ページをゴミ箱に移動します。「固定ページ」の「ゴミ箱」から30日間復元できます。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/delete-page/runその固定ページに対する delete_postid 整数 (必須)
pbs/delete-team
チームとそのライブラリ内のすべてのデザインを削除します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/delete-team/runmanage_options (REST ルート独自のチェック)team 文字列 (必須)
pbs/delete-theme-template
1つのテンプレート (id) をゴミ箱に移動します。適用されていた箇所にはテーマ独自のデザインが再び表示されます。ゴミ箱から復元可能です。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/delete-theme-template/runREST ルート独自の項目別権限チェックid 文字列 (必須)
pbs/disconnect-support
このサイトのサポート連携を解除します。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/disconnect-support/runmanage_options (REST ルート独自のチェック)なし
pbs/duplicate-class
新しい ID でグローバルクラスを複製します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/duplicate-class/runedit_theme_options (REST ルート独自のチェック)id 文字列 (必須)
pbs/duplicate-page
固定ページ (タイトル、コンテンツ、テンプレート) を新しい下書きにコピーする。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/duplicate-page/run固定ページに対する edit_post および edit_pagesid 整数 (必須)
title 文字列
pbs/export-design
サイトデザインファイル (カテゴリー、グローバルクラス、変数、スペーシング、角丸とシャドウのスケール、カスタムカラー。フォーマット: page-builder-sandwich-design、バージョン 1) を返す。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/export-design/runedit_theme_options (REST ルート独自のチェック)なし
pbs/export-designs
選択したテンプレートとパターン (ID)、およびオプションの設定を別のサイト向けに1つのパッケージとしてエクスポートする。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/export-designs/runmanage_options (REST ルート独自のチェック)ids 配列
settings 真偽値
pbs/find-builder-pages
Elementor、Divi、Beaver Builder、WPBakery で作成された固定ページと投稿を一覧表示する (page、per_page)。各項目には使用ビルダーと、以前に変換された場合は変換後の下書きが含まれる。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/find-builder-pages/runedit_pages (REST ルート独自のチェック)page 整数
per_page 整数
pbs/generate-page
セクション (指定されたもの、または AI がセクションライブラリから選択したもの) から固定ページを構築し、デザインを維持したまま指示に合わせて AI がすべてのテキストをリライトする。プラグインの AI 設定で構成された AI プロバイダーを使用。別のステータスが要求されない限り、ページは下書きとして作成される。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/generate-page/runedit_pages、公開する場合は publish_pages、AI 設定の権限グループおよび利用上限ルールbrief 文字列 (必須)
title 文字列
sections 配列
status 文字列: draft、pending、publish、private
pbs/get-block
1つのブロックの設定 (タイプ、選択肢、デフォルト値を含む属性)、サポート機能、含めることができるブロック、およびブロックマークアップによるすぐに使える例を返す。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/get-block/runedit_postsname 文字列 (必須)
pbs/get-breakpoints
レスポンシブコントロールで使用されるタブレットとモバイルの幅 (および Pro 版のカスタムブレークポイント) を返す。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/get-breakpoints/runedit_theme_options (REST ルート独自のチェック)なし
pbs/get-conversion-tracking
Google アナリティクス 4、Google タグマネージャー、Meta ピクセルの設定と、どのクリックやフォーム送信が送信されるかを返す。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-conversion-tracking/runmanage_options (REST ルート独自のチェック)なし
pbs/get-cookie-banner
同意バナーの情報を返す (有効化されているかどうか、テキストとデザイン、カテゴリー、適用先)。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-cookie-banner/runmanage_options (REST ルート独自のチェック)なし
pbs/get-design-globals
「サイトデザイン」画面に表示される、すべてのブロックで使用されるサイト全体のカラーとフォント (見出しと本文) を返す。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/get-design-globals/runedit_theme_options (REST ルート独自のチェック)なし
pbs/get-design-system
Pro デザインシステム (グローバルクラス、変数、デザイントークン、ダークモード、ブランドキット、カスタムフォント) を返す。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-design-system/runedit_theme_options (REST ルート独自のチェック)なし
pbs/get-diagnostics
サポートチケットに含まれる診断情報 (バージョン、有効なプラグイン、制限値、最近のエラー) を返す。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/get-diagnostics/runmanage_options (REST ルート独自のチェック)なし
pbs/get-figma-connection
サイトに Figma のパーソナルアクセストークンがあるかどうか、紐づく Figma アカウント、トークンの末尾4文字を返す。トークン自体は返されない。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-figma-connection/runmanage_options (REST ルート独自のチェック)なし
pbs/get-library-account
クラウドライブラリのストレージ使用状況、プランの上限、チーム情報を返す。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-library-account/runedit_posts (REST ルート独自のチェック)なし
pbs/get-library-item
このサイトに挿入できる状態の保存済みデザインを1つ返す (画像はメディアライブラリに取り込まれる)。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-library-item/runedit_posts (REST ルート独自のチェック)item 文字列 (必須)
team 文字列
pbs/get-library-storage
持ち込み (BYO) の R2/S3 ストレージ設定を返す (シークレットは返されない)。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-library-storage/runmanage_options (REST ルート独自のチェック)なし
pbs/get-licence
このサイトの Page Builder Sandwich プラン、ライセンス状態、更新日、プランに含まれる内容を返します。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/get-licence/runmanage_options (REST ルート独自のチェック)なし
pbs/get-maintenance
メンテナンス / 近日公開モードの情報を返します: モード、ページ、retry-after、サイトを閲覧できる権限グループ。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-maintenance/runmanage_options (REST ルート独自のチェック)なし
pbs/get-migration
5.x コンテンツ変換の進捗状況とレポートを返します。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/get-migration/runREST ルート独自の項目別権限チェックなし
pbs/get-motion-options
すべてのモーション設定 (入場アニメーション、その長さと遅延、スクロール効果、ホバー効果、固定表示、パララックス、ポインター追従) とその選択肢または範囲、およびサイトのブレークポイントを返します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-motion-options/runedit_posts (REST ルート独自のチェック)なし
pbs/get-newsletter-keys
Mailchimp キーが保存されているかどうかを示します (キー自体は返されません)。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-newsletter-keys/runedit_posts (REST ルート独自のチェック)なし
pbs/get-page
ページのタイトル、ステータス、リンク、ブロックコンテンツ、およびそれを構成するセクション (最上位ブロック) を返します。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/get-page/runそのページに対する edit_postid 整数 (必須)
pbs/get-replace-job
適用前に確認できるよう、ジョブの一致項目をページごとに返します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-replace-job/runmanage_options (REST ルート独自のチェック)id 文字列 (必須)
pbs/get-reviews-sources
レビューブロックが表示する Google と Trustpilot のソースを返します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-reviews-sources/runmanage_options (REST ルート独自のチェック)なし
pbs/get-roles
ビルダー、デザイン、コード、テンプレート (クライアントモード) を使用できる権限グループを返します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-roles/runmanage_options (REST ルート独自のチェック)なし
pbs/get-settings
フロントエンドのクラス接頭辞、ベータ版更新の状態、AI エージェント (MCP) が許可されているかどうかを返します。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/get-settings/runmanage_options (REST ルート独自のチェック)なし
pbs/get-structured-data
ページのブロックが出力する schema.org 構造化データ (FAQ、ハウツー、商品、レビュー、パンくずリスト) と、重複出力を防ぐためサイトの SEO プラグインに任せるタイプを一覧表示します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-structured-data/runページに対する edit_postpost_id 整数 (必須)
pbs/get-support-connection
このサイトが Zinn Digital® サポートに接続されているかどうか、およびどのアカウントとして接続されているかを示します。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/get-support-connection/runmanage_options (REST ルート独自のチェック)refresh 真偽値
pbs/get-theme-builder-options
テンプレートタイプ、表示条件の種類 (固定ページ、投稿タイプ、ターム、アーカイブ、検索、404、ログイン済み、権限グループ、デバイス、日付、時刻、URL パラメーター、リファラー、言語、カート) とこのサイト上の選択肢 (権限グループ、言語、投稿タイプ、タクソノミー)、任意のブロックを表示または非表示にするブロック属性 (pbswConditions: {match, rules}) を返します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-theme-builder-options/runedit_posts (REST ルート独自のチェック)なし
pbs/get-white-label
ホワイトラベル設定を返します: オンまたはオフ、表示される名前、元の表示のままにするユーザー。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-white-label/runmanage_options (REST ルート独自のチェック)なし
pbs/import-design
サイトデザインファイル (file) を検証し、apply が false の場合は merge または replace (mode) によって追加、変更、削除される内容を返し、apply が true の場合は書き込みます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/import-design/runedit_theme_options (REST ルート独自のチェック)file オブジェクト (必須)
mode 文字列: merge、replace
apply 真偽値
pbs/import-designs
Page Builder Sandwich デザインパッケージをインポートします (変更内容を確認するには先に dryRun を実行。mode: skip または replace、media、settings)。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/import-designs/runmanage_options (REST ルート独自のチェック)package オブジェクト (必須)
mode 文字列: skip、replace、duplicate
settings 真偽値
media 真偽値
dryRun 真偽値
pbs/import-figma-frame
1つの Figma フレーム (url: node-id を含むフレームのリンク) を、ブロックで構成された新規下書き固定ページにインポートします。オートレイアウトは flex および grid コンテナに変換され、テキストのフォントとサイズは保持され、画像はメディアライブラリにコピーされます。サイト独自の Figma トークンを使用します。下書きと変換レポートを返します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/import-figma-frame/runedit_pages および upload_files (REST ルート独自のチェック)url 文字列 (必須)
title 文字列
dryRun 真偽値
status 文字列: draft、pending、private、publish
pbs/invite-team-member
使い捨ての招待コードを作成します (role: read または write、label、days 有効期限)。コードは一度だけ表示されます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/invite-team-member/runmanage_options (REST ルート独自のチェック)team 文字列 (必須)
role 文字列: read、write
days 整数
label 文字列
pbs/join-team
招待コードを使用してチームライブラリに参加します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/join-team/runmanage_options (REST ルート独自のチェック)code 文字列 (必須)
pbs/leave-team
このサイトが参加しているチームライブラリから脱退します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/leave-team/runmanage_options (REST ルート独自のチェック)なし
pbs/list-ab-tests
各バージョンの訪問者数とコンバージョン数、およびどちらが優勢かを含めて A/B テストを一覧表示します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-ab-tests/runedit_pages (REST ルート独自のチェック)なし
pbs/list-blocks
このサイトで使用できるすべての Page Builder Sandwich ブロック (Pro が有効な場合は Pro ブロックも含む) を一覧表示します: 名前、タイトル、カテゴリー、説明。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-blocks/runedit_postssearch 文字列
pbs/list-dynamic-sources
ブロックに挿入できるソース (投稿、投稿者、サイト、アーカイブ、カスタムフィールド、商品) と各ソースのフィールド、このサイトのフィールドプラグイン (ACF、Meta Box、Pods、JetEngine、Toolset、カスタムフィールド)、および投稿タイプのフィールド (postType) を返します。ブロックは attributes.metadata.bindings を介してソースにバインドされます (属性ごとに 1 つの {source, args})。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-dynamic-sources/runedit_posts (REST ルート独自のチェック)postType 文字列
pbs/list-extensions
他のプラグインが開発者 API 経由で Page Builder Sandwich に追加した項目 (ブロック、動的データソース、表示条件、フォームアクション) を、それぞれの名前、ラベル、プラグインとともに一覧表示します。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-extensions/runedit_postsなし
pbs/list-form-submissions
送信内容を保存するフォーム (form で絞り込み可能) から訪問者が送信した内容を、1ページずつ一覧表示します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-form-submissions/runREST ルート独自の項目別権限チェックform 文字列
per_page 整数
page 整数
pbs/list-forms
Form ブロックで作成されたフォームと、埋め込み可能なフォームプラグインを一覧表示します。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-forms/runedit_posts (REST ルート独自のチェック)なし
pbs/list-kits
このサイトでインポートできる Web サイトキット (特定の業種向けの作成済み固定ページセット) を一覧表示します。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-kits/runedit_pages および publish_pagesrefresh 真偽値
pbs/list-library-items
クラウドライブラリに保存されているデザインを一覧表示します (kind: section、page、または pattern、team: チームのライブラリ)。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-library-items/runedit_posts (REST ルート独自のチェック)team 文字列
kind 文字列:、section、page、style
pbs/list-local-fonts
このサイト自身でホストしている Google フォント (一度ダウンロードされ、サイトから配信されるため、Google へのリクエストは発生しません) を一覧表示します。
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-local-fonts/runmanage_options (REST ルート独自のチェック)なし
pbs/list-lottie
アップロードされた Lottie アニメーションを一覧表示します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-lottie/runedit_posts (REST ルート独自のチェック)なし
pbs/list-marketing-connections
メーリングリストサービス (Mailchimp、Brevo、MailerLite、Kit、ActiveCampaign) と、どれが接続されているかを一覧表示します。キーが返されることはありません。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-marketing-connections/runmanage_options (REST ルート独自のチェック)なし
pbs/list-marketing-forms
フォームビルダーで作成されたすべてのフォーム (設置されている固定ページ、フィールド、送信時の動作) を一覧表示します。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-marketing-forms/runedit_pages (REST ルート独自のチェック)なし
pbs/list-marketing-lists
フォームの購読アクション用に、連携されたメーリングリストサービスのオーディエンスやリストを取得する。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-marketing-lists/runedit_posts (REST ルート独自のチェック)service 文字列 (必須)
pbs/list-pages
編集可能な固定ページを、新しい順に取得する (任意の検索付き)。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/list-pages/runedit_pages。ユーザーが編集可能な固定ページのみを一覧表示search 文字列
status 文字列: any、draft、pending、publish、private
page 整数
per_page 整数
pbs/list-popups
ポップアップ、スライドイン、バーの一覧を、トリガー、表示頻度ルール、表示場所とともに取得する。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-popups/runedit_pages (REST ルート独自のチェック)なし
pbs/list-replace-jobs
サイト全体の検索・置換ジョブとその状態を取得する。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-replace-jobs/runmanage_options (REST ルート独自のチェック)なし
pbs/list-sections
固定ページに追加可能な既製のセクション (ヒーロー、機能、FAQ、お客様の声、コールトゥアクションなど) を取得する。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/list-sections/runedit_pagessearch 文字列
pbs/list-team-members
チーム内のサイトとそのアクセス権を取得する。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-team-members/runmanage_options (REST ルート独自のチェック)team 文字列 (必須)
pbs/list-teams
このサイトが所属または所有するチームを取得する。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-teams/runmanage_options (REST ルート独自のチェック)なし
pbs/list-theme-templates
テーマビルダーのテンプレート (ヘッダー、フッター、単一記事、アーカイブ、検索、404、および WooCommerce 使用時は商品、ショップ、カート、チェックアウト、サンキュー、マイアカウント) を取得する: それぞれのタイプ、表示場所 (包含/除外ルール)、優先度、ステータス、ブロック。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-theme-templates/runREST ルート独自のアイテムごとの権限チェックなし
pbs/list-transferable
他のサイトへエクスポート可能なテンプレート、パターン、設定を取得する。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/list-transferable/runmanage_options (REST ルート独自のチェック)なし
pbs/list-uploaded-icons
アイコンライブラリにアップロードされた SVG アイコンを、新しい順に取得する。
無料GET /wp-json/wp-abilities/v1/abilities/pbs/list-uploaded-icons/runedit_posts (REST ルート独自のチェック)page 整数
per_page 整数
pbs/move-section
固定ページのセクションをある位置から別の位置へ移動する (0始まり、ページに表示される順)。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/move-section/run該当する固定ページの edit_postid 整数 (必須)
from 整数 (必須)
to 整数 (必須)
pbs/open-support-ticket
サポートチケット (件名、メッセージ、種類、メールアドレス) を送信する。管理者が同意した場合はサイトの診断情報も含まれます。ログイン情報を作成または送信することはありません。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/open-support-ticket/runmanage_options (REST ルート独自のチェック)subject 文字列 (必須)
message 文字列 (必須)
kind 文字列: help、bug、feedback、feature_request
email 文字列
name 文字列
diagnostics 真偽値
pbs/preview-dynamic-value
バインディングの追加前または追加後に確認するため、1つの投稿でバインディングが表示する内容 (投稿、ソース、およびフィールドまたはプロバイダー + キー、text|url 形式) を返す。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/preview-dynamic-value/runedit_post (REST ルート独自のチェック)post 整数 (必須)
source 文字列 (必須)
field 文字列
provider 文字列
key 文字列
as 文字列: text、url
pbs/record-support-consent
サポートチケット送信時に診断情報を送信することに対する管理者の同意を記録する。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/record-support-consent/runmanage_options (REST ルート独自のチェック)consent 真偽値 (必須)
pbs/refresh-reviews
毎日の自動更新を待たずに、最新の Trustpilot レビューを今すぐ取得する。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/refresh-reviews/runmanage_options (REST ルート独自のチェック)なし
pbs/remove-block
パスで指定された1つのブロック (セクション全体、またはセクション内のブロック) を固定ページから削除する。ページの以前のバージョンはリビジョンに残ります。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/remove-block/run該当する固定ページの edit_postid 整数 (必須)
path 配列 (必須)
pbs/remove-library-storage
独自のストレージ設定を削除します。プランのストレージを再び使用します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/remove-library-storage/runmanage_options (REST ルート独自のチェック)なし
pbs/remove-local-font
セルフホストフォントファミリーのファイルを削除します。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/remove-local-font/runmanage_options (REST ルート独自のチェック)family 文字列 (必須)
pbs/remove-team-member
サイトをチームから削除します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/remove-team-member/runmanage_options (REST ルート独自のチェック)team 文字列 (必須)
member 文字列 (必須)
pbs/reset-ab-test
テストのカウントをクリアし、テストを再開します (test)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/reset-ab-test/runedit_pages (REST ルート独自のチェック)test 文字列 (必須)
pbs/save-library-item
ブロックマークアップ (タイトル、種類、マークアップ、スタイル、タグ) をクラウドライブラリまたはチームのライブラリに保存します。画像も一緒にパッケージ化されます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/save-library-item/runedit_posts (REST ルート独自のチェック)team 文字列
kind 文字列 (必須): section、page、style
title 文字列 (必須)
tags 配列
markup 文字列
styles オブジェクト
pbs/set-block-motion
パスで指定したページ内の1つのブロックに対し、指定したブレークポイント (デフォルトは base) でモーション設定を適用または削除 (null) します。HTML がページ内に保存されているコアブロックを含む、あらゆるブロックで動作します。「視覚効果を減らす」設定を有効にしている訪問者にはアニメーションが表示されません。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-block-motion/runedit_post (REST ルート独自のチェック)post 文字列 (必須)
path 配列 (必須)
breakpoint 文字列
motion オブジェクト (必須)
pbs/set-library-storage
独自のストレージ設定を保存します: provider (r2 または s3)、bucket、region、endpoint、prefix、key_id、secret、enabled。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-library-storage/runmanage_options (REST ルート独自のチェック)enabled 真偽値
provider 文字列: r2、s3、other
endpoint 文字列
region 文字列
bucket 文字列
prefix 文字列
keyId 文字列
secret 文字列
pathStyle 真偽値
pbs/set-maintenance
メンテナンスモード (503) または公開準備中モードを有効化または無効化 (mode) し、表示するページ (page_id)、retry_after、バイパスする権限グループを設定します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-maintenance/runmanage_options (REST ルート独自のチェック)mode 文字列: off、maintenance、coming_soon
page_id 整数
roles 配列
retry_after 整数
pbs/set-newsletter-keys
ニュースレターブロックが使用する Mailchimp API キーを保存 (または空の値で削除) します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-newsletter-keys/runmanage_options (REST ルート独自のチェック)mailchimp 文字列 (必須)
pbs/set-reviews-sources
レビューブロックが読み込む Google の場所と Trustpilot のビジネスを設定します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-reviews-sources/runmanage_options (REST ルート独自のチェック)google オブジェクト
trustpilot オブジェクト
pbs/set-roles
ビルダーで許可する操作を権限グループごとに設定します (roles)。例: コンテンツ編集のみ許可するクライアント権限など。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-roles/runmanage_options (REST ルート独自のチェック)roles オブジェクト (必須)
pbs/set-white-label
ホワイトラベルを有効化または無効化し、クライアントに表示する名前を設定します (enabled、name、agency_users)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-white-label/runmanage_options (REST ルート独自のチェック)enabled 真偽値
name 文字列
studio_name 文字列
author 文字列
author_url 文字列
description 文字列
menu_icon 文字列
hide_plugin 真偽値
agency_users 配列
pbs/site-health-clean
検出された項目を1種類クリーンアップします: リビジョン (各投稿の最新5件を保持し、古いものを削除)、パターン (未使用の同期パターンをゴミ箱に移動)、画像 (WordPress が使用するリサイズされたコピー。オリジナルは保持)、クラス (復元用に保持されている、未使用のデザインクラスを削除)。1回の実行で1バッチをクリーンアップします。項目が残っている間、”more” は true になります。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/site-health-clean/runmanage_optionswhat 文字列 (必須): revisions、patterns、images、classes
pbs/site-health-report
古いリビジョン、使用されていない同期パターン、容量の大きい元画像、どのページでも使われていないデザインクラスを検出します。短いステップで動作し、ステータスが「scanning」の間、各実行は前回の停止位置から続行します。再起動すると最初からやり直します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/site-health-report/runmanage_optionsrestart 真偽値
pbs/start-migration
すべての 5.x ページのブロックへの変換を開始 (または再開) します。各投稿は事前にバックアップされます。
無料版POST /wp-json/wp-abilities/v1/abilities/pbs/start-migration/runREST ルート独自の項目ごとの権限チェックなし
pbs/start-replace
ブロックを壊さない安全な検索と置換を開始します (検索、置換、種類: テキスト、リンク、カラー、match_case、タイプ)。プレビューされたジョブが適用されるまで何も変更されません。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/start-replace/runmanage_options (REST ルート独自のチェック)find 文字列 (必須)
replace 文字列
kind 文字列: text、link、colour
types 配列
match_case 真偽値
pbs/start-trial
このサイトで Page Builder Sandwich Pro の14日間無料お試しを開始します (支払いは不要です)。
無料版POST /wp-json/wp-abilities/v1/abilities/pbs/start-trial/runmanage_options (REST ルート独自のチェック)なし
pbs/test-library-storage
独自のストレージ内でテストオブジェクトの書き込み、読み取り、削除を行い、各ステップを報告します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/test-library-storage/runmanage_options (REST ルート独自のチェック)なし
pbs/undo-convert-post
変換された1つのページをバックアップから復元します。
無料版POST /wp-json/wp-abilities/v1/abilities/pbs/undo-convert-post/runREST ルート独自の項目ごとの権限チェックid 文字列 (必須)
pbs/undo-migration
変換されたすべての投稿をバックアップから復元します。
無料版POST /wp-json/wp-abilities/v1/abilities/pbs/undo-migration/runREST ルート独自の項目ごとの権限チェックなし
pbs/undo-replace
ジョブによって変更された投稿を復元します (それ以降に編集された投稿の編集内容は保持されます)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/undo-replace/runmanage_options (REST ルート独自のチェック)id 文字列 (必須)
pbs/update-block
パスで指定されたページ内の1つのブロックの設定 (属性) を変更します。送信された属性は現在の属性にマージされます。設定からサイトが表示するブロックで機能します。HTML がページ内に保存されているブロックは、ページのマークアップを置き換えることで変更されます。
無料版POST /wp-json/wp-abilities/v1/abilities/pbs/update-block/runそのページの edit_postid 整数 (必須)
path 配列 (必須)
attributes オブジェクト (必須)
pbs/update-brand-kit
ブランドキット (名前、ロゴ、カラー、見出しと本文のフォント、AI 執筆が使用するブランドボイス) を保存します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-brand-kit/runedit_theme_options (REST ルート独自のチェック)name 文字列
logo 整数
colors 配列
headingFont 文字列
bodyFont 文字列
voice 文字列
pbs/update-breakpoints
タブレットとモバイルの幅 (ピクセル単位) を変更します。Pro では追加のカスタムブレークポイントも変更可能です。
無料版POST /wp-json/wp-abilities/v1/abilities/pbs/update-breakpoints/runedit_theme_options (REST ルート独自のチェック)tablet 整数
mobile 整数
custom 配列
pbs/update-class
グローバルクラスのラベル、スラッグ、またはスタイルを変更します。これを使用しているすべての要素が更新されます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-class/runedit_theme_options (REST ルート独自のチェック)id 文字列 (必須)
label 文字列
slug 文字列
s オブジェクト
cat 文字列
pbs/update-conversion-tracking
Google アナリティクス 4、Google タグマネージャー、Meta ピクセルの設定と、送信するイベントを変更します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-conversion-tracking/runmanage_options (REST ルート独自のチェック)ga4 文字列
gtm 文字列
pixel 文字列
loadTags 真偽値
formEvent 文字列
pbs/update-cookie-banner
同意バナーを変更します。オンの間、追跡スクリプトは訪問者の同意を待ちます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-cookie-banner/runmanage_options (REST ルート独自のチェック)enabled 真偽値
popup 整数
handles 配列
cookieDays 整数
optOutOutsideEu 真偽値
pbs/update-dark-mode
ダークモード (モード: オフ、自動、または切り替え) とそのカラーを設定します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-dark-mode/runedit_theme_options (REST ルート独自のチェック)mode 文字列 (必須): device、light、dark
colors オブジェクト
pbs/update-design-categories
カテゴリーリストを1つ置き換えます (group: classes または tokens、items: スラッグと名前のリスト)。削除されたカテゴリーに分類されていたエントリーは「未分類」になります。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-design-categories/runedit_theme_options (REST ルート独自のチェック)group 文字列 (必須): classes, tokens
items 配列 (必須)
pbs/update-design-globals
サイト全体のカラー (colors) やフォント (fonts、headingFont、bodyFont) を変更します。すべてのページに変更が反映され、テーマの theme.json も同期されます。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/update-design-globals/runedit_theme_options (REST ルート独自のチェック)colors オブジェクト
fonts オブジェクト
bodyFont 文字列
headingFont 文字列
pbs/update-form
フォームを1つ変更します (post、form)。設定とアクションは既存のものとマージされ、フィールド (およびステップ) は置き換えられます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-form/runedit_post (REST ルート独自のチェック)post 文字列 (必須)
form 文字列 (必須)
title 文字列
fields 配列
steps 配列
actions オブジェクト
submitText 文字列
successMessage 文字列
redirectUrl 文字列
trackEvent 文字列
pbs/update-page
ページのタイトル、ステータス、またはブロックコンテンツを変更します。送信したコンテンツでページのコンテンツが置き換わります。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/update-page/run対象ページの edit_post、公開または非公開にする場合は publish_pagesid 整数 (必須)
title 文字列
status 文字列: draft, pending, publish, private
sections 配列
content 文字列
pbs/update-popup
ポップアップ、スライドイン、またはバーを変更します (id): コンテンツ、トリガー、頻度、または表示場所。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-popup/runedit_post (REST ルート独自のチェック)id 文字列 (必須)
title 文字列
content 文字列
status 文字列: draft, publish
settings オブジェクト
pbs/update-settings
フロントエンドのクラスプレフィックス (先頭が文字の1~8文字の小文字または数字) を変更する、または AI エージェント (MCP) の有効・無効を切り替えます (mcp: false にすると、すべての機能と MCP エンドポイントが削除されます)。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/update-settings/runmanage_options (REST ルート独自のチェック)prefix 文字列
mcp 真偽値
pbs/update-theme-template
テンプレートを1つ変更します (id): title、type、content (ブロックマークアップ)、include、exclude、priority、status のいずれか。送信した項目のみが変更されます。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-theme-template/runREST ルート独自のアイテム単位の権限チェックid 文字列 (必須)
title 文字列
type 文字列
content 文字列
include 配列
exclude 配列
priority 整数
status 文字列: publish, draft
pbs/update-tokens
間隔、角丸、シャドウのスケール (space、radius、shadow) を変更、またはリセット (reset) します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-tokens/runedit_theme_options (REST ルート独自のチェック)space 配列
radius 配列
shadow 配列
reset 真偽値
pbs/update-variables
サイトのデザイン変数を置き換えます (variables: 名前と値のリスト)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-variables/runedit_theme_options (REST ルート独自のチェック)variables 配列 (必須)
pbs/upload-icon
SVG アイコン (name、svg マークアップ) をアイコンライブラリに追加します。SVG は事前に対策処理 (サニタイズ) されます。
無料POST /wp-json/wp-abilities/v1/abilities/pbs/upload-icon/runupload_files (REST ルート独自のチェック)name 文字列 (必須)
svg 文字列 (必須)
pbs/upload-lottie
Lottie JSON ドキュメント (json、name) を検証し、Lottie ブロック用の静的ファイルとして公開します。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/upload-lottie/runupload_files (REST ルート独自のチェック)name 文字列 (必須)
json 文字列 (必須)

プラグインの abilities.json から生成されています。abilities.json 自体は稼働中のサイトから生成されており、両者が一致しない場合にテストが失敗します。

WP-CLI コマンド

これらをサーバー上で WP-CLI を使用して実行します。各コマンドはプラグインの管理画面と同じ権限をチェックします。サンプルはプラグイン自体のヘルプテキストから引用されています。

コマンド機能エディション
wp pbs export [--types=<types>] [--no-settings] [--file=<name>]テンプレート、パターン、設定をファイルにエクスポートする。Free
wp pbs import <file> [--mode=<mode>] [--no-settings] [--media] [--dry-run]エクスポートファイルをインポートする。Free
wp pbs importers runレガシーコンテンツを変換する (すべての投稿、または1件)。Free
wp pbs importers status移行ステータスを表示する。Free
wp pbs importers undoバックアップから変換を取り消す (すべての投稿、または1件)。Free
wp pbs migrate runレガシーコンテンツを変換する (すべての投稿、または1件)。Free
wp pbs migrate status移行ステータスを表示する。Free
wp pbs migrate undoバックアップから変換を取り消す (すべての投稿、または1件)。Free
wp pbs replace <find> <replace> [--kind=<kind>] [--types=<types>] [--ignore-case] [--dry-run] [--undo=<job>]サイト全体を対象に検索と置換を実行する。Pro
wp pbsw fonts download <family> [--weights=<weights>] [--italic]Google Fonts ファミリーをこのサイトにダウンロードする。Free
wp pbsw fonts list保存されているフォントファミリーを一覧表示する。Free
wp pbsw fonts remove <family>保存されているフォントファミリーとそのファイルを削除する。Free

アクションとフィルター

プラグインが提供するすべてのフックと、そのソースコードからの説明です。フィルターは値を変更し、アクションは特定のタイミングでコードを実行できるようにし、エントリポイントはプラグインに処理を要求するためにトリガーするアクションです。

フック種類説明パラメーターエディション
pbs_assets_changedアクションPBS の公開フロントエンドファイルが変更され、アクセス可能なページキャッシュがクリアされたときに発火します。PBS が直接アクセスできない対象 (CDN、プロキシ、ホスティングのキャッシュなど) をパージするためにフックします。なし無料版
pbs_enqueue_scriptsアクションレガシーアクション: window.pbsAddInspector() を呼び出すスクリプトをエンキューします。なし無料版
pbs_shortcodesフィルターレガシーフィルター: ショートコードタグ => {label, desc, options[]} (Shortcode-API.md)。array $shortcodes無料版
pbsw_admin_dataフィルター管理アプリの起動時に読み込まれるデータをフィルタリングします。Premium レイヤーがエディションの通知に使用します。ページ内に出力されるため、機密情報は含めないでください。なし無料版
pbsw_admin_enqueueアクション管理画面のスクリプトがエンキューされた後に発火します。これにより、モジュールは `pbs.admin.panels` JavaScript フィルター経由でパネルを追加するスクリプトをエンキューできます (このハンドルに依存する必要があります。画面はすべてのフッタースクリプト実行後の DOM 準備完了時にレンダリングされます)。string $handle無料版
pbsw_ai_enqueueアクションAI エディターバンドルがエンキューされた後に発火します。アドオン (および Pro レイヤー) がその後に独自の AI パネルをエンキューできるようにします。string $handle無料版
pbsw_ai_messagesフィルタープラグインが送信するすべての AI リクエストのメッセージをコンテキスト (タスク、目的、プロバイダー、モデル、ユーザー) とともにフィルタリングします。Pro ブランドキットはここでブランド情報を追加します。array $messages
array $context
無料版
pbsw_ai_pro_featuresフィルターエディターが提供する Pro AI 機能をフィルタリングします (Premium レイヤーが agent、site、block、design、image、css、a11y などの名前を追加します)。なし無料版
pbsw_ai_seo_pluginsフィルターAI SEO ヘルパーがメタタイトルとディスクリプションを書き込む SEO プラグインをフィルタリングします。なし無料版
pbsw_ai_seo_writeフィルター別の SEO プラグインがメタタイトルとディスクリプションを取得したかどうかをフィルタリングします。`pbsw_ai_seo_plugins` で追加されたプラグインは、独自の方法でそれらを保存し、true を返します。bool $written
string $plugin
int $post_id
string $title
string $description
無料版
pbsw_asset_sourcesフィルターすべてのフロントエンドソース (このファイルのソース、パフォーマンスレイヤーが add_source() で登録したブロックごとの CSS やビューモジュール、および Premium レイヤーが `pbsw_asset_sources` 経由で自身のために追加するソース)。Premium パッケージのみに含まれる専用ディレクトリにファイルが配置されます。プラグイン内の相対パスである小文字セグメントの `.css`/`.js` のみを受け付けます (`legacy.css`、`block/row.css`、`module/tabs.js`)。なし無料版
pbsw_breakpoints_changedアクションブレークポイントが変更されたときに発火します (ブレークポイントはその署名の一部であるため、コンパイルされたページシートは次回の表示時に再構築されます)。なし無料版
pbsw_cache_purgedアクションPBS が有効なキャッシュプラグインから投稿をパージした後に発火します。int $post_id無料版
pbsw_cache_purgersフィルター公開ファイルが変更されたときに実行される追加のパージャーをフィルタリングします: 名前 => コール可能。ホストが独自のもの (CDN、プロキシ) を追加します。エラーをスローしたものはスキップされ、パージ済みとして報告されません。なし無料版
pbsw_code_blocksフィルターカスタムコードとして扱われるブロック名をフィルタリングします (`code` 権限を持つロールのみが追加または変更できます)。なしPro
pbsw_consent_countryフィルターCookie バナーの地域ルール向けに訪問者の国 (ISO 3166-1 alpha-2) をフィルタリングします。プラグインが自動で国を検索することはありません。不明な場合は ” を返します。string $countryPro
pbsw_content_onlyフィルターレイアウトをロックした状態で、ユーザーにテキストと画像のみの編集を許可するかどうかをフィルタリングします。bool $content_only
int $user_id
無料版
pbsw_design_class_cssフィルターデザインエンジンに渡される前に、グローバルクラスのコンパイル済み CSS をフィルタリングします。代わりに使用する文字列を返します。string|null $css
string $selector
Pro
pbsw_design_custom_breakpointsフィルターカスタムブレークポイントを使用できるかどうかをフィルタリングします (pbs-d3、Pro)。bool $allowed無料版
pbsw_design_element_cssフィルター要素ごとのカスタム CSS をコンパイルするかどうかをフィルタリングします (Premium レイヤーで有効化、d8)。bool $enabled無料版
pbsw_design_layout_suffixフィルターブロックのレイアウト要素セレクターのサフィックスをフィルタリングします (” = ブロック自身の要素)。string $suffix
string $prefix
無料版
pbsw_design_propsフィルターデザインプロパティをフィルタリングします (Premium レイヤーが独自の内容を追加します)。なし無料版
pbsw_dynamic_editor_sourcesフィルターエディター内のソースを追加します (WooCommerce 商品フィールド)。なしPro
pbsw_dynamic_fieldsフィルターこのプラグインが読み取る一覧取得 API を持たないプロバイダー (JetEngine、Toolset) のフィールドカタログ。フィールドキーはエディターに入力するか、ここに追加します。string $post_typePro
pbsw_dynamic_sourcesフィルターソースを追加します (WooCommerce 商品): 名前 → ラベル。値は `pbsw_dynamic_value` から取得します。なしPro
pbsw_dynamic_valueフィルター別のソース (WooCommerce) からの値。string|null $value
string $source
Pro
pbsw_form_submittedアクションフォーム送信の検証に合格し、アクションが実行された後に発火します。なしPro
pbsw_frontend_prefixフィルターフロントエンドのニュートラルなクラスプレフィックスをフィルターします。string $prefixFree
pbsw_fs_loadedアクションライセンス SDK が読み込まれた直後 (メインファイル内、Page Builder Sandwich のコードが実行される前) に発火します。`pbsw_fs()` と通信するフックとして使用します。なしFree
pbsw_is_agencyフィルターこのサイトで Agency プランの機能が利用可能かどうかをフィルターします。bool $agencyFree
pbsw_is_proフィルタープレミアムレイヤーが実行中かどうかをフィルターします。プレミアムレイヤーのみが応答します。bool $proFree
pbsw_kit_api_baseフィルターサポート画面が呼び出す Zinn Digital® の API ベース URL をフィルターします。string $baseFree
pbsw_kit_diagnosticsフィルターサイト管理者が診断情報を確認する前にフィルターします。プラグインは `extra` 配下に独自の情報を追加します。⛔ この処理はプレビューの前に実行され、プレビューと送信の間で実行されることはありません。なしFree
pbsw_kit_footprint_freeフィルターこのサイトがフットプリントフリーであるか (Zinn® Ads のプロモーションを非表示にするか) をフィルターします。bool $footprint_freeFree
pbsw_kit_importedアクションキットのインポート完了後に発火します。int $frontFree
pbsw_kit_promotionsフィルター解決前のプロモーションレジストリをフィルターします。別の製品を宣伝する場合は行を追加します: `id`、`kind` (hosting|marketplace|platform|plugin|bundle|ads)、`slot` (promo|cross-sell)、および `url` または (プラグインの場合) `name`、`site`、`main_files`。なしFree
pbsw_kit_tierフィルターキットがこのプラグインに対して報告するプラン階層をフィルターします (テストおよびステージング環境向け。本番環境ではライセンスによって決まります)。string $tierFree
pbsw_lcp_foldフィルターコンテンツの上端からファーストビューと見なす範囲を CSS ピクセル単位で指定します。この位置より上で始まるブロックはファーストビュー内として扱われます。画像は即時読み込みされ、最も LCP になりやすい画像には `fetchpriority=”high”` が付与されます。この位置より下のブロックは遅延読み込みされます。ヒーローセクションが高い場合は数値を上げ、ヘッダーがコンパクトな場合は下げてください。int $foldFree
pbsw_legacy_body_classesフィルターレガシーな body クラスをフィルターします。プレミアムレイヤーは、ここに旧プレミアム版のレスポンシブクラスを追加します (ガイドライン 5: この動作は無料版プラグインには含まれません)。なしFree
pbsw_legacy_script_enqueuedアクションレガシー投稿のフロントエンド動作が検証された際に発火します (プレミアムレイヤーが独自の処理を追加します)。int $post_id
string $content
string|null $handle
Free
pbsw_library_tokenフィルターキットのリクエスト時に送信される Bearer トークンをフィルターします (プレミアムクラウドライブラリから提供されます)。string $tokenFree
pbsw_link_baseフィルター短縮リンクが配置されるパス (`/go/<slug>/`) をフィルターします。string $basePro
pbsw_list_servicesフィルターフォームが登録できるメーリングリストサービスをフィルターします。なしPro
pbsw_loop_query_argsフィルターループのクエリ (WooCommerce: 価格帯、セール中、在庫あり、価格 / 人気順 / 評価順の並べ替え)。なしPro
pbsw_loop_sortsフィルター並べ替えの選択肢 (WooCommerce が価格、人気順、評価順を追加)。なしPro
pbsw_mcp_abilitiesアクション無料版の機能が登録された後に発火します。Page Builder Sandwich Pro はここで独自の機能を登録します (ライセンスでプレミアムコードが許可されている場合のみ起動時にフックされます)。なしFree
pbsw_migration_batch_sizeフィルター1回のバックグラウンド移行ステップで変換するレガシー (5.x) 投稿の件数。各ステップは1つの Action Scheduler アクションです。低速またはメモリの少ないホストには小さいバッチが、投稿数が多い高速なホストには大きいバッチが適しています。1未満の値は 1 として扱われます。int $sizeFree
pbsw_migration_post_typesフィルターレガシー移行で変換する投稿タイプをフィルターします。list<string> $typesFree
pbsw_nav_menu_item_classesフィルター項目のクラスをフィルターします (Pro の項目オプションでは `nav-menu__item–hide-mobile` と `–hide-desktop` を追加)。`nav-menu__item–<name>` クラスのみが保持されます。int $depthFree
pbsw_nav_menu_item_labelフィルター項目のラベル (エスケープ処理された HTML) をフィルターします (Pro の項目オプションではアイコン、バッジ、説明を追加)。コールバックはエスケープ処理済みの HTML を返す必要があります。string $label
int $depth
string $prefix
Free
pbsw_nav_menu_toggleフィルター「Menu」ボタンの HTML をフィルターします。Pro のトグルバーデザイナーは、ロゴ、検索ボックス、リンクなどを含むバー内にこのボタンを配置します (メニューが折りたたまれている間のみ表示)。ボタンがそのまま含まれていない結果は無視されるため、メニューからボタンが消えることはありません。string $toggle
string $prefix
Free
pbsw_newsletter_form_settingsフィルター5.x 以外のフォームの設定 (data-* ⇒ 値)、または空の配列。int $post_id
string $form
Free
pbsw_newsletter_providersフィルターこのサイトで購読できるニュースレターサービス: service ⇒ callable( string $email, array $settings ): array{ok: bool, message: string}。プレミアム版では 5.x の3つのサービスが追加されます。なしFree
pbsw_page_css_changedアクション投稿のコンパイル済みスタイルシートが変更されたときに実行します (キャッシュプラグインがこれに応じてパージを実行)。int $post_idFree
pbsw_page_css_enqueuedアクションページのコンパイル済みスタイルシートがキューに追加された後に実行します (プレミアムのクリティカル CSS レイヤーがここにフックします)。string $handle
int $post_id
Free
pbsw_page_css_extraフィルターブロック自体のスタイルシートの後、ページのコンパイル済みスタイルシートに追加される CSS をフィルターします (pbs-p4: デザインシステムの `.<prefix>-s-<id>` ルール)。ここでは縮小化ではなくコンパイルが行われ、リスナーは配信可能な CSS を返します。string $extra
string $prefix
int $post_id
Free
pbsw_page_css_signatureフィルターコンパイル状態を最新とみなすためのその他の条件をフィルターします (pbs-p4: ブレークポイント)。string $extra
\WP_Post $post
Free
pbsw_page_css_stateフィルター保存される前の投稿のコンパイル状態をフィルターします (pbs-p4 はスタイルシートが持つデザインルールを記録し、レンダーフィルターがそれらを再度出力しないようにします)。int $post_idFree
pbsw_permissionフィルターユーザーがビルダー機能を使用できるかどうかをフィルターします。無料版プラグインはすべて許可し、Pro の権限マネージャーはロールごとに判定します。管理者は常に許可される必要があります。bool $allowed
string $what
int $user_id
Free
pbsw_popup_forceフィルターターゲット設定に関係なくすべてのページに出力されるポップアップ (Cookie バナーなど)。なしPro
pbsw_replace_post_typesフィルター検索と置換がデフォルトで検索する投稿タイプをフィルターします。なしPro
pbsw_schema_skipフィルターサイトの SEO プラグインがこのページにすでに出力しているため、Page Builder Sandwich が除外する構造化データタイプをフィルターします。string $contentPro
pbsw_site_design_dataフィルター「サイトデザイン」の起動データをフィルターします。プレミアム版はエディションを報告し、セクションに必要なデータを追加します。なしFree
pbsw_site_design_depsフィルター「サイトデザイン」バンドルの依存関係をフィルターします。プレミアム版はここに自身のスクリプトを追加し、パネルが最初にレンダリングされる前にセクションを登録します。string $handleFree
pbsw_site_health_keep_revisionsフィルタークリーンアップ時に保持する各投稿の最新リビジョン数をフィルターします (デフォルトは5)。int $keepPro
pbsw_style_at_rulesフィルター「スタイル」›「条件」でスタイルビルダーが提供する at-rule プリセットをフィルターします: `array( ‘id’ => ‘narrow-card’, ‘label’ => ‘Narrow card’, ‘type’ => ‘container’, ‘query’ => ‘card (max-width:400px)’ )` のリスト (`type` は `media`、`container`、`supports` のいずれか)。条件の下で設定された値は、画面サイズルールの後に `@<type> <query>{…}` として出力されます。組み込みのプリセットは「印刷」、「ダークカラー設定」、「視覚効果の削減」、「マウスまたはトラックパッド」です。無効なプリセットは破棄され、`pbsw_style_at_rules_invalid` アクションで通知されます。なしFree
pbsw_style_at_rules_invalidアクション`pbsw_style_at_rules` からのプリセットが無効として破棄されたときに実行します。なしFree
pbsw_template_content_locationフィルターより具体的なコンテンツの場所 (WooCommerce: single_product、product_archive、cart など)。string $locationPro
pbsw_template_resolvedフィルター特定の場所に選択されたテンプレート。string $typePro
pbsw_template_typesフィルター追加のテンプレートタイプ (WooCommerce ページ)。なしPro
pbsw_theme_builder_editor_dataFilterエディターの追加データ (動的データソースやフィールドプラグイン、WooCommerce 関連の要素)。nonePro
pbsw_theme_globals_savedActionこのアクションについては以下で説明します。noneFree
pbsw_transfer_importedActionパッケージのインポート後に実行され、テンプレートや設定から作成されたキャッシュ (ページごとのスタイル、サイトのスタイルシート) を再構築できるようにします。noneFree
pbsw_transfer_meta_keysFilterインポートおよびエクスポートが各アイテムとともに保持する投稿メタキーをフィルターします。noneFree
pbsw_transfer_optionsFilterインポートおよびエクスポートでサイト間を移行できるオプションをフィルターします。受け入れられるのは `pbsw_` オプションのみです。パッケージがコアやサードパーティのオプションを上書きできないよう、それ以外のオプションはすべて除外されます。noneFree
pbsw_transfer_post_typesFilterインポートおよびエクスポートでサイト間を移行できる投稿タイプをフィルターします。noneFree
pbsw_visitor_countryFilter別の方法 (位置情報プラグインやメンバーシッププロフィールなど) で訪問者の国を特定しているサイト向けに、年齢確認や責任あるギャンブルに関する案内に使用する訪問者の国をフィルターします。string $countryPro
pbsw_white_label_mapFilterホワイトラベルの置き換え (変換元テキスト => 表示テキスト) をフィルターします。nonePro