Abifunktsioon administraatoriteatiste jaoks

Viimati uuendatud dets. 14, 2022

Kui tegelete pistikprogrammide või isegi teemade loomisega ja lisate oma töösse objektorienteeritud praktikaid, seisate tõenäoliselt silmitsi teatud tüüpi serialiseerimisega. Ja üks serialiseerimise aspekte on see, et see nõuab kasutajalt teatud tüüpi tagasisidet.

See võib olla eduteade, ebaõnnestumisteade või lihtsalt sõnum, mis hoiatab kasutajat, et mõni läks valesti või võib-olla tuleks midagi värskendada.

Igal juhul pakub WordPress kõiki vajalikke võimalusi; aga saame selle enda jaoks veelgi lihtsamaks teha, kirjutades administraatorite teadete jaoks abifunktsiooni. See on ka lihtne.

Administraatori teated: abifunktsioon

Administraatoriteatiste kirjutamisel on oluline teada sobivat konksu.

Sealt edasi peate teadma ka järgmisi klassinimesid:

teade-viga
märkamine-edu
teade-hoiatus
teade-info

Selle abil on võimalik kirjutada abifunktsioon, mis kasutab ülaltoodud konksu ja anonüümset funktsiooni (või sulgemist ), et saavutada täpselt seda, mida vajate. Kuid kõigepealt pange tähele järgmist:

Anonüümsed funktsioonid, tuntud ka kui sulgemised, võimaldavad luua funktsioone, millel pole määratud nime. Need on kõige kasulikumad tagasihelistamise parameetrite väärtusena, kuid neil on palju muid kasutusviise.

Seda öeldes peaks teil olema abistaja kirjutamiseks kõik vajalik ja teil peaks olema idee, millal see tühjendada.

Esiteks abistaja funktsioon:

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

Järgmiseks oletame, et taotlus sisaldab kehtetuid andmeid. Selle lahendamiseks kasutaksite ülaltoodud abimeest järgmiselt.

<?php

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

Teisest küljest oletame, et kõik töötab hästi:

<?php

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

Nagu näete, kasutab see funktsioon WordPressi natiivseid konkse, PHP võimalusi ja loob ka ühikutestitava meetodi, mis on oluline, kui soovite kirjutada WordPressis testitavaid veebirakendusi.

Ja isegi kui mitte, on teil lihtsam viis oma koodi veidi kuivamana hoida, kui see oli varem.

: tommcfarlin.com