מפתחים
הפניות ליכולות של Zinn® Cache
Zinn® Cache רושם את הפעולות שלו באמצעות ה-WordPress Abilities API. אותן יכולות הן כלי 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 Basic). התחברות לשרת ה-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) מסיר ברקע את סוגי העומס שהופעלו בהגדרות. מה שמוסר אינו ניתן לשחזור. | מהדורת Pro | POST …/abilities/zinn-cache/clean-database/run | manage_options | ללא |
zinn-cache/convert-imageszinn-cache-convert-images | המרת כל התמונות הקיימות (Pro) מתחיל בהמרת התמונות בספריית המדיה לתבניות המודרניות שמופעלות בהגדרות, ברקע. | מהדורת 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) עבור השעות האחרונות (שעות, עד 720), את הפקודות האיטיות ביותר שלו, ואילו תוספים מחטיאים את המטמון במידה הרבה ביותר. | מהדורת Pro | 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) מחזיר את מידת ההתקדמות של המרת (או הסרת) התמונות. | מהדורת 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 (חימום, תמונות, סקריפטים וסגנונות, ניקוי מסד נתונים, ניקוי חכם, האיתור). סודות לעולם אינם מוחזרים. | מהדורת 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) מחזיר את שאילתות מסד הנתונים והקריאות היוצאות האיטיות ביותר שהמאתר זיהה, בצירוף התוסף או התבנית שביצעו כל אחת מהן. | מהדורת Pro | GET …/abilities/zinn-cache/get-slow-queries/run | manage_options | ללא |
zinn-cache/get-statuszinn-cache-get-status | קריאת מצב המטמון מחזיר האם מטמון העמודים ומטמון האובייקטים פועלים ותקינים, כמה עמודים שמורים במטמון, ואת מספרי החיבורים והפגיעות (hits) של מטמון האובייקטים. | מהדורה חינמית | GET …/abilities/zinn-cache/get-status/run | manage_options | ללא |
zinn-cache/get-warmup-progresszinn-cache-get-warmup-progress | קרא את התקדמות החימום (Pro) מחזיר אם החימום פועל, בכמה עמודים הוא ביקר וכמה נכשלו. | מהדורת Pro | GET …/abilities/zinn-cache/get-warmup-progress/run | manage_options | ללא |
zinn-cache/preview-database-cleanupzinn-cache-preview-database-cleanup | תצוגה מקדימה של ניקוי מסד הנתונים (Pro) סופר מה יוסר בניקוי, לפי סוג (גרסאות, טיוטות, זבל, נתונים זמניים שפג תוקפם וכדומה). שום דבר אינו מוסר. | מהדורת 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) מוחק ברקע כל עותק שהומר של התמונות; קובצי המקור נשארים. | מהדורת 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) שוכח כל שאילתה איטית וקריאה איטית שנמצאו עד כה, והמוצא מתחיל מחדש. | מהדורת 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; מפתח לא מוכר נדחה. | מהדורת 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) מתחיל לבקר בכל עמוד במפות האתר ברקע, כדי שהמבקרים יקבלו עמודים שמורים במטמון. ההתקדמות מדווחת בנפרד בזמן הפעולה. | מהדורת 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 | סנן | מציג סינון בשאלה האם ניתן להגיש את בקשת ה-front-end הנוכחית מזיכרון המטמון של העמוד (page cache). | bool $cacheable | מהדורה חינמית |
zinn_cache_status_rows | סנן | מסנן את שורות הטבלה «מה שומר אתר זה במטמון» במסך המצב. | array<int,array{0:string,1:string}> $rows, array<string,mixed> $report | מהדורה חינמית |
zinn_cache_ttl | סנן | מסנן את משך הזמן שבו העמוד הנוכחי נשמר במטמון, בשניות. | int $ttl | מהדורה חינמית |