Ontwikkelaars

Referentie van Zinn® Cache-functionaliteiten

Zinn® Cache registreert zijn acties bij de WordPress Abilities API. Dezelfde vaardigheden zijn MCP-tools op de eigen server van de site en REST-routes onder /wp-json/wp-abilities/v1. Deze pagina is gegenereerd vanuit het eigen register van de plugin.

Gebruikershandleiding: een AI-app verbinden

Zinn®, onze Viking, juicht terwijl een AI-assistent verbinding maakt met de tools van het platform.

Eindpunten

MCP over HTTP (streamable)

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

MCP over WP-CLI (standaard invoer en uitvoer)

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

REST: toon de mogelijkheden

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

REST: voer een functie uit

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

Authenticatie en machtigingen

HTTP-verzoeken verifiëren met een WordPress-applicatiewachtwoord (HTTP Basic). Voor het verbinden met de MCP-server is de hieronder getoonde functionaliteit vereist; elke vaardigheid controleert vervolgens haar eigen permissie, per object. Alleen-lezen-vaardigheden worden uitgevoerd met GET en hun invoer in de query-tekenreeks; de overige met POST en een JSON-body {"input": {…}}.

Voorbeelden

# REST: voer een functie uit
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 bevoegdheden

Gegenereerd op basis van abilities.json van de plug-in, die op zijn beurt is gegenereerd vanuit een actieve site; een test mislukt wanneer deze twee niet met elkaar overeenkomen.

