WordPress Dashboard Widget hinzufügen

Anzeige

Die kommende Version 2.7 von WordPress bringt die lang ersehnten Widgets in den Dashboard-Bereich. Damit kann dann jeder User seine eigenen Vorstellungen des Dashboard realisieren. Ebenfalls ist es nun auch dem Nutzer überlassen, wie lange die Ladezeiten sind und welche Informationen man dort sehen will; je nach Integration von externen Inhalten.

Für Plugin- und Theme-Autoren ist es aber interessant, denn ab nun kann man dem Nutzer diversen Mehrwert bieten. Informationen aus dem Plugin oder Theme können dort angeboten werden, so dass der Nutzer selbst entscheidet, ob er diese Info's sehen will.

Schön ist, dass die Integration sehr einfach zu nutzen ist und ähnlich wie die Meta Boxen (hier schon detailliert erklärt) gesteuert wird, die im übrigen dafür verantwortlich ist, aber mit einer Funktion direkt für Widgets ausgestattet wurde. Das folgende kleine Beispiel zeigt, wie man ein Widget in das Dashboard integriert.

Der obige Screenshot zeigt schön, dass ich das Widget Test My Dashboard hinzugefügt habe. Ebenfalls zu sehen ist die mögliche Deaktivierung im Menu.

/**
 * Inhalt des Dashboard-Widget
 */
function my_wp_dashboard_test() {
	echo 'Test Add Dashboard-Widget';
}

/**
 * Dashboard Widget hinzufügen via Funktion wp_add_dashboard_widget()
 */
function my_wp_dashboard_setup() {
	wp_add_dashboard_widget( 'my_wp_dashboard_test', __( 'Test My Dashboard' ), 'my_wp_dashboard_test' );
}

/**
 * Nutzen des Hook, um das neue Widget zu integrieren
 */
add_action('wp_dashboard_setup', 'my_wp_dashboard_setup');

Einige kleine Hinweise zur Aufgabe stehen direkt am Code. Im Grunde ist die Funktion wp_add_dashboard_widget() der Schlüssel, die übergibt das neue Widget; via Hook wp_dashboard_setup wird dieses dann im Dashboard aktiviert.

function wp_add_dashboard_widget( $widget_id, $widget_name, $callback, $control_callback = null )

Die Funktion benötigt 3 Parameter und ein weiterer ist optional.

1. Die ID, der erste Parameter, wird benutzt, um das Widget via JavaScript zu deaktiveren und anzusprechen. einmal im Menu:

   
   
   Test My Dashboard
   

   und auch im eigentlichen Widget:

   
   
   Test My Dashboard
   Test Add Dashboard-Widget
   
   
   

2. Der zweite Parameter übergibt den Namen, welcher auch sichtbar ist, eingeschlossen in den h3-Tag; bzw. auch im Menu vergeben ist.

   
   Test My Dashboard
   

3. Mit Hilfe des dritten Parameter wird die Funktion übergeben, die den Inhalt des Widget enthält. Es erfolgt kein echo, es muss explizit genutzt werden. Daraus resultiert ein gewissen Freiheit und nicht nur die einfache Ausgabe von Inhalten kann erstellt werden.

Hinweis

Der Hook activity_box_end, der seit Version 2.3 existiert, existiert weiterhin. Er bringt den Content in das Widget „Right Now“.