Développeurs
Référence des fonctionnalités de Zinn® Cache
Zinn® Cache enregistre ses actions auprès de l’API WordPress Abilities. Ces mêmes capacités sont des outils MCP sur le propre serveur du site et des routes REST sous /wp-json/wp-abilities/v1. Cette page est générée à partir du propre registre du plugin.
Points de terminaison
MCP sur HTTP (diffusible en continu)
https://example.com/wp-json/zinn-cache/v1/mcpMCP sur WP-CLI (entrée et sortie standard)
wp mcp-adapter serve --server=zinn-cache --user=<login>REST : lister les capacités
/wp-json/wp-abilities/v1/abilities?category=zinn-cacheREST : exécuter une capacité
/wp-json/wp-abilities/v1/abilities/<name>/runAuthentification et autorisations
Les requêtes HTTP s’authentifient à l’aide d’un mot de passe d’application WordPress (HTTP Basic). La connexion au serveur MCP nécessite la capacité indiquée ci-dessous ; chaque fonctionnalité vérifie ensuite sa propre autorisation, par objet. Les fonctionnalités en lecture seule s’exécutent avec GET et leur entrée dans la chaîne de requête ; les autres avec POST et un corps JSON {« input » : {…}}.
Exemples
# REST : exécuter une capacité
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":{}}}Toutes les capacités
Généré à partir du fichier abilities.json du plugin, qui est lui-même généré à partir d’un site en cours d’exécution ; un test échoue lorsque les deux ne correspondent pas.
| Capacité | Son rôle | Édition | Repos | Autorisation | Paramètres |
|---|---|---|---|---|---|
zinn-cache/clean-databasezinn-cache-clean-database | Nettoyer la base de données (Pro) Supprime en arrière-plan les types d’éléments encombrants activés dans les réglages. Ce qui est supprimé ne peut pas être récupéré. | Édition Pro | POST …/abilities/zinn-cache/clean-database/run | manage_options | Aucun |
zinn-cache/convert-imageszinn-cache-convert-images | Convertir toutes les images existantes (Pro) Démarre en arrière-plan la conversion des images de la médiathèque vers les formats modernes activés dans les réglages. | Édition Pro | POST …/abilities/zinn-cache/convert-images/run | manage_options | Aucun |
zinn-cache/detect-cache-layerszinn-cache-detect-cache-layers | Détecter les caches en amont du site Demande la page d’accueil comme le ferait un visiteur et enregistre les caches qui ont répondu. Avec sample : true, elle demande également deux fois les pages les plus récentes et compte combien de fois chaque couche les a servies depuis son cache. | Édition gratuite | 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 | Consultez les analyses du cache (Pro) Renvoie le taux de réussite et le trafic du cache d’objets pour les dernières heures (heures, jusqu’à 720), ses commandes les plus lentes, ainsi que les extensions qui manquent le plus le cache. | Édition Pro | GET …/abilities/zinn-cache/get-cache-analytics/run | manage_options | hours: integer |
zinn-cache/get-cache-layerszinn-cache-get-cache-layers | Découvrez ce qui met le site en cache Indique quel cache distribue les pages (LiteSpeed, nginx, Varnish, Apache, Cloudflare ou le cache disque de l’extension), ce que la dernière détection a identifié, la taille de chaque couche là où WordPress peut la lire, la file d’attente de purge, le rafraîchissement cadencé et les purges récentes. | Édition gratuite | GET …/abilities/zinn-cache/get-cache-layers/run | manage_options (the REST route's own check) | Aucun |
zinn-cache/get-diagnosticszinn-cache-get-diagnostics | Consulter le rapport de diagnostic Renvoie le rapport de diagnostic demandé par l’assistance : versions, limites du serveur, état du cache et erreurs récentes. Il ne contient aucun mot de passe ni aucune clé. | Édition gratuite | GET …/abilities/zinn-cache/get-diagnostics/run | manage_options | Aucun |
zinn-cache/get-image-progresszinn-cache-get-image-progress | Lire la progression de la conversion de l’image (Pro) Renvoie l’état d’avancement de la conversion (ou de la suppression) des images. | Édition Pro | GET …/abilities/zinn-cache/get-image-progress/run | manage_options | Aucun |
zinn-cache/get-pro-settingszinn-cache-get-pro-settings | Lire les réglages de Cache Pro (Pro) Renvoie chaque réglage de Cache Pro (préchauffage, images, scripts et styles, nettoyage de la base de données, purge intelligente, l’outil de recherche). Les secrets ne sont jamais renvoyés. | Édition Pro | GET …/abilities/zinn-cache/get-pro-settings/run | manage_options | Aucun |
zinn-cache/get-settingszinn-cache-get-settings | Lire les réglages du cache Renvoie tous les réglages du cache. Le mot de passe Redis et le jeton Cloudflare ne sont jamais renvoyés, seule la confirmation qu’ils sont enregistrés l’est. | Édition gratuite | GET …/abilities/zinn-cache/get-settings/run | manage_options | Aucun |
zinn-cache/get-slow-querieszinn-cache-get-slow-queries | Lisez l’article sur l’outil de détection des requêtes lentes (Pro) Renvoie les requêtes de base de données et les appels sortants les plus lents détectés par l’outil de recherche, accompagnés de l’extension ou du thème à l’origine de chacun d’eux. | Édition Pro | GET …/abilities/zinn-cache/get-slow-queries/run | manage_options | Aucun |
zinn-cache/get-statuszinn-cache-get-status | Lire l’état du cache Indique si le cache de page et le cache d’objet sont activés et opérationnels, combien de pages sont en cache, ainsi que le nombre de connexions et de succès du cache d’objet. | Édition gratuite | GET …/abilities/zinn-cache/get-status/run | manage_options | Aucun |
zinn-cache/get-warmup-progresszinn-cache-get-warmup-progress | Lire la progression de l’échauffement (Pro) Indique si le préchauffage est en cours d’exécution, combien de pages il a visitées et combien ont échoué. | Édition Pro | GET …/abilities/zinn-cache/get-warmup-progress/run | manage_options | Aucun |
zinn-cache/preview-database-cleanupzinn-cache-preview-database-cleanup | Aperçu du nettoyage de la base de données (Pro) Compte ce qu’un nettoyage supprimerait, par type (révisions, brouillons, indésirables, données temporaires expirées et similaires). Rien n’est supprimé. | Édition Pro | GET …/abilities/zinn-cache/preview-database-cleanup/run | manage_options | Aucun |
zinn-cache/purgezinn-cache-purge | Purger le cache Supprime les pages en cache : tout (all : true), certaines adresses (urls) ou tout ce qui est étiqueté (tags). Les pages sont reconstruites à mesure que les visiteurs arrivent. | Édition gratuite | 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 | Purger certaines adresses sur chaque couche de cache Supprime simultanément ces adresses (des chemins tels que /about/ ou des adresses complètes sur ce site) du cache disque, du cache serveur et de Cloudflare, et indique la réponse de chaque couche. | Édition gratuite | POST …/abilities/zinn-cache/purge-urls/run | manage_options (the REST route's own check) | urls: array (requis) |
zinn-cache/refresh-cachezinn-cache-refresh-cache | Démarrer ou arrêter l’actualisation cadencée action : start actualise chaque page par lot par minute (ce que font les mises à jour au lieu de vider le cache) ; action : stop met fin à une actualisation en cours. | Édition gratuite | POST …/abilities/zinn-cache/refresh-cache/run | manage_options (the REST route's own check) | action: start|stop (requis) |
zinn-cache/remove-converted-imageszinn-cache-remove-converted-images | Supprimer toutes les images converties (Pro) Supprime en arrière-plan chaque copie convertie des images ; les originaux sont conservés. | Édition Pro | POST …/abilities/zinn-cache/remove-converted-images/run | manage_options | Aucun |
zinn-cache/reset-settingszinn-cache-reset-settings | Rétablir les réglages du cache à leurs valeurs par défaut Rétablit chaque réglage du cache à sa valeur par défaut, comme le fait le bouton Réinitialiser. Le mot de passe Redis enregistré est également supprimé. | Édition gratuite | POST …/abilities/zinn-cache/reset-settings/run | manage_options | Aucun |
zinn-cache/reset-slow-querieszinn-cache-reset-slow-queries | Effacer les résultats des requêtes lentes (Pro) Oublie chaque requête lente et chaque appel lent trouvé jusqu’à présent, et l’outil de recherche redémarre. | Édition Pro | POST …/abilities/zinn-cache/reset-slow-queries/run | manage_options | Aucun |
zinn-cache/update-pro-settingszinn-cache-update-pro-settings | Modifier les réglages de Cache Pro (Pro) Modifie les réglages de Cache Pro que vous envoyez (réglages : clé vers valeur) et conserve le reste. Chaque valeur est vérifiée exactement comme sur l’écran de Cache Pro ; une clé inconnue est refusée. | Édition Pro | POST …/abilities/zinn-cache/update-pro-settings/run | manage_options | settings: object (requis) |
zinn-cache/update-settingszinn-cache-update-settings | Modifier les réglages du cache Modifie les réglages que vous envoyez et conserve le reste (mise en cache des pages, durée de conservation des pages en cache, cache d’objets et sa connexion Redis, règles de purge et exclusions). Les valeurs sont vérifiées et corrigées exactement comme sur l’écran Cache. | Édition gratuite | 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 | Préchauffer le cache (Pro) Commence à visiter chaque page des plans de site en arrière-plan, afin que les visiteurs obtiennent des pages mises en cache. Sa progression est signalée séparément pendant son exécution. | Édition Pro | POST …/abilities/zinn-cache/warm-cache/run | manage_options | Aucun |
Commandes WP-CLI
Exécutez ces commandes sur le serveur avec WP-CLI. Chaque commande vérifie les mêmes autorisations que les écrans du plugin ; les exemples sont tirés du texte d’aide du plugin lui-même.
| Commande | Son rôle | Édition |
|---|---|---|
wp zinn-cache purge allwp zinn-cache purge all | Purger chaque page mise en cache. | Édition gratuite |
wp zinn-cache purge post<id>...wp zinn-cache purge post 42 | Purger les pages d'une publication et les listes où elle apparaît (page d'accueil, archives, flux). | Édition gratuite |
wp zinn-cache purge url<url>...wp zinn-cache purge url https://example.com/ /pricing/ | Purgez les pages mises en cache à ces URL. | Édition gratuite |
wp zinn-cache refresh<action>wp zinn-cache refresh status | Démarrez, arrêtez ou affichez le rafraîchissement échelonné (ce qui remplace « purger tout » après une mise à jour). | Édition gratuite |
wp zinn-cache server detectwp zinn-cache server detect | Vérifiez quelles mémoires caches répondent devant le site (nginx, Varnish, Apache, LiteSpeed, Cloudflare). | Édition gratuite |
wp zinn-cache server drainwp zinn-cache server drain | Envoyez les purges du cache du serveur en file d'attente maintenant au lieu d'attendre WP-Cron. | Édition gratuite |
wp zinn-cache status[--format=<format>]wp zinn-cache status --format=json | Rapportez l'état du cache d'objets. | Édition gratuite |
Actions et filtres
Tous les hooks proposés par le plugin, avec la description de leur code source. Les filtres modifient une valeur ; les actions permettent d’exécuter du code à un moment précis ; les points d’entrée sont des actions que vous déclenchez pour demander au plugin d’effectuer une tâche.
| Webhook | Genre | Son rôle | Paramètres | Édition |
|---|---|---|---|---|
zinn_cache_control_header | Filtrer | Filtre la valeur de cache-control envoyée à LiteSpeed pour une page mise en cache. | string $value, int $ttl | Édition gratuite |
zinn_cache_fs_loaded | Action | S'exécute une fois que le SDK de licence a été chargé, avant le reste de Zinn® Cache. Connectez-vous ici pour interagir avec `zinn_cache_fs()`. | Aucun | Édition gratuite |
zinn_cache_link_scan_post_types | Filtrer | Types de publications couverts par l'analyse. | Aucun | Édition gratuite |
zinn_cache_mcp_abilities | Action | Se déclenche après que Zinn® Cache a enregistré ses capacités : Zinn® Cache Pro ajoute les siennes ici. | Aucun | Édition gratuite |
zinn_cache_post_change_tags | Filtrer | Filtre les balises de cache purgées lorsqu'un article est modifié. | string[] $tags, int $post_id, string $post_type | Édition gratuite |
zinn_cache_purge_all | Action | Tout effacer, depuis la ligne Outils. | Aucun | Édition gratuite |
zinn_cache_purge_hosts | Filtrer | Filtre les noms d'hôte que les vidages peuvent spécifier (pour un site desservi sur plusieurs domaines). | string[] $hosts | Édition gratuite |
zinn_cache_purge_on_seo_change | Filtrer | Filtre si une modification apportée dans Zinn® SEO purge les pages qu'elle a modifiées. | bool $on | Édition gratuite |
zinn_cache_purge_plan | Point d’entrée (vous le déclenchez) | Purger exactement ce qu'un plan désigne : `do_action( 'zinn_cache_purge_plan', array( 'urls' => …, 'tags' => …, 'purge_all' => … ) )`. | Aucun | Édition gratuite |
zinn_cache_purged | Action | S'exécute après que le module d'extension a déclenché une purge du cache. | array{purge_all:bool,urls:string[],tags:string[]} $plan | Édition gratuite |
zinn_cache_purged_all | Action | Se déclenche après qu'une purge complète du cache de la page a été demandée. | string $reason | Édition gratuite |
zinn_cache_refresh_armed | Action | Se déclenche lorsqu'une actualisation cadencée commence. | string $reason | Édition gratuite |
zinn_cache_refresh_finished | Action | Se déclenche lorsqu'une actualisation cadencée a atteint la fin du site. | int $pages | Édition gratuite |
zinn_cache_refresh_guard | Filtrer | Filtre si l'actualisation doit être mise en pause cette minute (protection de charge propre à l'hôte). | string $reason | Édition gratuite |
zinn_cache_refresh_urls | Filtrer | Filtre les adresses qu'un lot d'actualisation purge — ajoutez ici, par exemple, les adresses des autres langues de chaque page. | string[] $urls | Édition gratuite |
zinn_cache_refreshed_urls | Action | Se déclenche après la purge d'un lot d'actualisation (Zinn® Cache Pro préchauffe à nouveau ces pages). | string[] $urls | Édition gratuite |
zinn_cache_request_cacheable | Filtrer | Détermine si la requête front-end actuelle peut être servie à partir du cache de la page. | bool $cacheable | Édition gratuite |
zinn_cache_status_rows | Filtrer | Filtre les lignes du tableau « Qu'est-ce qui met ce site en cache » de l'écran d'état. | array<int,array{0:string,1:string}> $rows, array<string,mixed> $report | Édition gratuite |
zinn_cache_ttl | Filtrer | Filtre la durée de mise en cache de la page actuelle, en secondes. | int $ttl | Édition gratuite |