Wir hören oft von der WordPress Dashboard Widgets API, aber was genau ist das? Erfahren Sie, wofür diese API verwendet wird, warum sie so wichtig für Ihre WordPress-Website ist und wie Sie Ihrem Dashboard ganz einfach Widgets hinzufügen können. Erweitern Sie die Funktionalität Ihrer Website.

Was ist Dashboard Widgets API

Die Dashboard-Widgets-API ist eine Reihe von Tools, die von WordPress bereitgestellt werden und mit denen Sie Widgets auf Ihrem Dashboard leicht hinzufügen, entfernen oder ändern können. Sie ist perfekt für alle, die direkt mit ihren Nutzern kommunizieren möchten - sei es, um Informationen anzuzeigen oder sie zu bestimmten Aktionen zu bewegen.

Schauen Sie sich diese Beispiele an:

• Jetpack-PluginEs fügt dem Dashboard ein Widget hinzu, mit dem Sie die Besuchsstatistiken der Website sowie die beliebtesten Beiträge und Seiten anzeigen können.
• Ernsthaft einfaches PodcastingDieses Plugin wird mit Seriously Simple Stats geliefert, mit dem Sie Ihre Blog-Statistiken anzeigen können. Außerdem verfügt es über ein RSS-Feed-Widget, das Castos-Nachrichten anzeigt - Castos ist das Unternehmen, das dieses Blog-Plugin entwickelt hat.

Diese APIs und Widgets machen Ihr WordPress-Dashboard leistungsfähiger und personalisierter und sorgen für eine direktere und effizientere Darstellung von Informationen und Benutzerinteraktion.

So verwenden Sie die Dashboard Widget API

Seit der WordPress-Version 2.7 ermöglicht die Dashboard Widget API das einfache Hinzufügen neuer Widgets zum WordPress-Admin-Dashboard. Die wichtigsten Funktionen, die Sie kennen müssen, sindwp_add_dashboard_widget() Funktion. Die Funktion benötigt mehrere Argumente:

1. $widget_id- Die eindeutige ID Ihres Widgets, die auch als id-Attribut in der HTML-Ausgabe des Widgets verwendet wird
2. $widget_name- Der Name Ihres Widgets
3. $-Rückruf- Die Funktion, die aufgerufen wird, um den Inhalt des Widgets auszugeben. Die Funktion sollte den Inhalt des Widgets wiedergeben

Darüber hinaus können Sie einige optionale Parameter angeben.

1. $control_callback- Eine optionale Funktion, die aufgerufen wird, um die Daten auszugeben, die das Steuerelement zur Konfiguration des Widgets verwendet hat, und um alle Daten zu verarbeiten, die vom Steuerelement übermittelt wurden
2. $callback_args- Array mit optionalen Parametern, die an die Callback-Funktion übergeben werden
3. $Kontext- Eine optionale Zeichenfolge, die festlegt, welche Spalten das Widget anzeigt. Der Standardwert ist "normal", aber andere Optionen sind "side", "column3" und "column4 "
4. $Priorität- Eine optionale Zeichenfolge, die die Priorität der Widgets im Kontext festlegt. Der Standardwert ist "core", aber andere Optionen sind "default", "high" und "low".

Um zu verstehen, wie es funktioniert, lassen Sie uns ein Beispiel-Dashboard-Widget erstellen

Dashboard-Widget hinzufügen

Ersteinrichtung und Ausgabe

Erstellen Sie zunächst ein neues Plugin-Verzeichnis und Plugin-PHP-Dateien im Verzeichnis wp-content/plugins. Für dieses Beispiel können Sie eswp-learn-dashboard-widgets.

Damit das Plugin als WordPress-Plugin erkannt wird, müssen Sie einen Plugin-Header hinzufügen, der mindestens einen Plugin-Namenswert enthält.

Wie bei den meisten WordPress-APIs müssen Sie zunächst eine Aktion einrichten. In diesem Fall verwenden Sie diewp_dashboard_setup RiggDiese Aktion wird ausgelöst, wenn das Dashboard initialisiert wird. Hier fügen Sie unser Widget hinzu.

