开发者

Zinn® Cache 功能参考

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

用户指南:连接人工智能应用

我们的维京人 Zinn® 在 AI 助手连接到平台工具时欢呼。

服务端点

通过 HTTP 的 MCP(可流式传输)

https://example.com/wp-json/zinn-cache/v1/mcp

通过 WP-CLI 的 MCP(标准输入和输出)

wp mcp-adapter serve --server=zinn-cache --user=<login>

REST:列出功能

/wp-json/wp-abilities/v1/abilities?category=zinn-cache

REST:运行能力

/wp-json/wp-abilities/v1/abilities/<name>/run

身份验证和权限

HTTP 请求使用 WordPress 应用程序密码(HTTP Basic)进行身份验证。连接到 MCP 服务器需要具备下方显示的权限;然后每个功能会根据每个对象检查其自身的权限。只读功能使用 GET 运行,其输入位于查询字符串中;其他功能使用 POST 和 JSON 主体 {"input": {…}} 运行。

示例

# REST:运行能力
curl -u your-username:your-application-password \
  "https://example.com/wp-json/wp-abilities/v1/abilities/zinn-cache/get-cache-layers/run"
# MCP (JSON-RPC over HTTP, after "initialize")
{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"zinn-cache-get-cache-layers","arguments":{}}}

所有功能

由插件的 abilities.json 生成,该文件本身由运行中的站点生成;当两者不一致时测试将失败。

