开发者

Page Builder Sandwich 能力参考

Page Builder Sandwich 将其操作注册到 WordPress Abilities API。这些相同的能力既是该网站自身服务器上的 MCP 工具,也是 /wp-json/wp-abilities/v1 下的 REST 路由。此页面根据插件自身的注册表生成。

用户指南:连接 AI 应用程序

端点

能力REST
基于 HTTP 的 MCP(可流式传输)/wp-json/pbs/v1/mcp
基于 WP-CLI 的 MCP(标准输入与输出)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 (只读能力使用带 ?input= 的 GET,其余使用 POST {"input": {...}})

身份验证与权限

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 字体系列(字体系列、字重、斜体)并从本站提供服务。
免费版POST /wp-json/wp-abilities/v1/abilities/pbs/add-local-font/runmanage_options(REST 路由自身的检查)family 字符串(必填)
weights 数组
italic 布尔值
pbs/add-section
向页面添加现成区块:在开头、在末尾,或在指定位置的区块之后。
免费版POST /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
列出页面的无障碍问题:缺少替代文本的图像、跳过层级的标题、文本本身毫无意义的链接,以及没有文本的链接。每一项都会说明是否可以自动修复。
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
解释、编写或修复单个元素的自定义 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
将屏幕截图(媒体库中的图像)或公开网页(其网址)的布局在新草稿页面中重建为可编辑的区块:包含相同的区块、分栏、标题、文本、列表和按钮。徽标和图像不会被复制。
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
根据自然语言指令修改页面(例如“缩短首屏文本”、“在价格方案后添加关于配送的常见问题解答”、“将页面翻译成德语”)。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):通过识别每张图像生成替代文本、修正标题层级、重写模糊的链接文本。系统会先保存一个修订版本,并将其 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
将一句话描述转化为已设计好的区块(符合站点品牌风格的真实、可编辑区块),并配有专门撰写的文本。返回区块标记,并在提供 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
根据业务描述列出网站所需的页面(首页在最前,联系方式在最后),每个页面都包含标题和该页面的简述。不会创建任何内容;随后可以根据各自的简述构建每个页面。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/ai-plan-site/runedit_pages;AI 设置的角色和支出规则brief 字符串(必填)
pbs/ai-save-seo-meta
将 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
读取页面并建议 Meta 标题(最多 60 个字符)和 Meta 描述(最多 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)。每次调用最多 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
导入网站套件的页面(全部页面或指定页面),可选择发布它们、设置首页并将其添加到菜单中。再次导入会更新相同的页面。
免费版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
在单次调用中最多创建 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)。
免费POST /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 构建的一个页面(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 页面转换为区块(会先进行备份)。
免费POST /wp-json/wp-abilities/v1/abilities/pbs/convert-post/runREST 路由自身的单项权限检查id 字符串(必填)
pbs/create-ab-test
在文章末尾添加对某个部分的两个版本进行的测试(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
创建表单(联系表单、报价表单、注册表单或多步骤表单:fields、steps、settings 以及诸如电子邮件、保存、Webhook 或邮件列表等 actions),可建于新页面上或置于现有文章的末尾(post)。
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
创建弹窗、滑出窗口或通知条:包括其内容、触发器(退出意图、滚动、时间、点击)、频率以及显示的页面。
专业版POST /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、pagination 以及实时筛选器 [{type: search|taxonomy|meta|sort|price|onsale|instock, taxonomy, key, label, ui}]。
专业版POST /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),其他站点可通过邀请码加入。
专业版POST /wp-json/wp-abilities/v1/abilities/pbs/create-team/runmanage_options(REST 路由自带的权限检查)name 字符串(必填)
pbs/create-theme-template
创建一个模板(title、type),用于替换经典主题和区块主题中每个匹配页面的相应部分。若无内容,它将从对应类型的现成设计开始创建。include/exclude 为显示条件规则({kind, values, key, value, from, to, days},即本站主题构建器提供的类型);priority 用于决胜优先;status 为 publish(上线)或 draft。
专业版POST /wp-json/wp-abilities/v1/abilities/pbs/create-theme-template/runREST 路由自带的单项权限检查title 字符串(必填)
type 字符串(必填)
content 字符串
include 数组
exclude 数组
priority 整数
status 字符串:publish、draft
pbs/deactivate-custom-font
从字体选择器中移除自定义字体(按别名)。
专业版POST /wp-json/wp-abilities/v1/abilities/pbs/deactivate-custom-font/runedit_theme_options(REST 路由自带的权限检查)slug 字符串(必填)
pbs/delete-class
删除全局类。使用该类的元素将保留其内容,但会丢失其样式。
专业版POST /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
从云端库中删除设计。
专业版POST /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_post 权限id 整数(必填)
pbs/delete-team
删除团队及其库中的所有设计。
专业版POST /wp-json/wp-abilities/v1/abilities/pbs/delete-team/runmanage_options(REST 路由自带的权限检查)team 字符串(必填)
pbs/delete-theme-template
将一个模板(id)移至回收站;主题自身的设计将在该模板原本适用的位置重新显示。可从回收站恢复。
专业版POST /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 下复制全局类。
专业版POST /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_pages 权限id 整数(必填)
title 字符串
pbs/export-design
返回全站设计文件:分类、全局类、变量、间距、圆角与阴影比例及自定义颜色(格式为 page-builder-sandwich-design,版本 1)。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/export-design/runedit_theme_options(REST 路由自带的权限检查)无
pbs/export-designs
将所选的模板和样板(ids)以及可选的设置打包导出,以便用于其他站点。
免费版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),并附带各自所用的构建器,以及先前已转换过的转换后草稿。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/find-builder-pages/runedit_pages(REST 路由自带的权限检查)page 整数
per_page 整数
pbs/generate-page
从区块(提供指定区块,或由 AI 从区块库中选取)构建页面,并在保留设计的同时让 AI 根据您的需求简报重写其所有文本。使用在插件 AI 设置中配置的 AI 提供商。除非指定了其他状态,否则页面默认为草稿。
专业版POST /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
返回单个区块的设置(属性及其类型、选项和默认值)、支持的功能、可包含的区块,以及区块标记格式的开箱即用示例。
免费版GET /wp-json/wp-abilities/v1/abilities/pbs/get-block/runedit_postsname 字符串(必填)
pbs/get-breakpoints
返回响应式控件所使用的平板电脑和移动设备宽度(以及专业版中的自定义断点)。
免费版GET /wp-json/wp-abilities/v1/abilities/pbs/get-breakpoints/runedit_theme_options(REST 路由自带的权限检查)无
pbs/get-conversion-tracking
返回 Google Analytics 4、Google 标签管理器(Google Tag Manager)和 Meta Pixel 设置,以及发送哪些点击和表单提交数据。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-conversion-tracking/runmanage_options(REST 路由自带的权限检查)无
pbs/get-cookie-banner
返回 Cookie 许可横幅:是否启用、文本与设计、分类以及适用的范围。
专业版GET /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
返回专业版设计系统:全局类、变量、设计令牌(token)、深色模式、品牌资产库(Brand Kit)和自定义字体。
专业版GET /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 账户及其后四位字符。令牌本身绝不会被返回。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-figma-connection/runmanage_options(REST 路由自带的权限检查)无
pbs/get-library-account
返回云端库的存储用量、套餐配额和团队信息。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-library-account/runedit_posts(REST 路由自带的权限检查)无
pbs/get-library-item
返回单个已保存的设计,可直接插入到本站中(其图片会导入到媒体库中)。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-library-item/runedit_posts(REST 路由自带的权限检查)item 字符串(必填)
team 字符串
pbs/get-library-storage
返回自带存储(BYO R2/S3)设置(密钥绝不会被返回)。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-library-storage/runmanage_options(REST 路由自带的权限检查)无
pbs/get-licence
返回本站点的 Page Builder Sandwich 方案、许可证状态、续费日期以及方案所包含的内容。
免费版GET /wp-json/wp-abilities/v1/abilities/pbs/get-licence/runmanage_options(REST 路由自身的检查)无
pbs/get-maintenance
返回维护/即将推出模式信息:模式、页面、重试时间(retry-after)以及哪些角色仍可访问该站点。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-maintenance/runmanage_options(REST 路由自身的检查)无
pbs/get-migration
返回 5.x 内容转换的进度和报告。
免费版GET /wp-json/wp-abilities/v1/abilities/pbs/get-migration/runREST 路由自身的单项权限检查无
pbs/get-motion-options
返回所有动态效果设置(入场动画、其时长和延迟、滚动效果、悬停效果、保持在视口中、视差、跟随指针)及其选项或取值范围,以及站点的断点。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-motion-options/runedit_posts(REST 路由自身的检查)无
pbs/get-newsletter-keys
指示是否已保存 Mailchimp 密钥(绝不会返回密钥本身)。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-newsletter-keys/runedit_posts(REST 路由自身的检查)无
pbs/get-page
返回页面的标题、状态、链接和区块内容,以及构成该页面的各节(顶层区块)。
免费版GET /wp-json/wp-abilities/v1/abilities/pbs/get-page/run针对该页面的 edit_post 权限id 整数(必填)
pbs/get-replace-job
按页面逐一返回任务的匹配项,以便在应用前进行审核。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-replace-job/runmanage_options(REST 路由自身的检查)id 字符串(必填)
pbs/get-reviews-sources
返回“评价”区块所展示的 Google 和 Trustpilot 来源。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-reviews-sources/runmanage_options(REST 路由自身的检查)无
pbs/get-roles
返回哪些角色可以使用构建器、设计、代码和模板(客户模式)。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-roles/runmanage_options(REST 路由自身的检查)无
pbs/get-settings
返回前端类名前缀、测试版更新状态以及是否允许 AI 智能体(MCP)。
免费版GET /wp-json/wp-abilities/v1/abilities/pbs/get-settings/runmanage_options(REST 路由自身的检查)无
pbs/get-structured-data
列出页面区块输出的 schema.org 结构化数据(FAQ、操作指南、产品、评价、面包屑导航),以及哪些类型交由站点的 SEO 插件处理以避免重复输出。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-structured-data/run针对该页面的 edit_post 权限post_id 整数(必填)
pbs/get-support-connection
指示本站点是否已连接到 Zinn Digital® 支持,以及以何种身份连接。
免费版GET /wp-json/wp-abilities/v1/abilities/pbs/get-support-connection/runmanage_options(REST 路由自身的检查)refresh 布尔值
pbs/get-theme-builder-options
返回模板类型、显示条件种类(页面、文章类型、分类项目、归档、搜索、404、已登录、角色、设备、日期、时间、URL 参数、引荐来源、语言、购物车)及其在当前站点上的可用选项(角色、语言、文章类型、分类法),以及用于显示或隐藏任意区块的区块属性(pbswConditions: {match, rules})。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-theme-builder-options/runedit_posts(REST 路由自身的检查)无
pbs/get-white-label
返回白标设置:开启或关闭、显示的名称以及哪些用户仍会看到原始内容。
专业版GET /wp-json/wp-abilities/v1/abilities/pbs/get-white-label/runmanage_options(REST 路由自身的检查)无
pbs/import-design
验证站点设计文件(file),并在 apply 为 false 时返回合并或替换(mode)将添加、更改和移除的内容;在 apply 为 true 时写入这些更改。
专业版POST /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)。
免费版POST /wp-json/wp-abilities/v1/abilities/pbs/import-designs/runmanage_options(REST 路由自身的检查)package 对象(必填)
mode 字符串:skip、replace、duplicate
settings 布尔值
media 布尔值
dryRun 布尔值
pbs/import-figma-frame
将一个 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;有效天数)。邀请码仅显示一次。
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 区块):名称、标题、分类和描述。
免费版GET /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 绑定到来源,每个属性对应一个 {source, args}。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-dynamic-sources/runedit_posts(REST 路由自身检查)postType 字符串
pbs/list-extensions
列出其他插件通过其开发者 API 向 Page Builder Sandwich 添加的内容:区块、动态数据源、显示条件和表单操作,每项均包含其名称、标签和所属插件。
免费版GET /wp-json/wp-abilities/v1/abilities/pbs/list-extensions/runedit_posts无
pbs/list-form-submissions
按页列出访客通过保存提交内容的表单所发送的数据(可通过 form 进行筛选)。
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-form-submissions/runREST 路由自身针对每项的权限检查form 字符串
per_page 整数
page 整数
pbs/list-forms
列出使用“表单”区块构建的表单以及其可嵌入的表单插件。
免费版GET /wp-json/wp-abilities/v1/abilities/pbs/list-forms/runedit_posts(REST 路由自身检查)无
pbs/list-kits
列出本站点可以导入的网站套件(适用于某种业务类型的一套现成页面)。
免费版GET /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 发送请求)。
免费版GET /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
列出可添加到页面的现成区块段(首屏横幅、功能、常见问题、评价、号召性用语等)。
免费版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_post 权限id 整数(必填)
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
返回某篇文章上绑定所显示的内容(文章、来源以及字段或提供方 + 键,格式为 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
从页面中移除一个区块(整个区块段或其内部的某个区块),按路径查找。页面的先前版本会保存在修订版本中。
免费版POST /wp-json/wp-abilities/v1/abilities/pbs/remove-block/run针对该页面的 edit_post 权限id 整数(必填)
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
在指定断点(默认为 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
保存自带存储设置:提供商(r2 或 s3)、存储桶、区域、端点、前缀、key_id、密钥、已启用。
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
清理一种检测结果:修订版本(保留每篇文章最新的 5 个,删除更早的版本)、样板(将未使用的同步样板移至回收站)、图片(WordPress 使用的缩放副本;原始文件予以保留)、类(移除未使用的设计类,保留以供恢复)。每次运行清理一个批次;只要仍有检测结果,”more” 便为 true。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/site-health-clean/runmanage_optionswhat 字符串(必填):revisions、patterns、images、classes
pbs/site-health-report
查找旧修订版本、未被任何内容使用的同步样式、过大的原始图片以及没有任何页面使用的设计类。以短步骤运行:在状态为“scanning”期间,每次运行都会从上次停止的位置继续;restart 会重新开始。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/site-health-report/runmanage_optionsrestart boolean
pbs/start-migration
开始(或重新开始)将所有 5.x 页面转换为区块;每篇文章都会先进行备份。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/start-migration/runREST 路由自带的单项权限检查无
pbs/start-replace
启动区块安全的查找与替换(查找、替换、类型:文本、链接或颜色;区分大小写;类型)。在应用预览的任务之前,不会更改任何内容。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/start-replace/runmanage_options(REST 路由自带的检查)find string(必填)
replace string
kind string: text, link, colour
types array
match_case boolean
pbs/start-trial
为此站点开启 14 天 Page Builder Sandwich Pro 试用(无需付款)。
FreePOST /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
从备份中恢复一个已转换的页面。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/undo-convert-post/runREST 路由自带的单项权限检查id string(必填)
pbs/undo-migration
从备份中恢复所有已转换的文章。
FreePOST /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 string(必填)
pbs/update-block
更改页面内某个区块的设置(属性),通过其路径定位;您发送的属性将与当前属性合并。适用于站点根据其设置渲染的区块;HTML 直接保存在页面中的区块则通过替换页面的标记来进行更改。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/update-block/run该页面上的 edit_post 权限id integer(必填)
path array(必填)
attributes object(必填)
pbs/update-brand-kit
保存品牌套件:名称、Logo、颜色、标题和正文字体,以及 AI 写作使用的品牌语调。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-brand-kit/runedit_theme_options(REST 路由自带的检查)name string
logo integer
colors array
headingFont string
bodyFont string
voice string
pbs/update-breakpoints
以像素为单位更改平板电脑和移动设备宽度;使用 Pro 版可自定义额外的断点。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/update-breakpoints/runedit_theme_options(REST 路由自带的检查)tablet integer
mobile integer
custom array
pbs/update-class
更改全局类的标签、别名或样式;使用它的每个元素都会更新。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-class/runedit_theme_options(REST 路由自带的检查)id string(必填)
label string
slug string
s object
cat string
pbs/update-conversion-tracking
更改 Google Analytics 4、Google 标签管理器(Google Tag Manager)和 Meta Pixel 设置以及发送的事件。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-conversion-tracking/runmanage_options(REST 路由自带的检查)ga4 string
gtm string
pixel string
loadTags boolean
formEvent string
pbs/update-cookie-banner
更改同意横幅。启用时,跟踪脚本将等待访客同意。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-cookie-banner/runmanage_options(REST 路由自带的检查)enabled boolean
popup integer
handles array
cookieDays integer
optOutOutsideEu boolean
pbs/update-dark-mode
设置深色模式(模式:关闭、自动或切换开关)及其颜色。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-dark-mode/runedit_theme_options(REST 路由自带的检查)mode string(必填): device, light, dark
colors object
pbs/update-design-categories
替换一个分类列表(group:classes 或 tokens;items:包含 slug 和 name 的列表)。归类于已移除分类下的条目将变为未分类。
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 将保持同步。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/update-design-globals/runedit_theme_options(REST 路由自身检查)colors 对象
fonts 对象
bodyFont 字符串
headingFont 字符串
pbs/update-form
更改单个表单(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
更改页面的标题、状态或区块内容。您发送的内容将替换该页面的内容。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/update-page/run针对该页面的 edit_post 权限;发布或设为私密需要 publish_pages 权限id 整数(必填)
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 端点)。
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/update-settings/runmanage_options(REST 路由自身检查)prefix 字符串
mcp 布尔值
pbs/update-theme-template
更改单个模板(id):标题、类型、内容(区块标记)、包含、排除、优先级、状态中的任意项。仅更改您发送的内容。
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:包含 name 和 value 的列表)。
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-variables/runedit_theme_options(REST 路由自身检查)variables 数组(必填)
pbs/upload-icon
向图标库添加 SVG 图标(name、svg 标记);SVG 将首先进行清理净化。
FreePOST /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,该文件本身由运行中的站点生成;两者不一致时测试将失败。

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转换旧版内容:所有文章或单篇文章。Free
wp pbs importers status显示迁移状态。Free
wp pbs importers undo从备份撤销转换:所有文章或单篇文章。Free
wp pbs migrate run转换旧版内容:所有文章或单篇文章。Free
wp pbs migrate status显示迁移状态。Free
wp pbs migrate undo从备份撤销转换:所有文章或单篇文章。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过滤器过滤管理端应用启动时加载的数据。高级版通过此过滤器报告其版本信息;由于数据会直接输出到页面中,请勿在此放置任何敏感信息。无免费版
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 功能(高级版会在此添加其功能名称:agent、site、block、design、image、css、a11y)。无免费版
pbsw_ai_seo_plugins过滤器过滤 AI SEO 助手向其写入 Meta 标题与描述的目标 SEO 插件列表。无免费版
pbsw_ai_seo_write过滤器过滤其他 SEO 插件是否已接管 Meta 标题和描述。通过 `pbsw_ai_seo_plugins` 添加的插件在此处以其自身方式保存它们,并返回 true。bool $written
string $plugin
int $post_id
string $title
string $description
免费版
pbsw_asset_sources过滤器所有前端资源:包含当前文件的资源、性能层通过 add_source() 注册的资源(单区块 CSS、视图模块),以及高级版通过 `pbsw_asset_sources` 为其自身添加的任意资源(其文件存放在仅高级版安装包附带的独立目录中)。仅接受插件内部的简单相对 `.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(高级版已启用该功能,d8)。bool $enabled免费版
pbsw_design_layout_suffix过滤器过滤区块的布局元素选择器后缀(” = 区块自身的元素)。string $suffix
string $prefix
免费版
pbsw_design_props过滤器过滤设计属性(高级版会在此添加自定义属性)。无免费版
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 $prefix免费版
pbsw_fs_loaded动作在许可 SDK 加载后触发(在主文件中,早于任何 Page Builder Sandwich 代码)。在此挂载以与 `pbsw_fs()` 通信。无免费版
pbsw_is_agency过滤器过滤此站点上是否提供 Agency 套餐的功能。bool $agency免费版
pbsw_is_pro过滤器过滤高级层是否正在运行。仅高级层会响应此项。bool $pro免费版
pbsw_kit_api_base过滤器过滤支持页面调用的 Zinn Digital® API 基础地址。string $base免费版
pbsw_kit_diagnostics过滤器在站点所有者查看之前过滤诊断信息。插件可在 `extra` 下添加其专属数据。⛔ 此项在预览之前运行,绝不会在预览和发送之间运行。无免费版
pbsw_kit_footprint_free过滤器过滤此站点是否免于追踪展示,从而绝不会在其中推广 Zinn® Ads。bool $footprint_free免费版
pbsw_kit_imported动作导入套件后触发。int $front免费版
pbsw_kit_promotions过滤器在解析推广注册表前对其进行过滤。添加一行以推广其他产品:`id`、`kind`(hosting|marketplace|platform|plugin|bundle|ads)、`slot`(promo|cross-sell),以及 `url` 或(针对插件)`name`、`site`、`main_files`。无免费版
pbsw_kit_tier过滤器过滤套件报告的此插件方案级别(测试和预发布环境;生产环境由许可证决定)。string $tier免费版
pbsw_lcp_fold过滤器内容向下多深算作首屏(从顶部起算的 CSS 像素值)。在其上方开始的区块被视为首屏线以上:其图像会预先加载,且最可能的 LCP 图像会获得 `fetchpriority=”high”`;在其下方的区块会延迟加载。若顶部横幅较大请调高,若页眉较紧凑请调低。int $fold免费版
pbsw_legacy_body_classes过滤器过滤旧版 body 类名。高级层在此添加旧版高级响应式类名(准则 5:该行为不包含在免费版插件中)。无免费版
pbsw_legacy_script_enqueued动作旧版文章已检查其前端行为(高级层会添加其专属行为)。int $post_id
string $content
string|null $handle
免费版
pbsw_library_token过滤器过滤随套件请求发送的 Bearer 令牌(由高级云端库提供)。string $token免费版
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 在此注册专属功能(仅当许可证允许运行高级版代码时,其引导程序才会挂载此项)。无免费版
pbsw_migration_batch_size过滤器单个后台迁移步骤转换的旧版(5.x)文章数量。每个步骤都是一个 Action Scheduler 动作;较小的批次适合运行缓慢或内存紧张的主机,较大的批次适合文章较多的高性能主机。小于 1 的值将视为 1。int $size免费版
pbsw_migration_post_types过滤器过滤旧版迁移转换的文章类型。list<string> $types免费版
pbsw_nav_menu_item_classesFilter过滤菜单项的类名(Pro 版菜单项选项会添加 `nav-menu__item–hide-mobile` 和 `–hide-desktop`)。仅保留 `nav-menu__item–<name>` 类名。int $depthFree
pbsw_nav_menu_item_labelFilter过滤菜单项的标签,内容为转义后的 HTML(Pro 版菜单项选项会添加图标、徽章和描述)。回调函数必须返回转义后的 HTML。string $label
int $depth
string $prefix
Free
pbsw_nav_menu_toggleFilter过滤“菜单”按钮的 HTML:Pro 版折叠栏设计器会将其置于包含徽标、搜索框、链接等的导航栏中(仅在菜单折叠时显示)。未完整保留原始按钮的结果将被忽略,以确保菜单绝不会丢失该按钮。string $toggle
string $prefix
Free
pbsw_newsletter_form_settingsFilter非 5.x 表单的设置(data-* ⇒ 属性值),或空数组。int $post_id
string $form
Free
pbsw_newsletter_providersFilter本站可供订阅的时事通讯服务列表:service ⇒ callable( string $email, array $settings ): array{ok: bool, message: string}。高级版层会添加 5.x 包含的三种服务。noneFree
pbsw_page_css_changedAction在文章的已编译样式表发生更改时触发(缓存插件会据此进行清除)。int $post_idFree
pbsw_page_css_enqueuedAction在页面的已编译样式表加入队列后触发(高级版关键 CSS 层在此挂载)。string $handle
int $post_id
Free
pbsw_page_css_extraFilter过滤在区块自身样式表之后追加到页面已编译样式表中的 CSS(pbs-p4:设计系统的 `.<prefix>-s-<id>` 规则)。此处已编译但未压缩:监听器应返回可直接输出的 CSS。string $extra
string $prefix
int $post_id
Free
pbsw_page_css_signatureFilter过滤决定编译状态是否为最新的其他要素(pbs-p4:断点)。string $extra
\WP_Post $post
Free
pbsw_page_css_stateFilter在文章的编译状态存储前对其进行过滤(pbs-p4 会记录样式表包含哪些设计规则,以避免渲染过滤器重复输出)。int $post_idFree
pbsw_permissionFilter过滤用户是否有权使用特定编辑器功能。免费版插件允许所有功能;Pro 版角色管理器则按角色分别响应。管理员应始终拥有权限。bool $allowed
string $what
int $user_id
Free
pbsw_popup_forceFilter无论定位目标如何,均在每个页面输出的弹窗(例如 Cookie 横幅)。nonePro
pbsw_replace_post_typesFilter过滤查找和替换功能默认搜索的文章类型。nonePro
pbsw_schema_skipFilter过滤 Page Builder Sandwich 略过的结构化数据类型(通常因为站点的 SEO 插件已为此页面输出了相应内容)。string $contentPro
pbsw_site_design_dataFilter过滤站点设计引导数据。高级版层会报告其版本并添加其小节所需的数据。noneFree
pbsw_site_design_depsFilter过滤站点设计资源包的依赖项。高级版层在此添加自己的脚本,以便在面板首次渲染前注册其小节。string $handleFree
pbsw_site_health_keep_revisionsFilter过滤清理时为每篇文章保留的最新修订版本数量(默认为 5)。int $keepPro
pbsw_style_at_rulesFilter过滤样式构建器在“样式 › 条件”下提供的 at 规则预设:形式为 `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` 动作中命名。noneFree
pbsw_style_at_rules_invalidAction在来自 `pbsw_style_at_rules` 的预设因无效而被丢弃时触发。noneFree
pbsw_template_content_locationFilter更具体的内容位置(WooCommerce:single_product、product_archive、cart…)。string $locationPro
pbsw_template_resolvedFilter为特定位置选定的模板。string $typePro
pbsw_template_typesFilter更多模板类型(WooCommerce 页面)。nonePro
pbsw_theme_builder_editor_dataFilter更多编辑器数据(动态数据源和字段插件,WooCommerce 相关组件)。无Pro
pbsw_theme_globals_savedAction此动作已在下方记录。无免费版
pbsw_transfer_importedAction在导入数据包后触发,以便重建由模板和设置生成的缓存(单页样式、全站样式表)。无免费版
pbsw_transfer_meta_keysFilter过滤导入和导出时随每个项目携带的文章元键(post meta keys)。无免费版
pbsw_transfer_optionsFilter过滤导入和导出可以在站点之间迁移的选项。仅接受以 `pbsw_` 开头的选项;其他所有选项都会被丢弃,因此数据包绝不会写入核心或第三方选项。无免费版
pbsw_transfer_post_typesFilter过滤导入和导出可以在站点之间迁移的文章类型。无免费版
pbsw_visitor_countryFilter针对通过其他方式(地理定位插件、会员资料)获知访客国家的站点,过滤用于年龄验证门和理性博彩提示的访客国家/地区。string $countryPro
pbsw_white_label_mapFilter过滤白标替换映射(源文本 => 显示文本)。无Pro