開発者

Zinn® Cache 機能リファレンス

Zinn® Cache は、WordPress Abilities API にアクションを登録します。同じ能力は、サイト自体のサーバー上の MCP ツールであり、/wp-json/wp-abilities/v1 以下の REST ルートです。このページはプラグイン自体のレジストリから生成されます。

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

プラットフォームのツールにAIアシスタントが接続されるのを歓声で迎える、私たちのバイキング、Zinn®。

エンドポイント

MCP over HTTP (ストリーマブル)

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 から生成されます。これは稼働中のサイトからそれ自体が生成されるもので、両者が一致しない場合、テストは失敗します。

権限機能エディションREST権限パラメーター
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 を指定すると、最新のページも2回リクエストし、各レイヤーがキャッシュからそれらのページを提供した頻度をカウントします。
無料版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
すべてのキャッシュレイヤーで一部のアドレスをパージ
これらのアドレス (/about/ などのパス、またはこのサイトの完全なアドレス) をディスクキャッシュ、サーバーキャッシュ、および Cloudflare から一度に削除し、各層の応答内容を表示します。
無料版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 は毎分1バッチずつ各ページを更新します (キャッシュを空にする代わりに更新が行う処理です)。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 接続、パージルール、除外設定) はそのまま保持します。値は Cache 画面とまったく同様に検証および修正されます。
無料版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
投稿のページとそれが表示される一覧(ホームページ、アーカイブ、フィード)をパージします。無料版
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フィルター更新をこの1分間一時停止すべきかどうかをフィルタリングします (ホスト独自の負荷保護機能)。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無料版