توسعهدهندگان
مرجع قابلیتهای Zinn® Cache
Zinn® Cache کنشهای خود را در API توانمندیهای WordPress ثبت میکند. همین توانمندیها ابزارهای MCP روی سرور خود سایت و مسیرهای REST در /wp-json/wp-abilities/v1 هستند. این صفحه از رجیستری خود افزونه تولید شده است.
نقاط پایانی
پروتکل کنترل مدل (MCP) روی HTTP (قابل پخش جریانی)
https://example.com/wp-json/zinn-cache/v1/mcpMCP از طریق WP-CLI (ورودی و خروجی استاندارد)
wp mcp-adapter serve --server=zinn-cache --user=<login>REST: فهرست کردن قابلیتها
/wp-json/wp-abilities/v1/abilities?category=zinn-cacheREST: اجرای یک قابلیت
/wp-json/wp-abilities/v1/abilities/<name>/runاحراز هویت و دسترسیها
درخواستهای HTTP با یک گذرواژه برنامهای WordPress (پایهای HTTP) احراز هویت میشوند. اتصال به سرور MCP به قابلیت نشاندادهشده در زیر نیاز دارد؛ سپس هر توانایی، مجوز خود را به ازای هر شیء بررسی میکند. قابلیتهای فقطخواندنی با متد GET و ورودی خود در رشته پرسوجو (Query String) اجرا میشوند؛ سایر قابلیتها با متد 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-databasezinn-cache-clean-database | پاکسازی پایگاه داده (Pro) انواع موارد ناخواسته فعالشده در تنظیمات را در پسزمینه حذف میکند. آنچه حذف میشود قابل بازگردانی نیست. | نسخه پرو | POST …/abilities/zinn-cache/clean-database/run | manage_options | هیچکدام |
zinn-cache/convert-imageszinn-cache-convert-images | تبدیل تمام تصاویر موجود (Pro) تبدیل تصاویر کتابخانه پروندههای چندرسانهای به فرمتهای مدرن فعالشده در تنظیمات را در پسزمینه آغاز میکند. | نسخه پرو | POST …/abilities/zinn-cache/convert-images/run | manage_options | هیچکدام |
zinn-cache/detect-cache-layerszinn-cache-detect-cache-layers | شناسایی حافظههای پنهان مقابل سایت صفحهٔ اصلی را همانند یک بازدیدکننده درخواست میکند و پاسخدهی لایههای حافظهٔ پنهان را ذخیره مینماید. با sample: true، جدیدترین صفحهها را نیز دوبار درخواست کرده و تعداد دفعاتی را که هر لایه آنها را از حافظهٔ پنهان خود ارائه داده است، شمارش میکند. | نسخه رایگان | POST …/abilities/zinn-cache/detect-cache-layers/run | manage_options (the REST route's own check) | sample: boolean |
zinn-cache/get-cache-analyticszinn-cache-get-cache-analytics | تجزیه و تحلیل حافظه پنهان را بخوانید (Pro) نرخ اصابت (hit rate) و ترافیک حافظهٔ پنهان شیء (object cache) را برای ساعتهای گذشته (ساعت، حداکثر تا ۷۲۰)، کندترین دستورهای آن، و اینکه کدام افزونهها بیشترین عدم اصابت به حافظهٔ پنهان را دارند، برمیگرداند. | نسخه پرو | GET …/abilities/zinn-cache/get-cache-analytics/run | manage_options | hours: integer |
zinn-cache/get-cache-layerszinn-cache-get-cache-layers | بخوانید چه چیزی سایت را کش میکند نشان میدهد که کدام حافظهٔ پنهان صفحات را ارائه میدهد (LiteSpeed، nginx، Varnish، Apache، Cloudflare یا حافظهٔ پنهان دیسک افزونه)، آخرین شناسایی چه مواردی را یافته است، اندازهٔ هر لایه در جایی که WordPress میتواند آن را بخواند، صف پاکسازی، بازخوانی زمانبندیشده و پاکسازیهای اخیر. | نسخه رایگان | GET …/abilities/zinn-cache/get-cache-layers/run | manage_options (the REST route's own check) | هیچکدام |
zinn-cache/get-diagnosticszinn-cache-get-diagnostics | خواندن گزارش عیبیابی گزارش عیبیابی که پشتیبانی درخواست میکند را برمیگرداند: نسخهها، محدودیتهای سرور، وضعیت حافظه پنهان و خطاهای اخیر. هیچ گذرواژه یا کلیدی در آن وجود ندارد. | نسخه رایگان | GET …/abilities/zinn-cache/get-diagnostics/run | manage_options | هیچکدام |
zinn-cache/get-image-progresszinn-cache-get-image-progress | خواندن روند تبدیل تصویر (Pro) میزان پیشرفت تبدیل (یا حذف) تصاویر را برمیگرداند. | نسخه پرو | GET …/abilities/zinn-cache/get-image-progress/run | manage_options | هیچکدام |
zinn-cache/get-pro-settingszinn-cache-get-pro-settings | خواندن تنظیمات Cache Pro (Pro) همه تنظیمات Cache Pro (پیشگرمایش، تصاویر، اسکریپتها و شیوهنامهها، پاکسازی پایگاه داده، پاکسازی هوشمند، یابنده) را برمیگرداند. کلیدهای محرمانه هرگز بازگردانده نمیشوند. | نسخه پرو | GET …/abilities/zinn-cache/get-pro-settings/run | manage_options | هیچکدام |
zinn-cache/get-settingszinn-cache-get-settings | تنظیمات کش را بخوانید همه تنظیمات حافظه پنهان را برمیگرداند. گذرواژه Redis و نشانه Cloudflare هرگز برگردانده نمیشوند، فقط ذخیره بودن یا نبودن آنها برگردانده میشود. | نسخه رایگان | GET …/abilities/zinn-cache/get-settings/run | manage_options | هیچکدام |
zinn-cache/get-slow-querieszinn-cache-get-slow-queries | دربارهی یابندهی پرسوجوهای کُند بخوانید (Pro) کندترین پرسوجوهای پایگاه داده و فراخوانیهای خروجی ثبتشده توسط یابنده را به همراه افزونه یا پوستهای که هر یک را ایجاد کرده است، بازمیگرداند. | نسخه پرو | GET …/abilities/zinn-cache/get-slow-queries/run | manage_options | هیچکدام |
zinn-cache/get-statuszinn-cache-get-status | خواندن وضعیت حافظهٔ پنهان وضعیت فعال بودن و کارکرد حافظهٔ پنهان صفحه و شیء، تعداد صفحات ذخیرهشده در حافظهٔ پنهان و همچنین تعداد اتصالات و مراجعات موفق حافظهٔ پنهان شیء را بازمیگرداند. | نسخه رایگان | GET …/abilities/zinn-cache/get-status/run | manage_options | هیچکدام |
zinn-cache/get-warmup-progresszinn-cache-get-warmup-progress | پیشرفت گرم کردن را بخوانید (Pro) وضعیت در حال اجرا بودن پیشگرمایش، تعداد صفحات بازدید شده و تعداد موارد ناموفق را برمیگرداند. | نسخه پرو | GET …/abilities/zinn-cache/get-warmup-progress/run | manage_options | هیچکدام |
zinn-cache/preview-database-cleanupzinn-cache-preview-database-cleanup | پیشنمایش پاکسازی پایگاه داده (Pro) آنچه را که یک پاکسازی حذف میکند، بر اساس نوع میشمارد (رونوشتها، پیشنویسها، هرزنامهها، دادههای موقت منقضیشده و موارد مشابه). هیچ چیزی حذف نمیشود. | نسخه پرو | GET …/abilities/zinn-cache/preview-database-cleanup/run | manage_options | هیچکدام |
zinn-cache/purgezinn-cache-purge | پاکسازی حافظهٔ پنهان صفحههای ذخیرهشده در حافظه پنهان را دور میاندازد: همه چیز (all: true)، برخی آدرسها (urls) یا تمام موارد برچسبگذاریشده (tags). با ورود بازدیدکنندگان، صفحهها مجدداً ساخته میشوند. | نسخه رایگان | POST …/abilities/zinn-cache/purge/run | manage_options (the REST route's own check) | all: boolean, urls: array, tags: array |
zinn-cache/purge-urlszinn-cache-purge-urls | پاکسازی برخی نشانیها در هر لایه حافظه موقت این نشانیها (مسیرهایی مانند /about/ یا نشانیهای کامل در این سایت) را همزمان از حافظهٔ پنهان دیسک، حافظهٔ پنهان سرور و Cloudflare حذف میکند و بیان میکند که هر لایه چه پاسخی داده است. | نسخه رایگان | POST …/abilities/zinn-cache/purge-urls/run | manage_options (the REST route's own check) | urls: array (الزامی) |
zinn-cache/refresh-cachezinn-cache-refresh-cache | شروع یا توقف تازهسازی گامبهگام دستور action: start هر صفحه را به صورت دستهای در هر دقیقه تازهسازی میکند (آنچه بهروزرسانیها به جای خالی کردن حافظه پنهان انجام میدهند)؛ دستور action: stop به تازهسازیِ در حال اجرا پایان میدهد. | نسخه رایگان | POST …/abilities/zinn-cache/refresh-cache/run | manage_options (the REST route's own check) | action: start|stop (الزامی) |
zinn-cache/remove-converted-imageszinn-cache-remove-converted-images | حذف همه تصویرهای تبدیلشده (Pro) همهٔ رونوشتهای تبدیلشدهٔ تصاویر را در پسزمینه حذف میکند؛ پروندههای اصلی باقی میمانند. | نسخه پرو | POST …/abilities/zinn-cache/remove-converted-images/run | manage_options | هیچکدام |
zinn-cache/reset-settingszinn-cache-reset-settings | تنظیمات حافظه پنهان را به حالت پیشفرض بازگردانید همه تنظیمات حافظه پنهان را به حالت پیشفرض بازمیگرداند، درست مانند دکمه بازنشانی. گذرواژه ذخیرهشده Redis نیز حذف میشود. | نسخه رایگان | POST …/abilities/zinn-cache/reset-settings/run | manage_options | هیچکدام |
zinn-cache/reset-slow-querieszinn-cache-reset-slow-queries | پاک کردن یافتههای پرسوجوهای کند (Pro) هر پرسوجوی کند و فراخوانی کندی که تاکنون پیدا شده است را فراموش میکند و یابنده دوباره آغاز به کار میکند. | نسخه پرو | POST …/abilities/zinn-cache/reset-slow-queries/run | manage_options | هیچکدام |
zinn-cache/update-pro-settingszinn-cache-update-pro-settings | تغییر تنظیمات Cache Pro (Pro) تنظیمات Cache Pro را که ارسال میکنید تغییر میدهد (تنظیمات: کلید به مقدار) و بقیه را حفظ میکند. هر مقدار دقیقاً مانند صفحه Cache Pro بررسی میشود؛ کلید ناشناخته رد میشود. | نسخه پرو | POST …/abilities/zinn-cache/update-pro-settings/run | manage_options | settings: object (الزامی) |
zinn-cache/update-settingszinn-cache-update-settings | تغییر تنظیمات حافظهٔ پنهان تنظیماتی را که ارسال میکنید تغییر میدهد و بقیه را حفظ میکند (حافظهٔ پنهان صفحه، مدتزمان نگهداری صفحات در حافظهٔ پنهان، حافظهٔ پنهان اشیاء و اتصال Redis آن، قوانین پاکسازی و استثناها). مقادیر دقیقاً مانند صفحهٔ Cache بررسی و تصحیح میشوند. | نسخه رایگان | POST …/abilities/zinn-cache/update-settings/run | manage_options | lscache_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-cachezinn-cache-warm-cache | گرم کردن حافظهٔ پنهان (Pro) شروع به بازدید از هر صفحه در نقشههای سایت در پسزمینه میکند تا بازدیدکنندگان صفحات ذخیرهشده در حافظه پنهان را دریافت کنند. پیشرفت آن در حین اجرا به طور جداگانه گزارش میشود. | نسخه پرو | POST …/abilities/zinn-cache/warm-cache/run | manage_options | هیچکدام |
دستورات WP-CLI
این دستورات را روی سرور با WP-CLI اجرا کنید. هر دستور همان مجوزهای صفحات افزونه را بررسی میکند؛ مثالها از متن راهنمای خود افزونه گرفته شدهاند.
| دستور | کارکرد | ویرایش |
|---|---|---|
wp zinn-cache purge allwp 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 detectwp zinn-cache server detect | بررسی کنید که کدام کشها در جلوی سایت پاسخ میدهند (nginx، Varnish، Apache، LiteSpeed، Cloudflare). | نسخه رایگان |
wp zinn-cache server drainwp zinn-cache server drain | پاکسازیهای صفبندیشده حافظه پنهان سرور را بهجای انتظار برای WP-Cron، اکنون ارسال کنید. | نسخه رایگان |
wp zinn-cache status[--format=<format>]wp zinn-cache status --format=json | وضعیت کش شیء را گزارش دهید. | نسخه رایگان |
اقدامات و فیلترها
هر هوک ارائه شده توسط افزونه، همراه با توضیحات مندرج در کد منبع آن. فیلترها یک مقدار را تغییر میدهند؛ اکشنها به شما اجازه میدهند در یک لحظه کد اجرا کنید؛ نقاط ورودی اکشنهایی هستند که برای درخواست انجام کاری از افزونه اجرا میکنید.
| قلاب | نوع | کارکرد | پارامترها | ویرایش |
|---|---|---|---|---|
zinn_cache_control_header | فیلتر | مقدار cache-control ارسالشده به LiteSpeed را برای یک صفحه قابل کش فیلتر میکند. | 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 | نسخه رایگان |