Entwickler

Zinn® Cache-Funktionen-Referenz

Zinn® Cache registriert seine Aktionen bei der WordPress Abilities API. Dieselben Berechtigungen sind MCP-Tools auf dem eigenen Server der Website und REST-Routen unter /wp-json/wp-abilities/v1. Diese Seite wird aus der eigenen Registry des Plugins generiert.

Benutzerhandbuch: Verbinden einer KI-App

Zinn®, unser Wikinger, jubelt, während sich ein KI-Assistent mit den Tools der Plattform verbindet.

Endpunkte

MCP über HTTP (streamable)

https://example.com/wp-json/zinn-cache/v1/mcp

MCP über WP-CLI (Standardeingabe und -ausgabe)

wp mcp-adapter serve --server=zinn-cache --user=<login>

REST: Fähigkeiten auflisten

/wp-json/wp-abilities/v1/abilities?category=zinn-cache

REST: Fähigkeit ausführen

/wp-json/wp-abilities/v1/abilities/<name>/run

Authentifizierung und Berechtigungen

HTTP-Anfragen authentifizieren sich mit einem WordPress-Anwendungspasswort (HTTP Basic). Das Verbinden mit dem MCP-Server erfordert die unten gezeigte Berechtigung; jede Funktion prüft anschließend ihre eigene Berechtigung pro Objekt. Schreibgeschützte Funktionen werden mit GET und ihrer Eingabe in der Abfragezeichenfolge ausgeführt; die anderen mit POST und einem JSON-Body {„input“: {…}}.

Beispiele

# REST: Fähigkeit ausführen
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":{}}}

Alle Berechtigungen

Generiert aus der abilities.json des Plugins, die ihrerseits aus einer laufenden Website generiert wird; ein Test schlägt fehl, wenn beide nicht übereinstimmen.

