Una función de ayuda para los avisos de administración

Si está en el negocio de crear complementos, o incluso temas, y está incorporando prácticas orientadas a objetos en su trabajo, es probable que se enfrente a algún tipo de serialización. Y uno de los aspectos de la serialización que requiere algún tipo de retroalimentación para el usuario.

Este puede ser un mensaje de éxito, un mensaje de falla o simplemente un mensaje que advierte al usuario que algo salió mal o quizás algo debería actualizarse.

En cualquier caso, WordPress proporciona todas las facilidades que necesitamos; sin embargo, podemos hacerlo aún más fácil escribiendo una función de ayuda para los avisos de administración. Es simple, también.

Avisos de administración: una función auxiliar

Cuando se trata de escribir avisos de administración, es importante familiarizarse con el gancho apropiado.

A partir de ahí, también necesita saber los siguientes nombres de clase:

• aviso-error
• aviso-éxito
• aviso-advertencia
• aviso-info

Con eso, es posible escribir una función de ayuda que use el enlace anterior y una función anónima (o un cierre) para lograr exactamente lo que necesita. Pero primero tenga en cuenta lo siguiente:

Las funciones anónimas, también conocidas como cierres, permiten la creación de funciones que no tienen un nombre específico. Son más útiles como el valor de los parámetros de devolución de llamada, pero tienen muchos otros usos.

Dicho esto, debe tener todo lo que necesita para escribir su ayudante y tener una idea de cuándo vaciarlo.

Primero, la función auxiliar:

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

A continuación, digamos que la solicitud que se está realizando contiene datos no válidos. Para manejar esto, usaría el ayudante anterior como el siguiente:

<?php

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

Por otro lado, digamos que todo funciona bien:

<?php

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

Como puede ver, esta función utiliza ganchos nativos de WordPress, instalaciones de PHP y también crea un método que se puede probar de forma unitaria, lo que es importante si tiene como objetivo escribir aplicaciones web comprobables en WordPress.

E incluso si no, tiene una manera más fácil de mantener su código un poco más SECO que antes.