Auch Entwickler brauchen Platz zum Spielen

15. Juni 2021 /

Entwicklung für WordPress: Plugins um die Kontexthilfe erweitern

Die Vielzahl der Einstellungen und Optionen in WordPress überfordert viele Anfänger. Auf der Suche nach einem Ratschlag begeben sich Anwender in die Foren und sorgen für einen nicht unbedeutenden Supportaufkommen. Das gilt nicht nur für die Blogsoftware selbst, auch in einem professionellen WordPress Plugin dürfen Erklärungen nicht fehlen. Seit WordPress 2.7 existiert in der oberen rechten Ecke ein Hilfebutton, der mit informativem Inhalt gefüllt werden kann.

Hilfe bekommt in WordPress höhere Bedeutung
Ein Klick auf die Schaltfläche Hilfe klappt einen Sektor mit individuell hinterlegten Informationen zur aktuellen Administrationsseite auf. Bedauerlicherweise verfügt derzeit noch nicht jede Optionsseite in WordPress 2.7 über weiterführende Erklärungen innerhalb des Hilfekastens, wird wohl mit einer der nächsten Versionen je nach Bedarf nachgeholt.

Die meisten WordPress Plugins besitzen ebenfalls über eine Seite mit möglichen Einstellungen – als Standard erscheint der Hilfebutton auch da und kann vom Plugin-Entwickler mithilfe einer neu hinzugekommenen Funktion um bestimmte Inhalte bereichert werden. Ob ein Plugin auf zusätzliche Informationen in Form einer Kontexthilfe angewiesen ist oder eher weniger, entscheidet der Autor einer Erweiterung ganz allein. Schaden kann es jedoch nicht, da mangels Platz im Layer ohnehin keine vollwertige Hilfestellung und keinesfalls alle FAQ-Punkte abgebildet werden können. Also wenn ein „Aushang“, dann stark komprimierter und leicht verständlicher Natur.

Hilfeunterstützung seit WordPress 2.7
Hilfeunterstützung seit WordPress 2.7

WordPress Funktion für die Inline-Hilfe
Die im wahrsten Sinne des Wortes hilfreiche Funktion hat add_contextual_help als Namenbezeichnung und ist seit WordPress 2.7 verfüg- und ansprechbar. Noch während der Entwicklung der brandneuen WordPress Version hat Frank Bültge mich auf die frisch hinzugefügte Möglichkeit, eigene Hilfetexte zu hinterlassen, aufmerksam gemacht.

Der Aufruf der Funktion ist kinderleicht, selbsterklärend und wird von jedem Plugin-Entwickler sofort verstanden.

Verfügbare Parameter der Funktion

void add_contextual_help (string $hook, string $help)

Beschreibung der Parameter

  • $hook ist der Name des Hooks, welchen add_*_page() zurückgibt.
    Der Wert kann auch manuell gesetzt werden.
  • $help ist der übergebene XHTML-Code mit Hilfetexten.
    Links sind ebenfalls möglich.

Anwendungsbeispiel im Plugin

$hook = add_options_page(
  'Plugin',
  'Plugin',
  9,
  __FILE__,
  array(
    $this,
    'callback'
  )
);

if (function_exists('add_contextual_help')) {
  add_contextual_help(
    $hook,
    'Mein Hilfetext<br /><br /><a href="">Mein Link</a>'
  );
}

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.