add_action( 'wp_dashboard_setup', 'wp_learn_dashboard_widget' );
function wp_learn_dashboard_widget(){
    wp_add_dashboard_widget(
        wp_learn_dashboard_widget',
        WordPress Dashboard Widget lernen'.
        wp_learn_dashboard_widget_callback'
    );
}

function wp_learn_dashboard_widget_callback(){
    echo '<p>Hallo, Welt!</p>';
}

Wenn Sie diesen Code in eine leere Plugin-Datei einfügen, das Plugin aktivieren und das Dashboard laden, sehen Sie Ihr Widget am unteren Rand der ersten Spalte des Dashboards.

Ihre Content-Callback-Funktion hat eine große Flexibilität, solange sie gültigen HTML-Code zurückruft.

wp_get_recent_posts() Versuchen, Funktionen zu verwendenFügen Sie eine Liste der neuesten Beiträge zu Ihrem Widget hinzu.

function wp_learn_dashboard_widget_callback(){
    $args = array(
        'numberposts' => 5, 'post_status' => 'publish', 'post_status' => 'publish')
        'post_status' => 'veröffentlichen'
    );
    $recent_posts = wp_get_recent_posts( $args );
    echo '<ul>';
    foreach( $recent_posts as $recent ){
        echo '<li><a href="/de/' . get_permalink( $recent['ID'] ) . '/">' . $recent['post_title'] . '</a></li>';
    }
    echo '</ul>';
}

Hinzufügen von Widget-Steuerelementen

Sie können auch einige Steuerelemente hinzufügen, um Ihr Widget zu konfigurieren. Nehmen wir an, Sie möchten die Anzahl der angezeigten Beiträge steuern. Dazu konfigurieren Sie die Callback-Funktion der Steuerung.

Hinzufügen einer Funktion zum Aufrufenwp_learn_dashboard_widget_control()um die Daten zu verarbeiten.

function wp_learn_dashboard_widget_control(){
    echo 'Anzahl der anzuzeigenden Beiträge eingeben';
    echo ''; ''; }
}

Wenn Sie das Dashboard aktualisieren, scheint nichts zu passieren, aber wenn Sie den Mauszeiger über das Widget bewegen, sehen Sie einen neuen Link, der die "Konfiguration" anzeigt. Wenn Sie auf diesen Link klicken, wird das Formular angezeigt, das Sie gerade erstellt haben.

Nun müssen Sie den Callback des Steuerelements aktualisieren, um die vom Formular übermittelten Daten zu verarbeiten.

Um die Daten zu speichern, verwenden Sie dieaktualisieren_option() Funktion (math.)speichert die Funktion den Wert in der Optionstabelle.

function wp_learn_dashboard_widget_control_callback(){
    if (isset($_POST['wp_learn_dashboard_widget_numberposts'])){
        update_option( 'wp_learn_dashboard_widget_numberposts', sanitize_text_field( $_POST['wp_learn_dashboard_widget_numberposts'] ) );;
    }
    $number_posts = get_option( 'wp_learn_dashboard_widget_numberposts', 5 );
    echo 'Anzahl der anzuzeigenden Beiträge eingeben';
    echo ''; }
}

Anschließend müssen Sie zur Rückruffunktion für den Inhalt zurückkehren und das Array aktualisieren$argsum den soeben gespeicherten Wert zu verwenden. Um den Wert zu erhalten, können Sie die Funktionget_option()Funktion (math.).

function wp_learn_dashboard_widget_callback(){
    $numberposts = get_option( 'wp_learn_dashboard_widget_numberposts', 5 );
    $args = array(
        'numberposts' => $numberposts,
        'post_status' => 'veröffentlichen'
    );
    $recent_posts = wp_get_recent_posts( $args );
    echo '<ul>';
    foreach( $recent_posts as $recent ){
        echo '<li><a href="/de/' . get_permalink( $recent['ID'] ) . '/">' . $recent['post_title'] . '</a></li>';
    }
    echo '</ul>';
}

zu einem Urteil gelangen

Weitere Informationen zur Verwendung des Dashboard-Widgets, einschließlich Beispielen für die Verwendung der optionalen Callback-Parameter, Kontext- und Prioritätsparameter, finden Sie in derAbschnitt Dashboard-Widgets API.