Desarrolladores
Referencia de funciones de Zinn® Cache
Zinn® Cache registra sus acciones en la WordPress Abilities API. Las mismas capacidades son herramientas MCP en el propio servidor del sitio y rutas REST bajo /wp-json/wp-abilities/v1. Esta página se genera a partir del propio registro del plugin.
Endpoints
MCP sobre HTTP (transmisible)
https://example.com/wp-json/zinn-cache/v1/mcpMCP sobre WP-CLI (entrada y salida estándar)
wp mcp-adapter serve --server=zinn-cache --user=<login>REST: listar las habilidades
/wp-json/wp-abilities/v1/abilities?category=zinn-cacheREST: ejecutar una habilidad
/wp-json/wp-abilities/v1/abilities/<name>/runAutenticación y permisos
Las solicitudes HTTP se autentican con una contraseña de aplicación de WordPress (HTTP Basic). Conectarse al servidor MCP requiere la capacidad que se muestra a continuación; cada función verifica luego su propio permiso, por objeto. Las funciones de solo lectura se ejecutan con GET y su entrada en la cadena de consulta; las demás con POST y un cuerpo JSON {«input»: {…}}.
Ejemplos
# REST: ejecutar una habilidad
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":{}}}Todas las capacidades
Generado a partir del archivo abilities.json del plugin, que a su vez se genera a partir de un sitio en ejecución; una prueba falla cuando ambos no coinciden.
| Capacidad | Qué hace | Edición | RESTO | Permiso | Parámetros |
|---|---|---|---|---|---|
zinn-cache/clean-databasezinn-cache-clean-database | Limpia la base de datos (Pro) Elimina en segundo plano los tipos de elementos innecesarios activados en los ajustes. Lo que se elimine no se puede recuperar. | Edición Pro | POST …/abilities/zinn-cache/clean-database/run | manage_options | Ninguno |
zinn-cache/convert-imageszinn-cache-convert-images | Convierte todas las imágenes existentes (Pro) Empieza a convertir en segundo plano las imágenes de la biblioteca de medios a los formatos modernos activados en los ajustes. | Edición Pro | POST …/abilities/zinn-cache/convert-images/run | manage_options | Ninguno |
zinn-cache/detect-cache-layerszinn-cache-detect-cache-layers | Detecta las cachés delante del sitio Solicita la página de inicio como lo haría un visitante y guarda qué cachés respondieron. Con sample: true también solicita las páginas más recientes dos veces y cuenta con qué frecuencia las sirvió cada capa desde su caché. | Edición 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 | Lee las analíticas de la caché (Pro) Devuelve la tasa de aciertos y el tráfico de la caché de objetos durante las últimas horas (horas, hasta 720), sus comandos más lentos y qué plugins fallan más en la caché. | Edición Pro | GET …/abilities/zinn-cache/get-cache-analytics/run | manage_options | hours: integer |
zinn-cache/get-cache-layerszinn-cache-get-cache-layers | Lee qué está almacenando el sitio en caché Muestra qué caché sirve las páginas (LiteSpeed, nginx, Varnish, Apache, Cloudflare o la caché de disco del plugin), lo que detectó la última comprobación, el tamaño de cada capa donde WordPress pueda leerlo, la cola de purga, la actualización programada y las purgas recientes. | Edición gratuita | GET …/abilities/zinn-cache/get-cache-layers/run | manage_options (the REST route's own check) | Ninguno |
zinn-cache/get-diagnosticszinn-cache-get-diagnostics | Lee el informe de diagnóstico Devuelve el informe de diagnóstico que solicita el soporte: versiones, límites del servidor, el estado de la caché y los errores recientes. No contiene contraseñas ni claves. | Edición gratuita | GET …/abilities/zinn-cache/get-diagnostics/run | manage_options | Ninguno |
zinn-cache/get-image-progresszinn-cache-get-image-progress | Lee el progreso de conversión de imágenes (Pro) Devuelve cuánto ha avanzado la conversión (o eliminación) de las imágenes. | Edición Pro | GET …/abilities/zinn-cache/get-image-progress/run | manage_options | Ninguno |
zinn-cache/get-pro-settingszinn-cache-get-pro-settings | Lee los ajustes de Cache Pro (Pro) Devuelve cada ajuste de Cache Pro (precarga, imágenes, scripts y estilos, limpieza de la base de datos, purga inteligente, el buscador). Los secretos nunca se devuelven. | Edición Pro | GET …/abilities/zinn-cache/get-pro-settings/run | manage_options | Ninguno |
zinn-cache/get-settingszinn-cache-get-settings | Lee los ajustes de la caché Devuelve cada ajuste de caché. La contraseña de Redis y el token de Cloudflare nunca se devuelven, solo si se ha guardado alguno. | Edición gratuita | GET …/abilities/zinn-cache/get-settings/run | manage_options | Ninguno |
zinn-cache/get-slow-querieszinn-cache-get-slow-queries | Lee el buscador de consultas lentas (Pro) Muestra las consultas de base de datos y las llamadas salientes más lentas que ha detectado el buscador, junto con el plugin o tema que realizó cada una. | Edición Pro | GET …/abilities/zinn-cache/get-slow-queries/run | manage_options | Ninguno |
zinn-cache/get-statuszinn-cache-get-status | Lee el estado de la caché Devuelve si la caché de páginas y la caché de objetos están activadas y funcionando, cuántas páginas están en caché y los números de conexión y aciertos de la caché de objetos. | Edición gratuita | GET …/abilities/zinn-cache/get-status/run | manage_options | Ninguno |
zinn-cache/get-warmup-progresszinn-cache-get-warmup-progress | Lee el progreso de calentamiento (Pro) Devuelve si el calentamiento se está ejecutando, cuántas páginas ha visitado y cuántas han fallado. | Edición Pro | GET …/abilities/zinn-cache/get-warmup-progress/run | manage_options | Ninguno |
zinn-cache/preview-database-cleanupzinn-cache-preview-database-cleanup | Vista previa de la limpieza de la base de datos (Pro) Cuenta lo que eliminaría una limpieza por tipo (revisiones, borradores, spam, datos temporales caducados y similares). No se elimina nada. | Edición Pro | GET …/abilities/zinn-cache/preview-database-cleanup/run | manage_options | Ninguno |
zinn-cache/purgezinn-cache-purge | Vaciar la caché Descarta páginas en caché: todo (all: true), algunas direcciones (urls) o todo lo etiquetado (tags). Las páginas se vuelven a generar a medida que llegan los visitantes. | Edición 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 | Limpia algunas direcciones en cada capa de caché Elimina estas direcciones (rutas como /about/ o direcciones completas en este sitio) a la vez de la caché de disco, la caché del servidor y Cloudflare, e indica qué respondió cada capa. | Edición gratuita | POST …/abilities/zinn-cache/purge-urls/run | manage_options (the REST route's own check) | urls: array (obligatorio) |
zinn-cache/refresh-cachezinn-cache-refresh-cache | Inicia o detén la actualización secuenciada action: start actualiza cada página por lotes por minuto (lo que hacen las actualizaciones en lugar de vaciar la caché); action: stop finaliza una actualización en curso. | Edición gratuita | POST …/abilities/zinn-cache/refresh-cache/run | manage_options (the REST route's own check) | action: start|stop (obligatorio) |
zinn-cache/remove-converted-imageszinn-cache-remove-converted-images | Eliminar todas las imágenes convertidas (Pro) Elimina en segundo plano cada copia convertida de las imágenes; los originales se conservan. | Edición Pro | POST …/abilities/zinn-cache/remove-converted-images/run | manage_options | Ninguno |
zinn-cache/reset-settingszinn-cache-reset-settings | Restablece los ajustes de caché a sus valores por defecto Restablece todos los ajustes de la caché a sus valores por defecto, tal como hace el botón «Restablecer». La contraseña guardada de Redis también se elimina. | Edición gratuita | POST …/abilities/zinn-cache/reset-settings/run | manage_options | Ninguno |
zinn-cache/reset-slow-querieszinn-cache-reset-slow-queries | Borra los hallazgos de consultas lentas (Pro) Olvida cada consulta lenta y llamada lenta encontrada hasta ahora, y el buscador se inicia de nuevo. | Edición Pro | POST …/abilities/zinn-cache/reset-slow-queries/run | manage_options | Ninguno |
zinn-cache/update-pro-settingszinn-cache-update-pro-settings | Cambia los ajustes de Cache Pro (Pro) Cambia los ajustes de Cache Pro que envíes (ajustes: clave a valor) y mantiene el resto. Cada valor se comprueba exactamente como en la pantalla de Cache Pro; si la clave es desconocida, se rechaza. | Edición Pro | POST …/abilities/zinn-cache/update-pro-settings/run | manage_options | settings: object (obligatorio) |
zinn-cache/update-settingszinn-cache-update-settings | Cambia los ajustes de la caché Cambia los ajustes que envíes y mantiene el resto (la caché de páginas, cuánto tiempo permanecen las páginas en caché, la caché de objetos y su conexión de Redis, las reglas de vaciado y las exclusiones). Los valores se comprueban y corrigen exactamente como en la pantalla Cache. | Edición 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 | Calentar la caché (Pro) Empieza a visitar cada página de los mapas del sitio en segundo plano para que los visitantes obtengan páginas almacenadas en caché. El progreso se notifica por separado mientras se ejecuta. | Edición Pro | POST …/abilities/zinn-cache/warm-cache/run | manage_options | Ninguno |
Comandos de WP-CLI
Ejecute estos comandos en el servidor con WP-CLI. Cada comando comprueba los mismos permisos que las pantallas del plugin; los ejemplos están tomados del propio texto de ayuda del plugin.
| Comando | Qué hace | Edición |
|---|---|---|
wp zinn-cache purge allwp zinn-cache purge all | Purgar todas las páginas en caché. | Edición gratuita |
wp zinn-cache purge post<id>...wp zinn-cache purge post 42 | Purgar las páginas de una entrada y las listas en las que aparece (página de inicio, archivos, fuentes). | Edición gratuita |
wp zinn-cache purge url<url>...wp zinn-cache purge url https://example.com/ /pricing/ | Purgue las páginas almacenadas en caché en estas URL. | Edición gratuita |
wp zinn-cache refresh<action>wp zinn-cache refresh status | Inicie, detenga o muestre la actualización gradual (lo que sustituye a «purgar todo» tras una actualización). | Edición gratuita |
wp zinn-cache server detectwp zinn-cache server detect | Compruebe qué cachés responden delante del sitio (nginx, Varnish, Apache, LiteSpeed, Cloudflare). | Edición gratuita |
wp zinn-cache server drainwp zinn-cache server drain | Envíe las purgas de caché del servidor en cola ahora en lugar de esperar a WP-Cron. | Edición gratuita |
wp zinn-cache status[--format=<format>]wp zinn-cache status --format=json | Informar sobre el estado de la caché de objetos. | Edición gratuita |
Acciones y filtros
Cada gancho que ofrece el plugin, con la descripción de su código fuente. Los filtros cambian un valor; las acciones permiten ejecutar código en un momento determinado; los puntos de entrada son acciones que se ejecutan para solicitar al plugin que realice una tarea.
| Webhook | Clase | Qué hace | Parámetros | Edición |
|---|---|---|---|---|
zinn_cache_control_header | Filtrar | Filtra el valor de cache-control enviado a LiteSpeed para una página almacenable en caché. | string $value, int $ttl | Edición gratuita |
zinn_cache_fs_loaded | Acción | Se dispara una vez que el SDK de licencias se ha cargado, antes del resto de Zinn® Cache. Conéctese aquí para interactuar con `zinn_cache_fs()`. | Ninguno | Edición gratuita |
zinn_cache_link_scan_post_types | Filtrar | Tipos de publicaciones que incluye el escaneo. | Ninguno | Edición gratuita |
zinn_cache_mcp_abilities | Acción | Se ejecuta después de que Zinn® Cache registra sus capacidades: Zinn® Cache Pro añade las suyas aquí. | Ninguno | Edición gratuita |
zinn_cache_post_change_tags | Filtrar | Filtra las etiquetas de caché que se purgan cuando cambia una entrada. | string[] $tags, int $post_id, string $post_type | Edición gratuita |
zinn_cache_purge_all | Acción | Borrar todo, desde la fila de Herramientas. | Ninguno | Edición gratuita |
zinn_cache_purge_hosts | Filtrar | Filtra los nombres de host que las purgas pueden designar (para un sitio servido en más de un dominio). | string[] $hosts | Edición gratuita |
zinn_cache_purge_on_seo_change | Filtrar | Filtra si un cambio realizado en Zinn® SEO purga las páginas que modificó. | bool $on | Edición gratuita |
zinn_cache_purge_plan | Punto de entrada (se inicia) | Borra exactamente lo que indica un plan: `do_action( 'zinn_cache_purge_plan', array( 'urls' => …, 'tags' => …, 'purge_all' => … ) )`. | Ninguno | Edición gratuita |
zinn_cache_purged | Acción | Se ejecuta después de que el complemento haya enviado una purga de caché. | array{purge_all:bool,urls:string[],tags:string[]} $plan | Edición gratuita |
zinn_cache_purged_all | Acción | Se ejecuta después de que se haya solicitado una purga completa de la caché de la página. | string $reason | Edición gratuita |
zinn_cache_refresh_armed | Acción | Se activa cuando comienza una actualización regulada. | string $reason | Edición gratuita |
zinn_cache_refresh_finished | Acción | Se activa cuando una actualización gradual ha llegado al final del sitio. | int $pages | Edición gratuita |
zinn_cache_refresh_guard | Filtrar | Filtra si la actualización debe pausarse este minuto (la protección de carga propia del host). | string $reason | Edición gratuita |
zinn_cache_refresh_urls | Filtrar | Filtra las direcciones que purga un lote de actualización; agregue aquí, por ejemplo, las direcciones de cada página en otros idiomas. | string[] $urls | Edición gratuita |
zinn_cache_refreshed_urls | Acción | Se activa después de purgar un lote de actualización (Zinn® Cache Pro vuelve a precargar estas páginas). | string[] $urls | Edición gratuita |
zinn_cache_request_cacheable | Filtrar | Filtra si la solicitud actual del front-end se puede servir desde la caché de páginas. | bool $cacheable | Edición gratuita |
zinn_cache_status_rows | Filtrar | Filtra las filas de la tabla «Qué está almacenando en caché este sitio» de la pantalla de estado. | array<int,array{0:string,1:string}> $rows, array<string,mixed> $report | Edición gratuita |
zinn_cache_ttl | Filtrar | Filtra el tiempo que se almacena en caché la página actual, en segundos. | int $ttl | Edición gratuita |