Una funzione di supporto per gli avvisi dell’amministratore

Se ti occupi della creazione di plug-in, o anche di temi, e stai incorporando pratiche orientate agli oggetti nel tuo lavoro, è probabile che ti trovi di fronte a una serializzazione di qualche tipo. E uno degli aspetti della serializzazione che richiede un qualche tipo di feedback per l’utente.

Questo può essere un messaggio di successo, un messaggio di errore o un messaggio che avverte semplicemente l’utente che qualcosa è andato storto o forse qualcosa dovrebbe essere aggiornato.

In ogni caso, WordPress fornisce tutte le strutture di cui abbiamo bisogno; tuttavia, possiamo renderlo ancora più semplice scrivendo una funzione di supporto per gli avvisi dell’amministratore. È anche semplice.

Avvisi dell’amministratore: una funzione di supporto

Quando si tratta di scrivere avvisi di amministrazione, è importante familiarizzare con l’hook appropriato.

Da lì, devi anche conoscere i seguenti nomi di classe:

• errore di avviso
• avviso-successo
• avviso-avviso
• avviso-info

Con ciò, è possibile scrivere una funzione di supporto che utilizzi l’hook sopra e una funzione anonima (o una chiusura) per ottenere esattamente ciò di cui hai bisogno. Ma prima nota quanto segue:

Le funzioni anonime, note anche come chiusure, consentono la creazione di funzioni che non hanno un nome specificato. Sono molto utili come valore dei parametri di callback, ma hanno molti altri usi.

Detto questo, dovresti avere tutto il necessario per scrivere il tuo helper e avere un’idea su quando svuotarlo.

Innanzitutto, la funzione di supporto:

<?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)
            );
        }
    );
}

Quindi, supponiamo che la richiesta che viene effettuata contenga dati non validi. Per gestire questo, useresti l’helper sopra come il seguente:

<?php

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

D’altra parte, diciamo che tutto funziona bene:

<?php

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

Come puoi vedere, questa funzione utilizza hook nativi di WordPress, funzionalità di PHP e crea anche un metodo che può essere testato in unità, il che è importante se stai mirando a scrivere applicazioni Web testabili in WordPress.

E anche in caso contrario, hai un modo più semplice per mantenere il tuo codice un po’ più ASCIUTTO di prima.