Egenverk Docs Viewer · Dokumentation

Referens

v2.10.0WP 5.0+PHP 7.4+Uppdaterad

Filter: egenverk_dv_capability

Styr vilken behörighet som krävs för att öppna Verktyg → Docs Viewer, läsa och söka. Standard är manage_options. Returnerar filtret något annat än en sträng, eller en tom sträng, används manage_options.

Lägg filtret i ett litet must-use-tillägg, till exempel wp-content/mu-plugins/docs-viewer-access.php:

<?php
add_filter( 'egenverk_dv_capability', function () {
	return 'edit_posts';
} );

Användare med den behörigheten ser Verktyg → Docs Viewer och kan läsa alla skannade dokument, och de får länkarna på Tillägg-sidan. De kan inte skanna och inte ändra länkinställningen; skanning, omskanning på multisite och länkinställningen kräver alltid manage_options. Är inget skannat än ber läsvyn dem att låta en administratör köra skanningen.

Adresser till läsvyn

Läsvyn ligger på wp-admin/tools.php?page=egenverk-docs-viewer. Parametrarna nedan kan du använda i bokmärken och länkar:

ParameterVad den gör
dv_pluginVilket tillägg eller tema som visas: tilläggets mappnamn, theme: följt av temats mappnamn, eller mu: följt av must-use-tilläggets mappnamn
dv_fileFilens sökväg i mappen, till exempel docs/guide.md
dv_modepreview (standard) eller raw
dv_searchEn sökfråga
dv_versionÖppnar en ändringslogg vid avsnittet för den versionen

Ett #rubrik sist i adressen öppnar dokumentet vid den rubriken. Den äldre adressen wp-admin/admin.php?page=egenverk-docs-viewer skickas vidare hit och behåller parametrarna.

Händelser som bygger om indexet

Indexet byggs om en gång, i slutet av anropet, när:

  • ett tillägg eller tema installeras eller uppdateras
  • ett tillägg aktiveras, inaktiveras eller tas bort
  • ett tema tas bort
  • Docs Viewer aktiveras

Det gäller även uppdateringar som körs via WP-Cron eller WP-CLI. På multisite, där tilläggen delas men varje webbplats har sitt eget index, bygger övriga webbplatser om sitt index vid nästa besök i admin av en administratör.

Lagrade alternativ

Se tabellen i Data och integritet.

Resurser