Jak funguje WP_Error třída ve WordPressu

Ve WordPressu se často setkáváme s potřebou efektivně zpracovávat chyby. Pro tento účel existuje třída WP_Error, která poskytuje robustní způsob, jak pracovat s chybami v různých částech systému. V tomto článku si podrobně popíšeme, jak tato třída funguje, jak ji použít v praxi a jaké funkce nabízí.

Základy třídy WP_Error

Třída WP_Error je definována v jádru WordPressu a používá se k uchování informací o chybách. Umožňuje snadno přidávat, načítat a odstraňovat chyby a jejich související data.

Vytvoření instance WP_Error

Chcete-li vytvořit novou instanci třídy WP_Error, použijete následující kód:

$error = new WP_Error();

Přidání chyby

K přidání chyby do instance WP_Error použijete metodu add. Tato metoda přijímá tři parametry:

1. code – Identifikátor chyby (řetězec).
2. message – Popis chyby (řetězec).
3. data – Volitelný parametr pro doplňující data (jakýkoli typ).

$error->add('invalid_email', 'E-mailová adresa je neplatná.');
$error->add('user_not_found', 'Uživatel nebyl nalezen.', array('user_id' => 123));

Získání chyby

Pro získání chybového hlášení můžete použít metodu get_error_message, která vrací zprávu o první chybě nebo specifické chybě na základě kódu:

echo $error->get_error_message(); // Vrátí 'E-mailová adresa je neplatná.'
echo $error->get_error_message('user_not_found'); // Vrátí 'Uživatel nebyl nalezen.

Kontrola na chyby

Pro ověření, zda instance obsahuje chyby, můžete použít metodu has_errors nebo is_wp_error:

if ($error->has_errors()) {
    // Provést nějaké kroky při chybě
}

if (is_wp_error($error)) {
    // Provést nějaké kroky při chybě
}

Praktické použití WP_Error

Třída WP_Error se často používá v kontextu vlastních funkcí, kde chcete vrátit chybový stav. Například:

Funkce související s WP_Error

WordPress poskytuje několik funkcí, které usnadňují práci s chybami:

function my_custom_function($input) {
    if (empty($input)) {
        return new WP_Error('empty_input', 'Vstup nesmí být prázdný.');
    }

    // Dále pokračuje logika funkce
    return true;
}

$result = my_custom_function('');

if (is_wp_error($result)) {
    echo $result->get_error_message(); // Zobrazí 'Vstup nesmí být prázdný.'
}

• is_wp_error($thing) – Zkontroluje, zda je proměnná instance WP_Error.
• wp_die($message, $title = '', $args = array()) – Ukončí skript a zobrazí chybovou zprávu (lze použít pro zobrazení chyby WP_Error).

Závěr

Třída WP_Error je mocný nástroj pro správu chyb v WordPressu. Umožňuje strukturovaně přidávat, získávat a zpracovávat chyby, což je klíčové pro vývoj robustních a udržovatelných pluginů a témat. Doufáme, že tento článek vám poskytl potřebné znalosti pro efektivní využívání třídy WP_Error ve vašich projektech.