Fehlermeldungen mit WordPress Settings API

WordPress‘ Settings API macht es einem recht einfach, im Adminbereich Fehlermeldungen und/oder Hinweise anzuzeigen.

Um WordPress wissen zu lassen, dass du eine Nachricht anzeigen willst, rufe die add_settings_error() Funktion auf:

add_settings_error( $setting, $code, $message, $type );

Fehlermeldung im WordPress Admin
Diese Funktion fügt die Nachricht zu einer Schlange hinzu, die mit dem Slug in Verbindung steht, welcher mit dem ersten Parameter übergeben wird. Man kann mehrere Nachrichten einem Slug zuordnen, die dann untereinander angezeigt werden. Der zweite Parameter spezifiziert einen eindeutigen Fehlercode, welcher dem id Attribut im <div>-Kontainer hinzugefügt wird (also das escapen bitte nicht vergessen). Dann wird die eigentliche Nachricht übergeben. Und mit dem letzten Parameter kann bestimmt werden, ob es sich um eine Fehlermeldung oder einen Hinweis handelt. Der Standard ist 'error'.

Dann lasst uns einen Hinweis hinzufügen:

add_settings_error(
    'unique_identifyer',
    esc_attr('settings_updated'),
    __('Settings saved.'),
    'updated'
);

Bei jedem Laden einer Adminseite wird der admin_notices Hook aufgerufen und gibt Plugin- und Themeautoren die Möglichkeit ihre Nachrichten hinzuzufügen und anzuzeigen. Und so geht’s:

function unique_identifyer_admin_notices() {
    settings_errors( 'unique_identifyer' );
}
add_action( 'admin_notices', 'unique_identifyer_admin_notices' );

Alle Parameter der settings_error() Funktion sind zwar optional, aber nachdem man warscheinlich nur seine registrierten Nachrichten anzeigen lassen möchte, sollte immer der Slug mit übergeben werden, welcher beim Hinzufügen der Nachricht angegeben wurde.

Und das ist auch schon alles! Zwei einfache Funktionen um Fehlermeldungen und Hinweise im Adminbereich hinzuzufügen und anzuzeigen. Probiere es doch mal aus und lass mich wissen was du denkst!

Schreibe einen Kommentar

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