Desenvolvedores
Referência de capacidades de Zinn® Cache
Zinn® Cache registra suas ações na WordPress Abilities API. As mesmas habilidades são ferramentas de MCP no próprio servidor do site e rotas REST em /wp-json/wp-abilities/v1. Esta página é gerada a partir do registro do próprio plugin.
Endpoints
MCP sobre HTTP (streaming)
https://example.com/wp-json/zinn-cache/v1/mcpMCP sobre WP-CLI (entrada e saída padrão)
wp mcp-adapter serve --server=zinn-cache --user=<login>REST: listar as habilidades
/wp-json/wp-abilities/v1/abilities?category=zinn-cacheREST: executar uma habilidade
/wp-json/wp-abilities/v1/abilities/<name>/runAutenticação e permissões
As solicitações HTTP autenticam-se com uma senha de aplicativo do WordPress (HTTP Basic). A conexão com o servidor MCP precisa do recurso mostrado abaixo; cada habilidade verifica então a sua própria permissão, por objeto. As habilidades somente leitura são executadas com GET e sua entrada na string de consulta; as demais, com POST e um corpo JSON {"input": {…}}.
Exemplos
# REST: executar uma habilidade
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":{}}}Todos os recursos
Gerado a partir do arquivo abilities.json do plugin, que por sua vez é gerado a partir de um site em execução; um teste falha quando os dois discordam.
| Recurso | O que faz | Edição | REST | Permissão | Parâmetros |
|---|---|---|---|---|---|
zinn-cache/clean-databasezinn-cache-clean-database | Limpar o banco de dados (Pro) Remove, em segundo plano, os tipos de itens desnecessários ativados nas configurações. O que for removido não pode ser recuperado. | Edição Pro | POST …/abilities/zinn-cache/clean-database/run | manage_options | nenhum |
zinn-cache/convert-imageszinn-cache-convert-images | Converter todas as imagens existentes (Pro) Inicia em segundo plano a conversão das imagens da biblioteca de mídia para os formatos modernos ativados nas configurações. | Edição Pro | POST …/abilities/zinn-cache/convert-images/run | manage_options | nenhum |
zinn-cache/detect-cache-layerszinn-cache-detect-cache-layers | Detectar os caches na frente do site Solicita a página inicial como um visitante faria e armazena quais caches responderam. Com sample: true, também solicita as páginas mais recentes duas vezes e conta com que frequência cada camada as forneceu a partir de seu cache. | Edição gratuita | 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 | Leia as análises do cache (Pro) Retorna a taxa de acertos e o tráfego do cache de objetos das últimas horas (horas, até 720), seus comandos mais lentos e quais plugins mais erram o cache. | Edição Pro | GET …/abilities/zinn-cache/get-cache-analytics/run | manage_options | hours: integer |
zinn-cache/get-cache-layerszinn-cache-get-cache-layers | Leia o que está armazenando o site em cache Retorna qual cache entrega as páginas (LiteSpeed, nginx, Varnish, Apache, Cloudflare ou o cache em disco do plugin), o que a última detecção identificou, o tamanho de cada camada onde o WordPress pode ler, a fila de limpeza, a atualização compassada e as limpezas recentes. | Edição gratuita | GET …/abilities/zinn-cache/get-cache-layers/run | manage_options (the REST route's own check) | nenhum |
zinn-cache/get-diagnosticszinn-cache-get-diagnostics | Leia o relatório de diagnóstico Retorna o relatório de diagnóstico solicitado pelo suporte: versões, limites do servidor, o estado do cache e erros recentes. Não contém senhas nem chaves. | Edição gratuita | GET …/abilities/zinn-cache/get-diagnostics/run | manage_options | nenhum |
zinn-cache/get-image-progresszinn-cache-get-image-progress | Leia o progresso da conversão de imagens (Pro) Retorna o quanto a conversão (ou remoção) das imagens avançou. | Edição Pro | GET …/abilities/zinn-cache/get-image-progress/run | manage_options | nenhum |
zinn-cache/get-pro-settingszinn-cache-get-pro-settings | Ler as configurações do Cache Pro (Pro) Retorna todas as configurações do Cache Pro (aquecimento, imagens, scripts e estilos, limpeza do banco de dados, limpeza inteligente, o localizador). As chaves secretas nunca são retornadas. | Edição Pro | GET …/abilities/zinn-cache/get-pro-settings/run | manage_options | nenhum |
zinn-cache/get-settingszinn-cache-get-settings | Ler as configurações de cache Retorna todas as configurações de cache. A senha do Redis e o token do Cloudflare nunca são retornados, apenas se estão salvos. | Edição gratuita | GET …/abilities/zinn-cache/get-settings/run | manage_options | nenhum |
zinn-cache/get-slow-querieszinn-cache-get-slow-queries | Leia o localizador de consultas lentas (Pro) Retorna as consultas de banco de dados e as chamadas externas mais lentas detectadas pelo localizador, junto com o plugin ou tema que realizou cada uma. | Edição Pro | GET …/abilities/zinn-cache/get-slow-queries/run | manage_options | nenhum |
zinn-cache/get-statuszinn-cache-get-status | Ler o status do cache Informa se o cache de página e o cache de objeto estão ativados e funcionando, quantas páginas estão em cache e os números de conexão e acessos do cache de objeto. | Edição gratuita | GET …/abilities/zinn-cache/get-status/run | manage_options | nenhum |
zinn-cache/get-warmup-progresszinn-cache-get-warmup-progress | Leia o progresso do aquecimento (Pro) Retorna se o aquecimento está em execução, quantas páginas visitou e quantas falharam. | Edição Pro | GET …/abilities/zinn-cache/get-warmup-progress/run | manage_options | nenhum |
zinn-cache/preview-database-cleanupzinn-cache-preview-database-cleanup | Pré-visualizar a limpeza do banco de dados (Pro) Conta o que uma limpeza removeria, por tipo (revisões, rascunhos, spam, dados temporários expirados e similares). Nada é removido. | Edição Pro | GET …/abilities/zinn-cache/preview-database-cleanup/run | manage_options | nenhum |
zinn-cache/purgezinn-cache-purge | Limpar o cache Descarta páginas em cache: tudo (all: true), alguns endereços (urls) ou tudo com tags (tags). As páginas são recriadas conforme os visitantes chegam. | Edição gratuita | 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 | Limpar alguns endereços em cada camada de cache Remove estes endereços (caminhos como /about/ ou endereços completos neste site) do cache de disco, do cache do servidor e do Cloudflare de uma só vez, e informa o que cada camada respondeu. | Edição gratuita | POST …/abilities/zinn-cache/purge-urls/run | manage_options (the REST route's own check) | urls: array (obrigatório) |
zinn-cache/refresh-cachezinn-cache-refresh-cache | Inicie ou pare a atualização compassada action: start atualiza cada página em um lote por minuto (o que as atualizações fazem em vez de esvaziar o cache); action: stop encerra uma atualização em andamento. | Edição gratuita | POST …/abilities/zinn-cache/refresh-cache/run | manage_options (the REST route's own check) | action: start|stop (obrigatório) |
zinn-cache/remove-converted-imageszinn-cache-remove-converted-images | Remover todas as imagens convertidas (Pro) Exclui em segundo plano todas as cópias convertidas das imagens; as originais permanecem. | Edição Pro | POST …/abilities/zinn-cache/remove-converted-images/run | manage_options | nenhum |
zinn-cache/reset-settingszinn-cache-reset-settings | Restaurar as configurações de cache para os padrões Restaura todas as configurações de cache para o padrão, assim como o botão Redefinir faz. A senha salva do Redis também é removida. | Edição gratuita | POST …/abilities/zinn-cache/reset-settings/run | manage_options | nenhum |
zinn-cache/reset-slow-querieszinn-cache-reset-slow-queries | Limpar as descobertas de consultas lentas (Pro) Esquece todas as consultas e chamadas lentas encontradas até agora, e o localizador é reiniciado. | Edição Pro | POST …/abilities/zinn-cache/reset-slow-queries/run | manage_options | nenhum |
zinn-cache/update-pro-settingszinn-cache-update-pro-settings | Alterar as configurações do Cache Pro (Pro) Altera as configurações do Cache Pro que você enviar (configurações: chave para valor) e mantém o restante. Cada valor é verificado exatamente como na tela do Cache Pro; uma chave desconhecida é recusada. | Edição Pro | POST …/abilities/zinn-cache/update-pro-settings/run | manage_options | settings: object (obrigatório) |
zinn-cache/update-settingszinn-cache-update-settings | Alterar as configurações de cache Altera as configurações que você envia e mantém as restantes (cache de página, tempo de permanência das páginas em cache, o cache de objetos e sua conexão com o Redis, regras de expurgo e exclusões). Os valores são verificados e corrigidos exatamente como na tela de Cache. | Edição gratuita | 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 | Aquecer o cache (Pro) Começa a visitar cada página nos mapas do site em segundo plano, para que os visitantes recebam páginas em cache. Seu progresso é relatado separadamente enquanto é executado. | Edição Pro | POST …/abilities/zinn-cache/warm-cache/run | manage_options | nenhum |
Comandos WP-CLI
Execute estes comandos no servidor com WP-CLI. Cada comando verifica as mesmas permissões que as telas do plugin; os exemplos foram extraídos do próprio texto de ajuda do plugin.
| Comando | O que faz | Edição |
|---|---|---|
wp zinn-cache purge allwp zinn-cache purge all | Limpar todas as páginas em cache. | Edição gratuita |
wp zinn-cache purge post<id>...wp zinn-cache purge post 42 | Limpar as páginas de um post e as listagens em que ele aparece (página inicial, arquivos, feeds). | Edição gratuita |
wp zinn-cache purge url<url>...wp zinn-cache purge url https://example.com/ /pricing/ | Limpe as páginas em cache nestes URLs. | Edição gratuita |
wp zinn-cache refresh<action>wp zinn-cache refresh status | Inicie, pare ou exiba a atualização compassada (o que substitui "purgar tudo" após uma atualização). | Edição gratuita |
wp zinn-cache server detectwp zinn-cache server detect | Verifique quais caches respondem à frente do site (nginx, Varnish, Apache, LiteSpeed, Cloudflare). | Edição gratuita |
wp zinn-cache server drainwp zinn-cache server drain | Envie as limpezas de cache do servidor enfileiradas agora em vez de esperar pelo WP-Cron. | Edição gratuita |
wp zinn-cache status[--format=<format>]wp zinn-cache status --format=json | Relatar o estado do cache de objetos. | Edição gratuita |
Ações e filtros
Cada hook que o plugin oferece, com a descrição do seu código-fonte. Os filtros alteram um valor; as ações permitem executar código em um determinado momento; os pontos de entrada são ações que você dispara para solicitar que o plugin faça algo.
| Webhook | Tipo | O que faz | Parâmetros | Edição |
|---|---|---|---|---|
zinn_cache_control_header | Filtrar | Filtra o valor de cache-control enviado para o LiteSpeed para uma página armazenável em cache. | string $value, int $ttl | Edição gratuita |
zinn_cache_fs_loaded | Ação | Dispersa assim que o SDK de licenciamento for carregado, antes do restante do Zinn® Cache. Conecte-se aqui para interagir com `zinn_cache_fs()`. | nenhum | Edição gratuita |
zinn_cache_link_scan_post_types | Filtrar | Tipos de post que a verificação abrange. | nenhum | Edição gratuita |
zinn_cache_mcp_abilities | Ação | Disparado após o Zinn® Cache registrar suas habilidades: o Zinn® Cache Pro adiciona as suas próprias aqui. | nenhum | Edição gratuita |
zinn_cache_post_change_tags | Filtrar | Filtra as tags de cache limpas quando um post é alterado. | string[] $tags, int $post_id, string $post_type | Edição gratuita |
zinn_cache_purge_all | Ação | Limpar tudo, a partir da linha Ferramentas. | nenhum | Edição gratuita |
zinn_cache_purge_hosts | Filtrar | Filtra os nomes de host que as limpezas podem indicar (para um site veiculado em mais de um domínio). | string[] $hosts | Edição gratuita |
zinn_cache_purge_on_seo_change | Filtrar | Filtra se uma alteração feita no Zinn® SEO limpa as páginas que ela alterou. | bool $on | Edição gratuita |
zinn_cache_purge_plan | Ponto de entrada (você o aciona) | Limpe exatamente o que um plano determina: `do_action( 'zinn_cache_purge_plan', array( 'urls' => …, 'tags' => …, 'purge_all' => … ) )`. | nenhum | Edição gratuita |
zinn_cache_purged | Ação | Dispara após o plugin acionar uma limpeza de cache. | array{purge_all:bool,urls:string[],tags:string[]} $plan | Edição gratuita |
zinn_cache_purged_all | Ação | Disparado após a solicitação de uma limpeza completa do cache da página. | string $reason | Edição gratuita |
zinn_cache_refresh_armed | Ação | É acionado quando uma atualização cadenciada é iniciada. | string $reason | Edição gratuita |
zinn_cache_refresh_finished | Ação | É acionado quando uma atualização cadenciada atinge o final do site. | int $pages | Edição gratuita |
zinn_cache_refresh_guard | Filtrar | Filtra se a atualização deve ser pausada neste minuto (a própria proteção de carga do host). | string $reason | Edição gratuita |
zinn_cache_refresh_urls | Filtrar | Filtra os endereços que um lote de atualização limpa — adicione aqui, por exemplo, os endereços de cada página em outros idiomas. | string[] $urls | Edição gratuita |
zinn_cache_refreshed_urls | Ação | Disparado após a limpeza de um lote de atualização (o Zinn® Cache Pro aquece essas páginas novamente). | string[] $urls | Edição gratuita |
zinn_cache_request_cacheable | Filtrar | Filtra se a solicitação atual de front-end pode ser atendida a partir do cache de página. | bool $cacheable | Edição gratuita |
zinn_cache_status_rows | Filtrar | Filtra as linhas da tabela «O que está armazenando este site em cache» da tela de status. | array<int,array{0:string,1:string}> $rows, array<string,mixed> $report | Edição gratuita |
zinn_cache_ttl | Filtrar | Filtra por quanto tempo a página atual é armazenada em cache, em segundos. | int $ttl | Edição gratuita |