นักพัฒนา
ข้อมูลอ้างอิงความสามารถของ 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 และมีข้อมูลนำเข้าอยู่ในคิวรีสตริง ส่วนความสามารถอื่น ๆ จะทำงานด้วย 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-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) และปริมาณการรับส่งข้อมูลในช่วงชั่วโมงที่ผ่านมา (ชั่วโมง สูงสุดไม่เกิน 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 | อ่านสถานะแคช ส่งคืนสถานะว่าแคชของหน้าและแคชของอ็อบเจกต์เปิดใช้งานและทำงานอยู่หรือไม่ มีจำนวนหน้าที่แคชไว้กี่หน้า รวมถึงจำนวนการเชื่อมต่อและจำนวนฮิตของแคชของอ็อบเจกต์ | รุ่นฟรี | 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 กฎการล้างแคช และข้อยกเว้น) ค่าต่างๆ จะได้รับการตรวจสอบและแก้ไขอย่างถูกต้องเหมือนกับในหน้าจอแคช | รุ่นฟรี | 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 | กรอง | กรองว่าคำขอส่วนหน้าปัจจุบันสามารถให้บริการจากแคชของหน้าได้หรือไม่ | bool $cacheable | รุ่นฟรี |
zinn_cache_status_rows | กรอง | กรองแถวของตาราง «อะไรกำลังแคชไซต์นี้» บนหน้าจอสถานะ | array<int,array{0:string,1:string}> $rows, array<string,mixed> $report | รุ่นฟรี |
zinn_cache_ttl | กรอง | กรองระยะเวลาที่หน้าปัจจุบันถูกแคชไว้เป็นวินาที | int $ttl | รุ่นฟรี |