Nhà phát triển
Tài liệu tham khảo tính năng của Zinn® Cache
Zinn® Cache đăng ký các hành động của mình với WordPress Abilities API. Các khả năng tương tự là các công cụ MCP trên máy chủ riêng của trang web và các tuyến REST dưới /wp-json/wp-abilities/v1. Trang này được tạo từ sổ đăng ký của chính plugin.
Điểm cuối
MCP qua HTTP (có thể phát trực tuyến)
https://example.com/wp-json/zinn-cache/v1/mcpMCP qua WP-CLI (đầu vào và đầu ra chuẩn)
wp mcp-adapter serve --server=zinn-cache --user=<login>REST: liệt kê các khả năng
/wp-json/wp-abilities/v1/abilities?category=zinn-cacheREST: chạy một kỹ năng
/wp-json/wp-abilities/v1/abilities/<name>/runXác thực và quyền truy cập
Các yêu cầu HTTP được xác thực bằng mật khẩu ứng dụng WordPress (HTTP Basic). Việc kết nối với máy chủ MCP cần có khả năng hiển thị bên dưới; mọi tính năng sau đó sẽ kiểm tra quyền riêng của chính nó, theo từng đối tượng. Các tính năng chỉ đọc chạy với phương thức GET và đầu vào nằm trong chuỗi truy vấn; các tính năng còn lại chạy với phương thức POST và phần thân JSON {"input": {…}}.
Ví dụ
# REST: chạy một kỹ năng
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":{}}}Tất cả quyền hạn
Được tạo từ abilities.json của plugin, tệp này tự động được tạo từ một trang web đang chạy; một bài kiểm tra sẽ thất bại khi cả hai không khớp nhau.
| Quyền hạn | Chức năng | Phiên bản | REST | Quyền | Tham số |
|---|---|---|---|---|---|
zinn-cache/clean-databasezinn-cache-clean-database | Dọn dẹp cơ sở dữ liệu (Pro) Xóa trong nền các loại dữ liệu thừa được bật trong phần cài đặt. Những gì đã xóa không thể khôi phục lại. | Bản Pro | POST …/abilities/zinn-cache/clean-database/run | manage_options | không có |
zinn-cache/convert-imageszinn-cache-convert-images | Chuyển đổi tất cả hình ảnh hiện có (Pro) Bắt đầu chuyển đổi hình ảnh trong thư viện đa phương tiện sang các định dạng hiện đại được bật trong phần cài đặt, ở chế độ nền. | Bản Pro | POST …/abilities/zinn-cache/convert-images/run | manage_options | không có |
zinn-cache/detect-cache-layerszinn-cache-detect-cache-layers | Phát hiện các bộ nhớ đệm phía trước trang web Yêu cầu trang chủ như cách khách truy cập thực hiện và lưu lại bộ nhớ đệm nào đã phản hồi. Với sample: true, nó cũng yêu cầu các trang mới nhất hai lần và đếm tần suất mỗi lớp phân phát chúng từ bộ nhớ đệm của chính nó. | Bản miễn phí | 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 | Đọc số liệu phân tích bộ nhớ đệm (Pro) Trả về tỷ lệ trúng bộ nhớ đệm đối tượng và lưu lượng truy cập trong những giờ qua (số giờ, tối đa 720), các lệnh chậm nhất của nó, cùng các plugin bỏ lỡ bộ nhớ đệm nhiều nhất. | Bản Pro | GET …/abilities/zinn-cache/get-cache-analytics/run | manage_options | hours: integer |
zinn-cache/get-cache-layerszinn-cache-get-cache-layers | Đọc những gì đang lưu vào bộ nhớ tạm của trang web Trả về bộ nhớ đệm nào phân phối các trang (LiteSpeed, nginx, Varnish, Apache, Cloudflare hoặc bộ nhớ đệm trên đĩa của tiện ích mở rộng), kết quả phát hiện gần đây nhất, kích thước của từng lớp nơi WordPress có thể đọc được, hàng đợi làm sạch, quá trình làm mới có điều tiết và các lần làm sạch gần đây. | Bản miễn phí | GET …/abilities/zinn-cache/get-cache-layers/run | manage_options (the REST route's own check) | không có |
zinn-cache/get-diagnosticszinn-cache-get-diagnostics | Đọc báo cáo chẩn đoán Trả về báo cáo chẩn đoán mà bộ phận hỗ trợ yêu cầu: các phiên bản, giới hạn máy chủ, trạng thái bộ nhớ đệm và các lỗi gần đây. Báo cáo không chứa bất kỳ mật khẩu hoặc khóa nào. | Bản miễn phí | GET …/abilities/zinn-cache/get-diagnostics/run | manage_options | không có |
zinn-cache/get-image-progresszinn-cache-get-image-progress | Đọc tiến trình chuyển đổi hình ảnh (Pro) Trả về mức độ tiến triển của việc chuyển đổi (hoặc xóa) hình ảnh. | Bản Pro | GET …/abilities/zinn-cache/get-image-progress/run | manage_options | không có |
zinn-cache/get-pro-settingszinn-cache-get-pro-settings | Đọc cài đặt Cache Pro (Pro) Trả về mọi cài đặt Cache Pro (làm ấm, hình ảnh, tập lệnh và kiểu dáng, dọn dẹp cơ sở dữ liệu, xóa thông minh, công cụ tìm kiếm). Các thông tin bí mật không bao giờ được trả về. | Bản Pro | GET …/abilities/zinn-cache/get-pro-settings/run | manage_options | không có |
zinn-cache/get-settingszinn-cache-get-settings | Đọc cài đặt bộ nhớ đệm Trả về mọi cài đặt bộ nhớ đệm. Mật khẩu Redis và mã thông báo Cloudflare không bao giờ được trả về, chỉ trả về trạng thái đã lưu hay chưa. | Bản miễn phí | GET …/abilities/zinn-cache/get-settings/run | manage_options | không có |
zinn-cache/get-slow-querieszinn-cache-get-slow-queries | Đọc trình tìm kiếm truy vấn chậm (Pro) Trả về các truy vấn cơ sở dữ liệu và cuộc gọi gửi đi chậm nhất mà bộ tìm kiếm đã phát hiện, cùng với plugin hoặc giao diện đã tạo ra từng yêu cầu đó. | Bản Pro | GET …/abilities/zinn-cache/get-slow-queries/run | manage_options | không có |
zinn-cache/get-statuszinn-cache-get-status | Đọc trạng thái bộ nhớ đệm Trả về trạng thái bật và hoạt động của bộ nhớ đệm trang và bộ nhớ đệm đối tượng, số lượng trang được lưu trong bộ nhớ đệm, cũng như số lượng kết nối và lượt truy cập của bộ nhớ đệm đối tượng. | Bản miễn phí | GET …/abilities/zinn-cache/get-status/run | manage_options | không có |
zinn-cache/get-warmup-progresszinn-cache-get-warmup-progress | Đọc tiến trình làm nóng (Pro) Trả về trạng thái khởi động có đang chạy hay không, đã truy cập bao nhiêu trang và bao nhiêu trang bị lỗi. | Bản Pro | GET …/abilities/zinn-cache/get-warmup-progress/run | manage_options | không có |
zinn-cache/preview-database-cleanupzinn-cache-preview-database-cleanup | Xem trước dọn dẹp cơ sở dữ liệu (Pro) Đếm những gì việc dọn dẹp sẽ xóa, theo từng loại (các bản sửa đổi, bản nháp, thư rác, dữ liệu tạm thời đã hết hạn và những thứ tương tự). Không có gì bị xóa. | Bản Pro | GET …/abilities/zinn-cache/preview-database-cleanup/run | manage_options | không có |
zinn-cache/purgezinn-cache-purge | Xóa bộ nhớ đệm Hủy bỏ các trang đã lưu trong bộ nhớ đệm: tất cả (all: true), một số địa chỉ (urls) hoặc mọi thứ được gắn thẻ (tags). Các trang sẽ được tạo lại khi có khách truy cập. | Bản miễn phí | 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 | Xóa một số địa chỉ trên mỗi lớp bộ nhớ đệm Xóa các địa chỉ này (các đường dẫn như /about/ hoặc địa chỉ đầy đủ trên trang web này) khỏi bộ nhớ đệm đĩa, bộ nhớ đệm máy chủ và Cloudflare cùng một lúc, đồng thời cho biết phản hồi của từng lớp. | Bản miễn phí | POST …/abilities/zinn-cache/purge-urls/run | manage_options (the REST route's own check) | urls: array (Bắt buộc) |
zinn-cache/refresh-cachezinn-cache-refresh-cache | Bắt đầu hoặc dừng làm mới theo tiến độ action: start làm mới mỗi trang theo từng đợt mỗi phút (điều mà các bản cập nhật thực hiện thay vì xóa bộ nhớ đệm); action: stop chấm dứt quá trình làm mới đang chạy. | Bản miễn phí | POST …/abilities/zinn-cache/refresh-cache/run | manage_options (the REST route's own check) | action: start|stop (Bắt buộc) |
zinn-cache/remove-converted-imageszinn-cache-remove-converted-images | Xóa tất cả hình ảnh đã chuyển đổi (Pro) Xóa từng bản sao đã chuyển đổi của hình ảnh trong nền; các bản gốc vẫn được giữ lại. | Bản Pro | POST …/abilities/zinn-cache/remove-converted-images/run | manage_options | không có |
zinn-cache/reset-settingszinn-cache-reset-settings | Khôi phục cài đặt bộ nhớ đệm về mặc định Đưa mọi cài đặt bộ nhớ đệm về mặc định, tương tự như nút Đặt lại. Mật khẩu Redis đã lưu cũng bị xóa. | Bản miễn phí | POST …/abilities/zinn-cache/reset-settings/run | manage_options | không có |
zinn-cache/reset-slow-querieszinn-cache-reset-slow-queries | Xóa các kết quả truy vấn chậm (Pro) Quên mọi truy vấn chậm và lệnh gọi chậm được tìm thấy cho đến nay, và công cụ tìm kiếm bắt đầu lại. | Bản Pro | POST …/abilities/zinn-cache/reset-slow-queries/run | manage_options | không có |
zinn-cache/update-pro-settingszinn-cache-update-pro-settings | Thay đổi cài đặt Cache Pro (Pro) Thay đổi cài đặt Cache Pro bạn gửi (cài đặt: khóa thành giá trị) và giữ nguyên phần còn lại. Mỗi giá trị được kiểm tra chính xác như trên màn hình Cache Pro; khóa không xác định sẽ bị từ chối. | Bản Pro | POST …/abilities/zinn-cache/update-pro-settings/run | manage_options | settings: object (Bắt buộc) |
zinn-cache/update-settingszinn-cache-update-settings | Thay đổi cài đặt bộ nhớ đệm Thay đổi các cài đặt bạn gửi và giữ nguyên phần còn lại (bộ nhớ đệm trang, thời gian các trang được lưu trong bộ nhớ đệm, bộ nhớ đệm đối tượng và kết nối Redis của nó, các quy tắc xóa bộ nhớ đệm và các trường hợp loại trừ). Các giá trị được kiểm tra và chỉnh sửa chính xác như trên màn hình Bộ nhớ đệm. | Bản miễn phí | 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 | Làm ấm bộ nhớ đệm (Pro) Bắt đầu truy cập từng trang trong sơ đồ trang web dưới nền, để khách truy cập nhận được các trang đã lưu trong bộ nhớ đệm. Tiến trình của nó được báo cáo riêng trong khi chạy. | Bản Pro | POST …/abilities/zinn-cache/warm-cache/run | manage_options | không có |
Lệnh WP-CLI
Chạy các lệnh này trên máy chủ bằng WP-CLI. Mỗi lệnh kiểm tra các quyền tương tự như các màn hình của plugin; các ví dụ được lấy từ chính văn bản trợ giúp của plugin.
| Lệnh | Chức năng | Phiên bản |
|---|---|---|
wp zinn-cache purge allwp zinn-cache purge all | Xóa mọi trang đã lưu trong bộ nhớ đệm. | Bản miễn phí |
wp zinn-cache purge post<id>...wp zinn-cache purge post 42 | Xóa bộ nhớ đệm các trang của bài viết và danh sách nơi bài viết xuất hiện (trang chủ, lưu trữ, nguồn cấp dữ liệu). | Bản miễn phí |
wp zinn-cache purge url<url>...wp zinn-cache purge url https://example.com/ /pricing/ | Xóa các trang được lưu trong bộ nhớ cache tại các URL này. | Bản miễn phí |
wp zinn-cache refresh<action>wp zinn-cache refresh status | Bắt đầu, dừng hoặc hiển thị làm mới theo nhịp độ (tính năng thay thế "xóa sạch tất cả" sau khi cập nhật). | Bản miễn phí |
wp zinn-cache server detectwp zinn-cache server detect | Kiểm tra bộ nhớ đệm nào phản hồi phía trước trang web (nginx, Varnish, Apache, LiteSpeed, Cloudflare). | Bản miễn phí |
wp zinn-cache server drainwp zinn-cache server drain | Gửi các lệnh dọn sạch bộ nhớ đệm máy chủ trong hàng đợi ngay bây giờ thay vì đợi WP-Cron. | Bản miễn phí |
wp zinn-cache status[--format=<format>]wp zinn-cache status --format=json | Báo cáo trạng thái bộ đệm đối tượng. | Bản miễn phí |
Thao tác và bộ lọc
Mọi hook mà plugin cung cấp, kèm theo mô tả từ mã nguồn của nó. Các bộ lọc thay đổi một giá trị; các hành động cho phép bạn chạy mã tại một thời điểm; các điểm truy cập là các hành động bạn kích hoạt để yêu cầu plugin thực hiện một việc gì đó.
| Webhook | Loại | Chức năng | Tham số | Phiên bản |
|---|---|---|---|---|
zinn_cache_control_header | Lọc | Lọc giá trị điều khiển bộ nhớ đệm được gửi đến LiteSpeed cho một trang có thể lưu vào bộ nhớ đệm. | string $value, int $ttl | Bản miễn phí |
zinn_cache_fs_loaded | Hành động | Được kích hoạt sau khi SDK cấp phép đã tải, trước phần còn lại của Zinn® Cache. Hãy gắn móc (hook) tại đây để tương tác với `zinn_cache_fs()`. | không có | Bản miễn phí |
zinn_cache_link_scan_post_types | Lọc | Các loại bài viết mà quá trình quét bao phủ. | không có | Bản miễn phí |
zinn_cache_mcp_abilities | Hành động | Sự kiện kích hoạt sau khi Zinn® Cache đăng ký các tính năng của mình: Zinn® Cache Pro sẽ thêm các tính năng của riêng nó vào đây. | không có | Bản miễn phí |
zinn_cache_post_change_tags | Lọc | Lọc các thẻ bộ đệm bị xóa khi một bài viết thay đổi. | string[] $tags, int $post_id, string $post_type | Bản miễn phí |
zinn_cache_purge_all | Hành động | Xóa mọi thứ, từ hàng Công cụ. | không có | Bản miễn phí |
zinn_cache_purge_hosts | Lọc | Lọc các tên máy chủ mà các thao tác dọn dẹp có thể chỉ định (cho một trang web được phân phát trên nhiều tên miền). | string[] $hosts | Bản miễn phí |
zinn_cache_purge_on_seo_change | Lọc | Lọc xem thay đổi được thực hiện trong Zinn® SEO có xóa các trang mà nó đã thay đổi hay không. | bool $on | Bản miễn phí |
zinn_cache_purge_plan | Điểm vào (bạn kích hoạt nó) | Xóa chính xác những gì gói dịch vụ chỉ định: `do_action( 'zinn_cache_purge_plan', array( 'urls' => …, 'tags' => …, 'purge_all' => … ) )`. | không có | Bản miễn phí |
zinn_cache_purged | Hành động | Được kích hoạt sau khi plugin đã tiến hành xóa bộ nhớ đệm. | array{purge_all:bool,urls:string[],tags:string[]} $plan | Bản miễn phí |
zinn_cache_purged_all | Hành động | Kích hoạt sau khi yêu cầu xóa toàn bộ bộ nhớ đệm trang. | string $reason | Bản miễn phí |
zinn_cache_refresh_armed | Hành động | Kích hoạt khi bắt đầu quá trình làm mới có nhịp độ. | string $reason | Bản miễn phí |
zinn_cache_refresh_finished | Hành động | Kích hoạt khi quá trình làm mới có nhịp độ đã đến cuối trang web. | int $pages | Bản miễn phí |
zinn_cache_refresh_guard | Lọc | Lọc xem việc làm mới có nên tạm dừng trong phút này hay không (tính năng bảo vệ tải của chính máy chủ). | string $reason | Bản miễn phí |
zinn_cache_refresh_urls | Lọc | Lọc các địa chỉ mà một đợt làm mới xóa sạch — ví dụ: thêm các địa chỉ ngôn ngữ khác của mỗi trang vào đây. | string[] $urls | Bản miễn phí |
zinn_cache_refreshed_urls | Hành động | Kích hoạt sau khi làm sạch một đợt làm mới (Zinn® Cache Pro làm nóng lại các trang này). | string[] $urls | Bản miễn phí |
zinn_cache_request_cacheable | Lọc | Lọc xem yêu cầu giao diện hiện tại có thể được phục vụ từ bộ nhớ đệm của trang hay không. | bool $cacheable | Bản miễn phí |
zinn_cache_status_rows | Lọc | Lọc các hàng trong bảng «Điều gì đang lưu vào bộ nhớ đệm trang web này» của màn hình trạng thái. | array<int,array{0:string,1:string}> $rows, array<string,mixed> $report | Bản miễn phí |
zinn_cache_ttl | Lọc | Lọc thời gian trang hiện tại được lưu bộ nhớ đệm, tính bằng giây. | int $ttl | Bản miễn phí |