Websupporter

Vor allem über WordPress.

Hilfe-Tabs für das eigene Plugin erstellen

In diesem Beitrag möchte ich erläutern, wie man die Hilfe-Tabs des WordPress Admins für das eigene Plugin nutzen kann.

Hilfe-Tab erstellen
Hilfe-Tab erstellen

Beginnen wir also mit der Grundlage und erstellen eine neue Seite im Admin Menü:

Embed from pastebin.com

Click the button below to load the content from pastebin.com.


Always allow pastebin.com

Wie ihr wisst, erstellt man mit Hilfe von add_menu_page() einen neuen Menüpunkt. Diese Funktion gibt dabei die ID der neu registrierten Seite zurück. Mit Hilfe dieser können wir uns in die spezifische Load-Aktion der Seite einhaken:

add_action( 'load-' . $page_with_help, 'pwh_add_help_tab' );

In dieser Aktion werden wir nun unseren neuen Hilfe-Tab registrieren und ihm einige Inhalte geben.

Den Hilfe-Tab hinzufügen

Zunächst müssen wir den aktuellen Screen erhalten. Dazu können wir die Funktion get_current_screen() nutzen, welche uns das aktuellen WP_Screen Objekt zurückgibt. Dieses enthält unter anderem die Hilfe-Tabs.

Im zweiten Schritt werden wir nun mittels WP_Screen::add_help_tab() einen neuen Hilfe-Tab hinzufügen. Ein solcher enhält eine ID, einen Titel und den Inhalt:

Embed from pastebin.com

Click the button below to load the content from pastebin.com.


Always allow pastebin.com

Mit diesen zwei einfachen Schritten können wir unsere eigenen Hilfe-Tabs erzeugen, welche sich perfekt in das WordPress Design einfügen. Wir können auch eine Callback Funktion benennen, welche das Rendering des Inhalts übernimmt.

Embed from pastebin.com

Click the button below to load the content from pastebin.com.


Always allow pastebin.com

Mit einer solchen Callback Funktion erweitern wir unsere Möglichkeiten, den Output zu gestalten. Diese Funktion kann zwei Parameter aufnehmen: Zum einen das aktuelle Screen Objekt und zum anderen den aktuellen Hilfe-Tab.

Embed from pastebin.com

Click the button below to load the content from pastebin.com.


Always allow pastebin.com

Eine Sidebar erstellen

Auch die Hilfe Sektion kann über eine Sidebar verfügen. Sobald wir einen Tab registriert haben können wir dazu auf set_help_sidebar() zurückgreifen. Der Inhalt der Sidebar wird dann auf der rechten Seite der Sektion dargestellt.

Embed from pastebin.com

Click the button below to load the content from pastebin.com.


Always allow pastebin.com

Es ist also wirklich einfach, eine kleine Hilfe-Sektion für das eigene Plugin zu entwickeln. Für Eure Plugin-Nutzer kann eine gut gestaltete Hilfe dabei Gold wert sein.

Über den Autoren

Seine erste Webseite hat David Remer 1998 in HTML verfasst. Wenig später war er fasziniert von DHTML und JavaScript. Heute konzentriert sich vor allem auf das Entwickeln von WordPress Themes und Plugins für Inpsyde. Außerdem hat er das Buch "WordPress für Entwickler" verfasst.

Kommentare

  1. Liest sich gut, aber wie baut man den Code in ein vorhandenes Plugin ein, ohne dass ein neues Plugin (page with help) entsteht? Ich habe es leider nicht hinbekommen.

    1. Hi Hans,
      werfe einen Blick in das Snippet, in welchem `add_menu_page()` verwendet wird. Darunter wird ein Actionhook eingebunden. Wenn Du deine Menüseiten registrierst, kannst Du so den Actionhook für Deine Hilfe-Tabs organisieren.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.