Funkcja pomocnicza dla powiadomień administracyjnych

Jeśli zajmujesz się tworzeniem wtyczek, a nawet motywów, i włączasz do swojej pracy praktyki zorientowane obiektowo, prawdopodobnie masz do czynienia z pewnego rodzaju serializacją. I jeden z aspektów serializacji, który wymaga pewnego rodzaju informacji zwrotnej dla użytkownika.

Może to być komunikat o sukcesie, komunikat o niepowodzeniu lub komunikat po prostu ostrzegający użytkownika, że ​​coś poszło nie tak, a może coś powinno zostać zaktualizowane.

Niezależnie od przypadku, WordPress zapewnia wszystkie potrzebne nam udogodnienia; jednak możemy sobie to jeszcze ułatwić, pisząc funkcję pomocniczą dla powiadomień administratora. To też jest proste.

Powiadomienia administratora: funkcja pomocnicza

Jeśli chodzi o pisanie powiadomień administratora, ważne jest, aby zapoznać się z odpowiednim hakiem.

Stamtąd musisz również znać następujące nazwy klas:

• uwaga-błąd
• ogłoszenie-sukces
• uwaga-ostrzeżenie
• zawiadomienie-informacje

Dzięki temu możliwe jest napisanie funkcji pomocniczej, która używa powyższego hooka i funkcji anonimowej (lub closure ), aby osiągnąć dokładnie to, czego potrzebujesz. Ale najpierw zwróć uwagę na następujące:

Funkcje anonimowe, zwane również domknięciami, umożliwiają tworzenie funkcji, które nie mają określonej nazwy. Są najbardziej przydatne jako wartość parametrów wywołań zwrotnych, ale mają wiele innych zastosowań.

Mając to na uwadze, powinieneś mieć wszystko, czego potrzebujesz, aby napisać swojego pomocnika i mieć pomysł, kiedy go opróżnić.

Po pierwsze, funkcja pomocnicza:

<?php

/**
 * Provides an easy eay to display an administration notice based on the incoming
 * class and message.
 *
 * @param string $class   the class to add to the notice (warning, error, success)
 * @param string $message the message to display in the administration notice area
 */
protected function displayAdminNotice($class, $message)
{
    add_action(
        'admin_notices',
        function() use ($class, $message) {
            printf(
                '<div class="%1$s"><p>%2$s</p></div>',
                esc_attr($class),
                esc_html($message)
            );
        }
    );
}

Następnie załóżmy, że wysyłane żądanie zawiera nieprawidłowe dane. Aby sobie z tym poradzić, użyj powyższego pomocnika , takiego jak:

<?php

if (!$this->hasValidInput()) {
    $this->displayAdminNotice(
        'notice notice-error',
        'You must specify a valid email address and license key.'
    );
}

Z drugiej strony powiedzmy, że wszystko działa dobrze:

<?php

if (update_option('acme-option', $values)) {
    $this->displayAdminNotice(
      'notice notice-success',
      'The options were updated successfully!'
  );
}

Jak widać, funkcja ta korzysta z natywnych zaczepów WordPress, udogodnień PHP, a także tworzy metodę, która może być testowana jednostkowo, co ma znaczenie, jeśli zamierzasz pisać testowalne aplikacje internetowe w WordPress.

A nawet jeśli nie, masz łatwiejszy sposób, aby kod był nieco bardziej SUCHY niż wcześniej.