MogelijkheidWat het doetEditieRESTMachtigingParameters
zinn-cache/clean-database
zinn-cache-clean-database
Schoon de database op (Pro)
Verwijdert op de achtergrond de soorten rommel die zijn ingeschakeld in de instellingen. Wat verwijderd is, kan niet worden teruggehaald.
Pro-editiePOST …/abilities/zinn-cache/clean-database/runmanage_optionsgeen
zinn-cache/convert-images
zinn-cache-convert-images
Converteer alle bestaande afbeeldingen (Pro)
Begint op de achtergrond met het converteren van de afbeeldingen in de mediabibliotheek naar de moderne formaten die je in de instellingen hebt ingeschakeld.
Pro-editiePOST …/abilities/zinn-cache/convert-images/runmanage_optionsgeen
zinn-cache/detect-cache-layers
zinn-cache-detect-cache-layers
Detecteer de caches vóór de site
Vraagt de startpagina op zoals een bezoeker dat zou doen en slaat op welke caches hebben geantwoord. Met sample: true vraagt het de nieuwste pagina's ook twee keer op en telt het hoe vaak elke laag ze vanuit zijn cache heeft geleverd.
Gratis editiePOST …/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
Lees de cache-statistieken (Pro)
Toont het hitpercentage en verkeer van de objectcache voor de afgelopen uren (uren, tot 720), de traagste commando's en welke plugins de cache het vaakst missen.
Pro-editieGET …/abilities/zinn-cache/get-cache-analytics/runmanage_optionshours: integer
zinn-cache/get-cache-layers
zinn-cache-get-cache-layers
Lees wat de site buffert
Geeft aan welke cache pagina's serveert (LiteSpeed, nginx, Varnish, Apache, Cloudflare of de schijfcache van de plugin), wat er bij de laatste detectie is waargenomen, de grootte van elke laag waar WordPress deze kan lezen, de wachtrij voor legen, het gedoseerd vernieuwen en de recente legingen.
Gratis editieGET …/abilities/zinn-cache/get-cache-layers/runmanage_options (the REST route's own check)geen
zinn-cache/get-diagnostics
zinn-cache-get-diagnostics
Lees het diagnoserapport
Retourneert het diagnostische rapport waar support om vraagt: versies, serverlimieten, de cachestatus en recente fouten. Het bevat geen wachtwoorden of sleutels.
Gratis editieGET …/abilities/zinn-cache/get-diagnostics/runmanage_optionsgeen
zinn-cache/get-image-progress
zinn-cache-get-image-progress
Lees de voortgang van de beeldconversie (Pro)
Geeft als resultaat hoe ver de conversie (of verwijdering) van de afbeeldingen is gevorderd.
Pro-editieGET …/abilities/zinn-cache/get-image-progress/runmanage_optionsgeen
zinn-cache/get-pro-settings
zinn-cache-get-pro-settings
Lees de Cache Pro-instellingen (Pro)
Retourneert elke Cache Pro-instelling (opwarmen, afbeeldingen, scripts en stijlen, database opschonen, slim wissen, de finder). Geheimen worden nooit geretourneerd.
Pro-editieGET …/abilities/zinn-cache/get-pro-settings/runmanage_optionsgeen
zinn-cache/get-settings
zinn-cache-get-settings
Lees de cache-instellingen
Retourneert elke cache-instelling. Het Redis-wachtwoord en het Cloudflare-token worden nooit geretourneerd, alleen of er een is opgeslagen.
Gratis editieGET …/abilities/zinn-cache/get-settings/runmanage_optionsgeen
zinn-cache/get-slow-queries
zinn-cache-get-slow-queries
Lees de zoeker naar trage query's (Pro)
Geeft de langzaamste databasequery's en uitgaande aanroepen weer die de zoeker heeft waargenomen, met de plugin of het thema dat ze heeft uitgevoerd.
Pro-editieGET …/abilities/zinn-cache/get-slow-queries/runmanage_optionsgeen
zinn-cache/get-status
zinn-cache-get-status
Lees de cachestatus
Geeft terug of de paginacache en de objectcache zijn ingeschakeld en werken, hoeveel pagina's er gecachet zijn en de verbindings- en hit-aantallen van de objectcache.
Gratis editieGET …/abilities/zinn-cache/get-status/runmanage_optionsgeen
zinn-cache/get-warmup-progress
zinn-cache-get-warmup-progress
Lees de voortgang van de opwarming (Pro)
Retourneert of de opwarming actief is, hoeveel pagina's zijn bezocht en hoeveel er zijn mislukt.
Pro-editieGET …/abilities/zinn-cache/get-warmup-progress/runmanage_optionsgeen
zinn-cache/preview-database-cleanup
zinn-cache-preview-database-cleanup
Voorbeeld van de database-opschoning (Pro)
Telt wat een opschoonactie zou verwijderen, per soort (revisies, concepten, spam, verlopen tijdelijke gegevens en dergelijke). Er wordt niets verwijderd.
Pro-editieGET …/abilities/zinn-cache/preview-database-cleanup/runmanage_optionsgeen
zinn-cache/purge
zinn-cache-purge
Cache legen
Verwijdert gecachte pagina's: alles (all: true), bepaalde adressen (urls) of alles met tags (tags). Pagina's worden opnieuw opgebouwd zodra bezoekers binnenkomen.
Gratis editiePOST …/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
Sommige adressen op elke cachelaag wissen
Verwijdert deze adressen (paden zoals /about/ of volledige adressen op deze site) tegelijkertijd uit de schijfcache, de servercache en Cloudflare, en geeft aan wat elke laag heeft geantwoord.
Gratis editiePOST …/abilities/zinn-cache/purge-urls/runmanage_options (the REST route's own check)urls: array (verplicht)
zinn-cache/refresh-cache
zinn-cache-refresh-cache
Start of stop het gedoseerd vernieuwen
actie: start ververst elke pagina batch per minuut (wat updates doen in plaats van de cache te legen); actie: stop beëindigt een actieve vernieuwing.
Gratis editiePOST …/abilities/zinn-cache/refresh-cache/runmanage_options (the REST route's own check)action: start|stop (verplicht)
zinn-cache/remove-converted-images
zinn-cache-remove-converted-images
Verwijder alle geconverteerde afbeeldingen (Pro)
Verwijdert op de achtergrond elke geconverteerde kopie van de afbeeldingen; de originelen blijven behouden.
Pro-editiePOST …/abilities/zinn-cache/remove-converted-images/runmanage_optionsgeen
zinn-cache/reset-settings
zinn-cache-reset-settings
Zet de cache-instellingen terug naar de standaardwaarden
Zet elke cache-instelling terug naar de standaardwaarde, net zoals de Reset-knop doet. Het opgeslagen Redis-wachtwoord wordt ook verwijderd.
Gratis editiePOST …/abilities/zinn-cache/reset-settings/runmanage_optionsgeen
zinn-cache/reset-slow-queries
zinn-cache-reset-slow-queries
Wis de bevindingen van trage query's (Pro)
Vergeet elke trage query en trage aanroep die tot nu toe is gevonden, en de zoeker begint opnieuw.
Pro-editiePOST …/abilities/zinn-cache/reset-slow-queries/runmanage_optionsgeen
zinn-cache/update-pro-settings
zinn-cache-update-pro-settings
Wijzig de Cache Pro-instellingen (Pro)
Wijzigt de Cache Pro-instellingen die je verzendt (instellingen: sleutel naar waarde) en behoudt de rest. Elke waarde wordt precies zoals op het Cache Pro-scherm gecontroleerd; een onbekende sleutel wordt geweigerd.
Pro-editiePOST …/abilities/zinn-cache/update-pro-settings/runmanage_optionssettings: object (verplicht)
zinn-cache/update-settings
zinn-cache-update-settings
Wijzig de cache-instellingen
Wijzigt de instellingen die je verzendt en behoudt de rest (paginacache, hoe lang pagina's in de cache blijven, de objectcache en de bijbehorende Redis-verbinding, leegregels en uitsluitingen). Waarden worden precies zoals op het scherm Cache gecontroleerd en gecorrigeerd.
Gratis editiePOST …/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 voorverwarmen (Pro)
Begint op de achtergrond elke pagina in de sitemaps te bezoeken, zodat bezoekers gecachte pagina's te zien krijgen. De voortgang wordt tijdens de uitvoering apart gerapporteerd.
Pro-editiePOST …/abilities/zinn-cache/warm-cache/runmanage_optionsgeen

WP-CLI-opdrachten

Voer deze uit op de server met WP-CLI. Elke opdracht controleert dezelfde permissies als de schermen van de plugin; de voorbeelden zijn overgenomen uit de eigen helptekst van de plugin.

OpdrachtWat het doetEditie
wp zinn-cache purge all
wp zinn-cache purge all
Elke gecachete pagina wissen.Gratis editie
wp zinn-cache purge post
<id>...
wp zinn-cache purge post 42
De pagina's van een bericht en de overzichten waarop het verschijnt (homepage, archieven, feeds) opschonen.Gratis editie
wp zinn-cache purge url
<url>...
wp zinn-cache purge url https://example.com/ /pricing/
Wis de gecachte pagina's op deze URL's.Gratis editie
wp zinn-cache refresh
<action>
wp zinn-cache refresh status
Start, stop of toon het gedoseerd vernieuwen (wat na een update "alles wissen" vervangt).Gratis editie
wp zinn-cache server detect
wp zinn-cache server detect
Controleer welke caches vóór de site antwoorden (nginx, Varnish, Apache, LiteSpeed, Cloudflare).Gratis editie
wp zinn-cache server drain
wp zinn-cache server drain
Verzend de servercache-opschoningen in de wachtrij nu in plaats van te wachten op WP-Cron.Gratis editie
wp zinn-cache status
[--format=<format>]
wp zinn-cache status --format=json
Rapporteer de status van de objectcache.Gratis editie

Acties en filters

Elke hook die de plugin biedt, met de beschrijving uit de broncode. Filters veranderen een waarde; met acties kunt u op een bepaald moment code uitvoeren; ingangspunten zijn acties die u triggert om de plugin iets te laten doen.

WebhookAardWat het doetParametersEditie
zinn_cache_control_headerFilterenFiltert de cache-control-waarde die naar LiteSpeed wordt verzonden voor een cachebare pagina.string $value, int $ttlGratis editie
zinn_cache_fs_loadedActieWordt uitgevoerd zodra de licentie-SDK is geladen, vóór de rest van Zinn® Cache. Maak hier een hook aan om te communiceren met `zinn_cache_fs()`.geenGratis editie
zinn_cache_link_scan_post_typesFilterenBerichttypen die de scan omvat.geenGratis editie
zinn_cache_mcp_abilitiesActieWordt uitgevoerd nadat Zinn® Cache zijn capaciteiten registreert: Zinn® Cache Pro voegt hier zijn eigen capaciteiten toe.geenGratis editie
zinn_cache_post_change_tagsFilterenFiltert de cachetags die worden opgeschoond wanneer een bericht wordt gewijzigd.string[] $tags, int $post_id, string $post_typeGratis editie
zinn_cache_purge_allActieWis alles via de rij Hulpmiddelen.geenGratis editie
zinn_cache_purge_hostsFilterenFiltert de hostnamen die opschoningen mogen noemen (voor een site die op meer dan één domein wordt aangeboden).string[] $hostsGratis editie
zinn_cache_purge_on_seo_changeFilterenFiltert of een wijziging die is aangebracht in Zinn® SEO de pagina's die zijn gewijzigd leegmaakt.bool $onGratis editie
zinn_cache_purge_planInvoerpunt (u vuurt dit af)Verwijder precies wat een pakket aangeeft: `do_action( 'zinn_cache_purge_plan', array( 'urls' => …, 'tags' => …, 'purge_all' => … ) )`.geenGratis editie
zinn_cache_purgedActieWordt uitgevoerd nadat de plug-in een cache-opschoning heeft verzonden.array{purge_all:bool,urls:string[],tags:string[]} $planGratis editie
zinn_cache_purged_allActieWordt geactiveerd nadat een volledige opschoning van de paginacache is aangevraagd.string $reasonGratis editie
zinn_cache_refresh_armedActieWordt geactiveerd wanneer een getimed vernieuwen begint.string $reasonGratis editie
zinn_cache_refresh_finishedActieWordt geactiveerd wanneer een gedoseerde vernieuwing het einde van de site heeft bereikt.int $pagesGratis editie
zinn_cache_refresh_guardFilterenFiltert of het vernieuwen deze minuut moet worden onderbroken (de eigen belastingbeveiliging van de host).string $reasonGratis editie
zinn_cache_refresh_urlsFilterenFiltert de adressen die een vernieuwingsbatch opschoont — voeg hier bijvoorbeeld de adressen in andere talen van elke pagina toe.string[] $urlsGratis editie
zinn_cache_refreshed_urlsActieWordt geactiveerd nadat een vernieuwingsbatch is gewist (Zinn® Cache Pro warmt deze pagina's opnieuw op).string[] $urlsGratis editie
zinn_cache_request_cacheableFilterenBepaalt of het huidige front-endverzoek vanuit de paginacache mag worden bediend.bool $cacheableGratis editie
zinn_cache_status_rowsFilterenFiltert de rijen van de tabel «Wat buffert deze site» op het statusscherm.array<int,array{0:string,1:string}> $rows, array<string,mixed> $reportGratis editie
zinn_cache_ttlFilterenBepaalt hoe lang de huidige pagina wordt gecached, in seconden.int $ttlGratis editie