توسعه‌دهندگان

مرجع قابلیت‌های Zinn® Cache

Zinn® Cache کنش‌های خود را در API توانمندی‌های WordPress ثبت می‌کند. همین توانمندی‌ها ابزارهای MCP روی سرور خود سایت و مسیرهای REST در /wp-json/wp-abilities/v1 هستند. این صفحه از رجیستری خود افزونه تولید شده است.

راهنمای کاربر: اتصال یک برنامه هوش مصنوعی

⁦Zinn®⁩، وایکینگ ما، در حالی که یک دستیار هوش مصنوعی به ابزارهای پلتفرم متصل می‌شود، هلهله می‌کند.

نقاط پایانی

پروتکل کنترل مدل (MCP) روی HTTP (قابل پخش جریانی)

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

MCP از طریق WP-CLI (ورودی و خروجی استاندارد)

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) احراز هویت می‌شوند. اتصال به سرور 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-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)
نرخ اصابت (hit rate) و ترافیک حافظهٔ پنهان شیء (object cache) را برای ساعت‌های گذشته (ساعت، حداکثر تا ۷۲۰)، کندترین دستورهای آن، و اینکه کدام افزونه‌ها بیشترین عدم اصابت به حافظهٔ پنهان را دارند، برمی‌گرداند.
نسخه پرو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 هر صفحه را به صورت دسته‌ای در هر دقیقه تازه‌سازی می‌کند (آنچه به‌روزرسانی‌ها به جای خالی کردن حافظه پنهان انجام می‌دهند)؛ دستور 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فیلترمقدار 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نسخه رایگان