权限功能说明版本剩余权限参数
zinn-cache/clean-database
zinn-cache-clean-database
清理数据库 (Pro)
在后台移除设置中开启的各类冗余内容。已移除的内容无法恢复。
专业版POST …/abilities/zinn-cache/clean-database/runmanage_options无
zinn-cache/convert-images
zinn-cache-convert-images
转换所有现有图像 (Pro)
在后台开始将媒体库中的图像转换为在设置中启用的现代格式。
专业版POST …/abilities/zinn-cache/convert-images/runmanage_options无
zinn-cache/detect-cache-layers
zinn-cache-detect-cache-layers
检测站点前方的缓存
像访客一样请求主页,并存储哪些缓存做出了响应。包含 sample: true 时,它还会对最新页面发起两次请求,并统计每个层从其缓存中提供这些页面的频率。
免费版POST …/abilities/zinn-cache/detect-cache-layers/runmanage_options (the REST route's own check)sample: boolean
zinn-cache/get-cache-analytics
zinn-cache-get-cache-analytics
阅读缓存分析 (Pro)
返回对象缓存最近几个小时(最长 720 小时)的命中率和流量、执行最慢的命令,以及未命中缓存次数最多的插件。
专业版GET …/abilities/zinn-cache/get-cache-analytics/runmanage_optionshours: integer
zinn-cache/get-cache-layers
zinn-cache-get-cache-layers
阅读正在缓存网站的内容
返回哪个缓存提供页面服务(LiteSpeed、nginx、Varnish、Apache、Cloudflare 或插件的磁盘缓存)、最后一次检测发现了什么、WordPress 可以读取的每一层的大小、清除队列、节奏刷新以及最近的清除。
免费版GET …/abilities/zinn-cache/get-cache-layers/runmanage_options (the REST route's own check)无
zinn-cache/get-diagnostics
zinn-cache-get-diagnostics
阅读诊断报告
返回支持团队所需的诊断报告:版本、服务器限制、缓存状态以及最近的错误。它不包含任何密码或密钥。
免费版GET …/abilities/zinn-cache/get-diagnostics/runmanage_options无
zinn-cache/get-image-progress
zinn-cache-get-image-progress
读取图像转换进度 (Pro)
返回图像转换(或移除)的进度。
专业版GET …/abilities/zinn-cache/get-image-progress/runmanage_options无
zinn-cache/get-pro-settings
zinn-cache-get-pro-settings
读取 Cache Pro 设置 (Pro)
返回所有 Cache Pro 设置(预热、图像、脚本和样式、数据库清理、智能清除、查找器)。绝不返回机密。
专业版GET …/abilities/zinn-cache/get-pro-settings/runmanage_options无
zinn-cache/get-settings
zinn-cache-get-settings
读取缓存设置
返回所有缓存设置。绝不会返回 Redis 密码和 Cloudflare 令牌,仅返回是否已保存。
免费版GET …/abilities/zinn-cache/get-settings/runmanage_options无
zinn-cache/get-slow-queries
zinn-cache-get-slow-queries
阅读慢查询查找器 (Pro)
返回探测器记录到的最慢数据库查询和外发调用,以及发起各项操作的插件或主题。
专业版GET …/abilities/zinn-cache/get-slow-queries/runmanage_options无
zinn-cache/get-status
zinn-cache-get-status
读取缓存状态
返回页面缓存与对象缓存是否开启且正常工作、已缓存的页面数量,以及对象缓存的连接数与命中数。
免费版GET …/abilities/zinn-cache/get-status/runmanage_options无
zinn-cache/get-warmup-progress
zinn-cache-get-warmup-progress
读取预热进度 (Pro)
返回预热是否正在运行、已访问了多少个页面以及失败了多少个页面。
专业版GET …/abilities/zinn-cache/get-warmup-progress/runmanage_options无
zinn-cache/preview-database-cleanup
zinn-cache-preview-database-cleanup
预览数据库清理 (Pro)
按类型统计清理操作将删除的内容(修订版本、草稿、垃圾内容、过期的临时数据等)。不会删除任何内容。
专业版GET …/abilities/zinn-cache/preview-database-cleanup/runmanage_options无
zinn-cache/purge
zinn-cache-purge
清除缓存
清除缓存页面:全部 (all: true)、部分地址 (urls) 或包含特定标签的所有内容 (tags)。页面将在访客访问时重新生成。
免费版POST …/abilities/zinn-cache/purge/runmanage_options (the REST route's own check)all: boolean, urls: array, tags: array
zinn-cache/purge-urls
zinn-cache-purge-urls
清除每个缓存层上的某些地址
同时从磁盘缓存、服务器缓存和 Cloudflare 中移除这些地址(诸如 /about/ 之类的路径或本站上的完整地址),并显示各层的响应内容。
免费版POST …/abilities/zinn-cache/purge-urls/runmanage_options (the REST route's own check)urls: array (必填)
zinn-cache/refresh-cache
zinn-cache-refresh-cache
启动或停止定速刷新
action: start 每分钟按批次刷新每个页面(更新所执行的操作,而不是清空缓存);action: stop 结束正在运行的刷新。
免费版POST …/abilities/zinn-cache/refresh-cache/runmanage_options (the REST route's own check)action: start|stop (必填)
zinn-cache/remove-converted-images
zinn-cache-remove-converted-images
删除所有转换后的图像 (Pro)
在后台删除图像的每个转换副本;保留原始图像。
专业版POST …/abilities/zinn-cache/remove-converted-images/runmanage_options无
zinn-cache/reset-settings
zinn-cache-reset-settings
将缓存设置恢复为默认值
将所有缓存设置恢复为默认值,效果与“重置”按钮相同。已保存的 Redis 密码也将被移除。
免费版POST …/abilities/zinn-cache/reset-settings/runmanage_options无
zinn-cache/reset-slow-queries
zinn-cache-reset-slow-queries
清除慢查询发现项 (Pro)
忘记迄今为止发现的所有慢查询和慢调用,查找器重新开始。
专业版POST …/abilities/zinn-cache/reset-slow-queries/runmanage_options无
zinn-cache/update-pro-settings
zinn-cache-update-pro-settings
更改 Cache Pro 设置 (Pro)
更改您发送的 Cache Pro 设置(设置:键到值)并保留其余设置。每个值都会像在 Cache Pro 屏幕上一样受到严格检查;未知的键将被拒绝。
专业版POST …/abilities/zinn-cache/update-pro-settings/runmanage_optionssettings: object (必填)
zinn-cache/update-settings
zinn-cache-update-settings
更改缓存设置
更改您发送的设置并保留其余设置(页面缓存、页面缓存保留时间、对象缓存及其 Redis 连接、清除规则和排除项)。系统会严格按照“缓存”屏幕上的方式检查并纠正这些值。
免费版POST …/abilities/zinn-cache/update-settings/runmanage_optionslscache_enabled: boolean, lscache_ttl: integer, object_cache_enabled: boolean, auto_purge_enabled: boolean, purge_on_upgrade: boolean, exclude_uris: array|object|string, exclude_query_keys: array|object|string, exclude_cookies: array|object|string, redis_host: string, redis_port: integer, redis_database: integer, redis_username: string, redis_password: string, redis_key_prefix: string, browser_ttl: integer, cache_logged_out_only: boolean, purge_on_comment: boolean, ttl_overrides: array|object|string, server_cache: string, server_cache_headers: boolean, nginx_purge_method: string, nginx_purge_endpoint: string, nginx_http_verb: string, nginx_purge_address: string, nginx_cache_path: string, nginx_cache_levels: string, nginx_cache_key: string, nginx_key_variants: array|object|string, nginx_spool_dir: string, varnish_host: string, varnish_port: integer, varnish_method: string, apache_cache_root: string, apache_dir_levels: integer, apache_dir_length: integer, cloudflare_enabled: boolean, cloudflare_zone_id: string, cloudflare_api_token: string, cloudflare_purge_everything: boolean, refresh_batch: integer, refresh_load_limit: integer, redis_serializer: string, heartbeat_mode: string, font_display_swap: boolean, preconnect_origins: array|object|string, cdn_url: string, cdn_exclude: array|object|string
zinn-cache/warm-cache
zinn-cache-warm-cache
预热缓存 (Pro)
开始在后台访问站点地图中的每个页面,以便访客获取缓存页面。运行期间会单独报告其进度。
专业版POST …/abilities/zinn-cache/warm-cache/runmanage_options无

WP-CLI 命令

在服务器上使用 WP-CLI 运行这些命令。每个命令都会检查与插件屏幕相同的权限;示例取自插件自身的帮助文本。

命令功能说明版本
wp zinn-cache purge all
wp zinn-cache purge all
清除每个缓存的页面。免费版
wp zinn-cache purge post
<id>...
wp zinn-cache purge post 42
清除文章的页面及其出现的列表(主页、归档、Feed)。免费版
wp zinn-cache purge url
<url>...
wp zinn-cache purge url https://example.com/ /pricing/
清除这些 URL 处缓存的页面。免费版
wp zinn-cache refresh
<action>
wp zinn-cache refresh status
启动、停止或显示平缓刷新(更新后取代“清除所有内容”的功能)。免费版
wp zinn-cache server detect
wp zinn-cache server detect
检查站点前端由哪些缓存响应(nginx、Varnish、Apache、LiteSpeed、Cloudflare)。免费版
wp zinn-cache server drain
wp zinn-cache server drain
立即发送排队的服务器缓存清除,而不是等待 WP-Cron。免费版
wp zinn-cache status
[--format=<format>]
wp zinn-cache status --format=json
报告对象缓存的状态。免费版

操作和筛选器

插件提供的每一个钩子,以及来自其源代码的描述。过滤器用于更改值;动作允许您在特定时刻运行代码;入口点是您触发以要求插件执行某些操作的动作。

钩子类型功能说明参数版本
zinn_cache_control_header筛选过滤发送给 LiteSpeed 的可缓存页面的 cache-control 值。string $value, int $ttl免费版
zinn_cache_fs_loaded操作在许可 SDK 加载后、Zinn® Cache 的其余部分加载前触发。在此钩子中与 `zinn_cache_fs()` 进行交互。无免费版
zinn_cache_link_scan_post_types筛选扫描所涵盖的文章类型。无免费版
zinn_cache_mcp_abilities操作Zinn® Cache 注册其功能后触发:Zinn® Cache Pro 在此处添加其自身功能。无免费版
zinn_cache_post_change_tags筛选过滤在文章更改时清除的缓存标记。string[] $tags, int $post_id, string $post_type免费版
zinn_cache_purge_all操作从“工具”行中清除所有内容。无免费版
zinn_cache_purge_hosts筛选过滤清除操作可能指定的各主机名(适用于在多个域名上提供服务的站点)。string[] $hosts免费版
zinn_cache_purge_on_seo_change筛选过滤在 Zinn® SEO 中所做的更改是否会清除其已更改的页面。bool $on免费版
zinn_cache_purge_plan入口点(您触发它)清除套餐指定的内容:`do_action( 'zinn_cache_purge_plan', array( 'urls' => …, 'tags' => …, 'purge_all' => … ) )`。无免费版
zinn_cache_purged操作在插件分派缓存清除后触发。array{purge_all:bool,urls:string[],tags:string[]} $plan免费版
zinn_cache_purged_all操作请求完全清除页面缓存后触发。string $reason免费版
zinn_cache_refresh_armed操作在按步调刷新开始时触发。string $reason免费版
zinn_cache_refresh_finished操作在定速刷新到达网站末尾时触发。int $pages免费版
zinn_cache_refresh_guard筛选过滤刷新是否应在这一分钟暂停(主机自有的负载保护)。string $reason免费版
zinn_cache_refresh_urls筛选过滤刷新批处理清除的地址 — 例如,在此处添加每个页面的其他语言地址。string[] $urls免费版
zinn_cache_refreshed_urls操作在清除刷新批次后触发(Zinn® Cache Pro 会再次预热这些页面)。string[] $urls免费版
zinn_cache_request_cacheable筛选过滤当前前端请求是否可以从页面缓存中提供服务。bool $cacheable免费版
zinn_cache_status_rows筛选筛选状态屏幕中“正在缓存此网站的内容”表格的行。array<int,array{0:string,1:string}> $rows, array<string,mixed> $report免费版
zinn_cache_ttl筛选过滤当前页面的缓存时间,以秒为单位。int $ttl免费版