BerechtigungFunktionsweiseAusgabeRuhezeitBerechtigungParameter
zinn-cache/clean-database
zinn-cache-clean-database
Bereinige die Datenbank (Pro)
Entfernt im Hintergrund die Arten von Datenmüll, die in den Einstellungen aktiviert sind. Was entfernt wurde, kann nicht wiederhergestellt werden.
Pro-EditionPOST …/abilities/zinn-cache/clean-database/runmanage_optionsKeine
zinn-cache/convert-images
zinn-cache-convert-images
Alle vorhandenen Bilder konvertieren (Pro)
Startet im Hintergrund die Konvertierung der Bilder der Mediathek in die modernen Formate, die du in den Einstellungen aktiviert hast.
Pro-EditionPOST …/abilities/zinn-cache/convert-images/runmanage_optionsKeine
zinn-cache/detect-cache-layers
zinn-cache-detect-cache-layers
Erkenne die Caches vor der Website
Fragt die Startseite wie ein Besucher ab und speichert, welche Caches geantwortet haben. Mit sample: true fragt es außerdem die neuesten Seiten zweimal ab und zählt, wie oft jede Ebene sie aus ihrem Cache ausgeliefert hat.
Kostenlose EditionPOST …/abilities/zinn-cache/detect-cache-layers/runmanage_options (the REST route's own check)sample: boolean
zinn-cache/get-cache-analytics
zinn-cache-get-cache-analytics
Lies die Cache-Analysen (Pro)
Gibt die Trefferquote und den Datenverkehr des Objekt-Caches für die letzten Stunden (Stunden, bis zu 720), seine langsamsten Befehle und welche Plugins den Cache am häufigsten verfehlen, zurück.
Pro-EditionGET …/abilities/zinn-cache/get-cache-analytics/runmanage_optionshours: integer
zinn-cache/get-cache-layers
zinn-cache-get-cache-layers
Lies nach, was die Website zwischenspeichert
Gibt zurück, welcher Cache Seiten ausliefert (LiteSpeed, nginx, Varnish, Apache, Cloudflare oder der Festplatten-Cache des Plugins), was die letzte Erkennung ergeben hat, die Größe jeder Ebene, sofern WordPress sie auslesen kann, die Bereinigungs-Warteschlange, die getaktete Aktualisierung und die letzten Bereinigungen.
Kostenlose EditionGET …/abilities/zinn-cache/get-cache-layers/runmanage_options (the REST route's own check)Keine
zinn-cache/get-diagnostics
zinn-cache-get-diagnostics
Lies den Diagnosebericht
Gibt den Diagnosebericht zurück, den der Support anfordert: Versionen, Server-Limits, den Cache-Status und kürzliche Fehler. Er enthält keine Passwörter oder Schlüssel.
Kostenlose EditionGET …/abilities/zinn-cache/get-diagnostics/runmanage_optionsKeine
zinn-cache/get-image-progress
zinn-cache-get-image-progress
Lies den Fortschritt der Bildkonvertierung ab (Pro)
Gibt zurück, wie weit die Konvertierung (oder Entfernung) der Bilder fortgeschritten ist.
Pro-EditionGET …/abilities/zinn-cache/get-image-progress/runmanage_optionsKeine
zinn-cache/get-pro-settings
zinn-cache-get-pro-settings
Lies die Cache Pro-Einstellungen (Pro)
Gibt jede Cache Pro-Einstellung zurück (Aufwärmen, Bilder, Skripte und Stile, Datenbankbereinigung, intelligentes Leeren, den Finder). Geheimnisse werden niemals zurückgegeben.
Pro-EditionGET …/abilities/zinn-cache/get-pro-settings/runmanage_optionsKeine
zinn-cache/get-settings
zinn-cache-get-settings
Lies die Cache-Einstellungen
Gibt jede Cache-Einstellung zurück. Das Redis-Passwort und das Cloudflare-Token werden nie zurückgegeben, sondern nur, ob eines gespeichert ist.
Kostenlose EditionGET …/abilities/zinn-cache/get-settings/runmanage_optionsKeine
zinn-cache/get-slow-queries
zinn-cache-get-slow-queries
Lies den Finder für langsame Abfragen (Pro)
Gibt die langsamsten Datenbankabfragen und ausgehenden Aufrufe zurück, die der Finder erfasst hat, zusammen mit dem Plugin oder Theme, das sie jeweils verursacht hat.
Pro-EditionGET …/abilities/zinn-cache/get-slow-queries/runmanage_optionsKeine
zinn-cache/get-status
zinn-cache-get-status
Lies den Cache-Status
Gibt zurück, ob der Seitencache und der Objektcache aktiviert sind und funktionieren, wie viele Seiten zwischengespeichert sind sowie die Verbindungs- und Trefferzahlen des Objektcaches.
Kostenlose EditionGET …/abilities/zinn-cache/get-status/runmanage_optionsKeine
zinn-cache/get-warmup-progress
zinn-cache-get-warmup-progress
Lies den Aufwärmfortschritt (Pro)
Gibt zurück, ob das Aufwärmen läuft, wie viele Seiten besucht wurden und wie viele fehlgeschlagen sind.
Pro-EditionGET …/abilities/zinn-cache/get-warmup-progress/runmanage_optionsKeine
zinn-cache/preview-database-cleanup
zinn-cache-preview-database-cleanup
Vorschau der Datenbank-Bereinigung (Pro)
Zählt nach Art auf, was bei einer Bereinigung entfernt werden würde (Revisionen, Entwürfe, Spam, abgelaufene temporäre Daten und Ähnliches). Es wird nichts entfernt.
Pro-EditionGET …/abilities/zinn-cache/preview-database-cleanup/runmanage_optionsKeine
zinn-cache/purge
zinn-cache-purge
Cache leeren
Verwirft zwischengespeicherte Seiten: alles (all: true), bestimmte Adressen (urls) oder alles mit Tags (tags). Seiten werden neu erstellt, sobald Besucher eintreffen.
Kostenlose EditionPOST …/abilities/zinn-cache/purge/runmanage_options (the REST route's own check)all: boolean, urls: array, tags: array
zinn-cache/purge-urls
zinn-cache-purge-urls
Bereinige einige Adressen auf jeder Cache-Ebene
Entfernt diese Adressen (Pfade wie /about/ oder vollständige Adressen auf dieser Website) gleichzeitig aus dem Festplatten-Cache, dem Server-Cache und von Cloudflare und gibt an, was die einzelnen Ebenen geantwortet haben.
Kostenlose EditionPOST …/abilities/zinn-cache/purge-urls/runmanage_options (the REST route's own check)urls: array (Erforderlich)
zinn-cache/refresh-cache
zinn-cache-refresh-cache
Starte oder stoppe die getaktete Aktualisierung
action: start aktualisiert jede Seite stapelweise pro Minute (was Aktualisierungen tun, anstatt den Cache zu leeren); action: stop beendet eine laufende Aktualisierung.
Kostenlose EditionPOST …/abilities/zinn-cache/refresh-cache/runmanage_options (the REST route's own check)action: start|stop (Erforderlich)
zinn-cache/remove-converted-images
zinn-cache-remove-converted-images
Alle konvertierten Bilder entfernen (Pro)
Löscht im Hintergrund jede konvertierte Kopie der Bilder; die Originale bleiben erhalten.
Pro-EditionPOST …/abilities/zinn-cache/remove-converted-images/runmanage_optionsKeine
zinn-cache/reset-settings
zinn-cache-reset-settings
Setze die Cache-Einstellungen auf die Standardwerte zurück
Setzt jede Cache-Einstellung auf den Standardwert zurück, genau wie die Schaltfläche „Zurücksetzen“. Das gespeicherte Redis-Passwort wird ebenfalls entfernt.
Kostenlose EditionPOST …/abilities/zinn-cache/reset-settings/runmanage_optionsKeine
zinn-cache/reset-slow-queries
zinn-cache-reset-slow-queries
Befunde zu langsamen Abfragen löschen (Pro)
Vergisst jede bisher gefundene langsame Abfrage und jeden langsamen Aufruf, und der Finder startet erneut.
Pro-EditionPOST …/abilities/zinn-cache/reset-slow-queries/runmanage_optionsKeine
zinn-cache/update-pro-settings
zinn-cache-update-pro-settings
Ändere die Einstellungen für Cache Pro (Pro)
Ändert die von dir gesendeten Cache Pro-Einstellungen (Einstellungen: Schlüssel zu Wert) und behält den Rest bei. Jeder Wert wird genau wie auf dem Cache Pro-Bildschirm überprüft; ein unbekannter Schlüssel wird abgelehnt.
Pro-EditionPOST …/abilities/zinn-cache/update-pro-settings/runmanage_optionssettings: object (Erforderlich)
zinn-cache/update-settings
zinn-cache-update-settings
Cache-Einstellungen ändern
Ändert die von dir gesendeten Einstellungen und behält den Rest bei (Seitencache, Verweildauer von Seiten im Cache, Objektcache und seine Redis-Verbindung, Leerungsregeln und Ausschlüsse). Werte werden genau wie auf dem Cache-Bildschirm überprüft und korrigiert.
Kostenlose EditionPOST …/abilities/zinn-cache/update-settings/runmanage_optionslscache_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-cache
zinn-cache-warm-cache
Cache aufwärmen (Pro)
Beginnt im Hintergrund damit, jede Seite in den Sitemaps aufzurufen, damit Besucher zwischengespeicherte Seiten erhalten. Der Fortschritt wird während der Ausführung separat gemeldet.
Pro-EditionPOST …/abilities/zinn-cache/warm-cache/runmanage_optionsKeine

WP-CLI-Befehle

Führen Sie diese Befehle auf dem Server mit WP-CLI aus. Jeder Befehl überprüft dieselben Berechtigungen wie die Bildschirme des Plugins; die Beispiele sind dem Hilfetext des Plugins entnommen.

BefehlFunktionsweiseAusgabe
wp zinn-cache purge all
wp zinn-cache purge all
Jede zwischengespeicherte Seite leeren.Kostenlose Edition
wp zinn-cache purge post
<id>...
wp zinn-cache purge post 42
Seiten eines Beitrags und die Listen bereinigen, in denen er erscheint (Startseite, Archive, Feeds).Kostenlose Edition
wp zinn-cache purge url
<url>...
wp zinn-cache purge url https://example.com/ /pricing/
Löschen Sie die zwischengespeicherten Seiten unter diesen URLs.Kostenlose Edition
wp zinn-cache refresh
<action>
wp zinn-cache refresh status
Starten, stoppen oder zeigen Sie die gestaffelte Aktualisierung an (was nach einem Update die Option „Alles leeren“ ersetzt).Kostenlose Edition
wp zinn-cache server detect
wp zinn-cache server detect
Überprüfen Sie, welche Caches vor der Website antworten (nginx, Varnish, Apache, LiteSpeed, Cloudflare).Kostenlose Edition
wp zinn-cache server drain
wp zinn-cache server drain
Senden Sie die Warteschlange der Server-Cache-Leerungen jetzt, anstatt auf WP-Cron zu warten.Kostenlose Edition
wp zinn-cache status
[--format=<format>]
wp zinn-cache status --format=json
Geben Sie den Status des Objektcaches aus.Kostenlose Edition

Aktionen und Filter

Jeder vom Plugin bereitgestellte Hook mit der Beschreibung aus seinem Quellcode. Filter ändern einen Wert; Aktionen ermöglichen es Ihnen, zu einem bestimmten Zeitpunkt Code auszuführen; Einstiegspunkte sind Aktionen, die Sie auslösen, um das Plugin zu einer Aktion aufzufordern.

WebhookArtFunktionsweiseParameterAusgabe
zinn_cache_control_headerFilternFiltert den Cache-Control-Wert, der für eine zwischenspeicherbare Seite an LiteSpeed gesendet wird.string $value, int $ttlKostenlose Edition
zinn_cache_fs_loadedAktionWird ausgelöst, sobald das Lizenzierungs-SDK geladen wurde, noch vor dem Rest von Zinn® Cache. Haken Sie sich hier ein, um mit `zinn_cache_fs()` zu kommunizieren.KeineKostenlose Edition
zinn_cache_link_scan_post_typesFilternBeitragstypen, die der Scan absetzt.KeineKostenlose Edition
zinn_cache_mcp_abilitiesAktionWird ausgelöst, nachdem Zinn® Cache seine Funktionen registriert hat: Zinn® Cache Pro fügt hier seine eigenen hinzu.KeineKostenlose Edition
zinn_cache_post_change_tagsFilternFiltert die Cache-Tags, die bereinigt werden, wenn sich ein Beitrag ändert.string[] $tags, int $post_id, string $post_typeKostenlose Edition
zinn_cache_purge_allAktionAlles löschen, aus der Werkzeugleiste.KeineKostenlose Edition
zinn_cache_purge_hostsFilternFiltert die Hostnamen, die Bereinigungen angeben dürfen (für eine Website, die unter mehr als einer Domain bereitgestellt wird).string[] $hostsKostenlose Edition
zinn_cache_purge_on_seo_changeFilternFiltert, ob eine in Zinn® SEO vorgenommene Änderung die geänderten Seiten leert.bool $onKostenlose Edition
zinn_cache_purge_planEinstiegspunkt (wird von Ihnen ausgelöst)Bereinigen Sie genau das, was ein Plan angibt: `do_action( 'zinn_cache_purge_plan', array( 'urls' => …, 'tags' => …, 'purge_all' => … ) )`.KeineKostenlose Edition
zinn_cache_purgedAktionWird ausgeführt, nachdem das Plugin eine Cache-Bereinigung ausgelöst hat.array{purge_all:bool,urls:string[],tags:string[]} $planKostenlose Edition
zinn_cache_purged_allAktionWird ausgelöst, nachdem eine vollständige Bereinigung des Seitencaches angefordert wurde.string $reasonKostenlose Edition
zinn_cache_refresh_armedAktionWird ausgelöst, wenn eine getaktete Aktualisierung beginnt.string $reasonKostenlose Edition
zinn_cache_refresh_finishedAktionWird ausgelöst, wenn eine getaktete Aktualisierung das Ende der Website erreicht hat.int $pagesKostenlose Edition
zinn_cache_refresh_guardFilternFiltert, ob die Aktualisierung in dieser Minute pausieren soll (der hosteigene Überlastungsschutz).string $reasonKostenlose Edition
zinn_cache_refresh_urlsFilternFiltert die Adressen, die ein Aktualisierungs-Batch bereinigt — fügen Sie hier beispielsweise die anderssprachigen Adressen jeder Seite hinzu.string[] $urlsKostenlose Edition
zinn_cache_refreshed_urlsAktionWird ausgelöst, nachdem ein Aktualisierungs-Batch bereinigt wurde (Zinn® Cache Pro wärmt diese Seiten erneut auf).string[] $urlsKostenlose Edition
zinn_cache_request_cacheableFilternFiltert, ob die aktuelle Frontend-Anfrage aus dem Seitencache bedient werden darf.bool $cacheableKostenlose Edition
zinn_cache_status_rowsFilternFiltert die Zeilen der Tabelle „Was zwischenspeichert diese Website“ auf dem Statusbildschirm.array<int,array{0:string,1:string}> $rows, array<string,mixed> $reportKostenlose Edition
zinn_cache_ttlFilternFiltert die Dauer in Sekunden, für die die aktuelle Seite zwischengespeichert wird.int $ttlKostenlose Edition