Aputoiminto järjestelmänvalvojan ilmoituksiin

Viimeisin päivitys joulu 14, 2022

Jos aiot rakentaa laajennuksia tai jopa teemoja ja sisällytät työhösi oliopohjaisia käytäntöjä, kohtaat todennäköisesti jonkinlaisen serialisoinnin. Ja yksi serialisoinnin näkökohdista, että se vaatii jonkinlaista palautetta käyttäjältä.

Tämä voi olla onnistumisviesti, epäonnistumisviesti tai viesti, joka yksinkertaisesti varoittaa käyttäjää, että jokin meni pieleen tai jotain pitäisi ehkä päivittää.

Joka tapauksessa WordPress tarjoaa kaikki tarvitsemamme palvelut; voimme kuitenkin tehdä siitä entistä helpompaa kirjoittamalla aputoiminnon järjestelmänvalvojan ilmoituksiin. Se on myös yksinkertainen.

Järjestelmänvalvojan huomautukset: Aputoiminto

Kun on kyse järjestelmänvalvojan ilmoitusten kirjoittamisesta, on tärkeää tuntea oikea koukku.

Sieltä sinun on tiedettävä myös seuraavat luokkien nimet:

huomautus-virhe
ilmoitus – menestys
huomautus-varoitus
ilmoitus-info

Sen avulla on mahdollista kirjoittaa aputoiminto, joka käyttää yllä olevaa koukkua ja anonyymi toiminto (tai sulku) saavuttaaksesi juuri tarvitsemasi. Mutta ensin huomioi seuraavat asiat:

Anonyymit funktiot, joita kutsutaan myös sulkemisiksi, mahdollistavat funktioiden luomisen, joilla ei ole määriteltyä nimeä. Ne ovat hyödyllisimpiä takaisinsoittoparametrien arvoina, mutta niillä on monia muita käyttötarkoituksia.

Tämän jälkeen sinulla pitäisi olla kaikki mitä tarvitset avustajan kirjoittamiseen ja sinulla pitäisi olla idea tyhjentää se.

Ensin aputoiminto:

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

Oletetaan seuraavaksi, että tehty pyyntö sisältää virheellisiä tietoja. Voit käsitellä tämän käyttämällä yllä olevaa apuohjelmaa seuraavasti:

<?php

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

Kääntöpuolella sanotaan, että kaikki toimii hyvin:

<?php

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

Kuten näet, tämä toiminto käyttää alkuperäisiä WordPress-koukkuja, PHP:n ominaisuuksia ja luo myös menetelmän, joka voidaan testata yksikkötestauksella, millä on merkitystä, jos haluat kirjoittaa testattavia verkkosovelluksia WordPressiin.

Ja vaikka ei, sinulla on helpompi tapa pitää koodisi vähän kuivampana kuin ennen.

: tommcfarlin.com