WordPress 的 WP_Error 類：優(yōu)雅的錯誤處理機制

WordPress 的 WP_Error 類提供了一種簡單而強大的錯誤處理機制，用于管理和修改應(yīng)用程序中的錯誤。它易于集成到你的應(yīng)用程序中，有效處理 WordPress 核心函數(shù)返回的錯誤，并創(chuàng)建自定義錯誤消息，提升用戶體驗。此外，is_wp_error 等實用函數(shù)可以檢查變量或函數(shù)返回值是否為 WP_Error 實例，從而高效地調(diào)試問題。

無論你的代碼編寫多么熟練和細(xì)致，在任何開發(fā)過程中都無法避免錯誤。作為 WordPress 開發(fā)者，你的職責(zé)是確保所有代碼錯誤得到正確處理，而不會影響最終用戶。WordPress 自帶一個基本的錯誤處理類 WP_Error，可以將其集成到你的代碼中進行基本的錯誤處理。

本教程將探討 WP_Error 類的基本結(jié)構(gòu)、工作原理，最重要的是，我們將介紹如何在應(yīng)用程序中集成 WP_Error 類。

WP_Error 類詳解

WP_Error 類的結(jié)構(gòu)簡單卻功能強大，足以用作插件的錯誤處理機制。其源代碼位于 wp-includes/class-wp-error.php 文件中。讓我們來看看它的屬性和方法。

屬性

WP_Error 只有兩個私有屬性：$errors 和 $error_data。$errors 用于存儲相關(guān)的錯誤消息，而 $error_data 可選用于存儲你稍后要訪問的相關(guān)數(shù)據(jù)。WP_Error 使用簡單的鍵值對將相關(guān)的錯誤和數(shù)據(jù)存儲到對象中，因此在 WP_Error 中定義的鍵必須是唯一的，以避免覆蓋先前定義的鍵。

方法

WP_Error 提供多種方法來修改其包含的兩個屬性。讓我們來看幾個：

• get_error_codes()：返回特定 WP_Error 實例的所有可用錯誤代碼。如果只需要第一個錯誤代碼，可以使用另一個單獨的函數(shù) get_error_code()。
• get_error_messages( $code )：如果沒有提供 $code，該函數(shù)將簡單地返回特定 WP_Error 實例中存儲的所有消息。同樣，如果只需要返回特定錯誤代碼的消息，只需使用 get_error_message( $code )。
• add( $code, $message, $data )：此函數(shù)在想要修改已實例化的 WP_Error 對象中存儲的錯誤時特別有用。請注意，即使 $message 和 $data 不是必需的，$errors 變量仍將被填充。
• add_data( $data, $code)：如果你只想修改 $error_data 屬性，可以使用此函數(shù)。請注意，$code 參數(shù)位于第二個位置，與 add 方法相反。如果沒有提供 $code，錯誤數(shù)據(jù)將添加到第一個錯誤代碼。
• remove( $code )：這是最近在 WordPress 4.1 中添加的一種新方法，它刪除與特定鍵關(guān)聯(lián)的所有錯誤消息和數(shù)據(jù)。

函數(shù)

如何知道函數(shù)返回的特定變量或數(shù)據(jù)是否是 WP_Error 的實例？可以使用一個實用函數(shù) is_wp_error() 來檢查，它根據(jù)給定的變量返回 true 或 false。

• is_wp_error( $thing )：如果 $thing 是 WP_Error 實例，則返回 true，否則返回 false。

在你的應(yīng)用中實現(xiàn) WP_Error

僅僅了解 WP_Error 的內(nèi)部工作原理是不夠的，你還需要學(xué)習(xí)如何在自己的應(yīng)用程序中很好地實現(xiàn)它。讓我們通過幾個例子來更好地了解它的工作原理。

處理 WordPress 核心函數(shù)返回的錯誤

WordPress 提供了許多實用函數(shù)，可以用來加快我們的開發(fā)進程。大多數(shù)函數(shù)也配備了我們可以使用的基本錯誤處理功能。

例如，wp_remote_post 是一個非常有用的函數(shù)，我們可以用它向特定 URL 發(fā)出遠(yuǎn)程 POST 請求。但是，我們不能指望遠(yuǎn)程 URL 總是可訪問的，或者我們的請求總是成功的。我們從手冊頁面知道，此函數(shù)在失敗時將返回 WP_Error。此知識將幫助我們在應(yīng)用程序中正確實現(xiàn)錯誤處理。

請看這段代碼：

// 向遠(yuǎn)程 URL $url 發(fā)出請求
$response = wp_remote_post( $url, array(
    'timeout' => 30,
    'body' => array( 'foo' => 'bar' )
    )
);

if ( is_wp_error( $response ) ) {
   echo 'ERROR: ' . $response->get_error_message();
} else {
    // 執(zhí)行某些操作
}

如你所見，我們正在向 $url 執(zhí)行遠(yuǎn)程 POST 請求。但是，我們并不簡單地按原樣獲取 $response 數(shù)據(jù)，而是使用前面介紹過的方便的 is_wp_error 函數(shù)進行一些檢查。如果一切正常，我們才能繼續(xù)執(zhí)行我們想對 $response 執(zhí)行的操作。

在你的應(yīng)用程序中返回自定義錯誤

假設(shè)你有一個處理聯(lián)系表單提交的自定義函數(shù)，名為 handle_form_submission。假設(shè)我們在某個地方設(shè)置了一個自定義表單，讓我們看看如何通過實現(xiàn)我們自己的錯誤處理功能來改進該函數(shù)。

// 向遠(yuǎn)程 URL $url 發(fā)出請求
$response = wp_remote_post( $url, array(
    'timeout' => 30,
    'body' => array( 'foo' => 'bar' )
    )
);

if ( is_wp_error( $response ) ) {
   echo 'ERROR: ' . $response->get_error_message();
} else {
    // 執(zhí)行某些操作
}

當(dāng)然，你還需要在這些函數(shù)中實現(xiàn)你自己的清理和驗證，但這不在本教程的討論范圍之內(nèi)?，F(xiàn)在，知道我們在錯誤時正確返回 WP_Error 實例后，我們可以用它向最終用戶提供更有意義的錯誤消息。

假設(shè)你的應(yīng)用程序中有一個特定部分用于顯示表單提交錯誤，你可以這樣做：

function handle_form_submission() {
    // 在此處執(zhí)行你的驗證、nonce 等操作

    // 實例化 WP_Error 對象
    $error = new WP_Error();

    // 確保用戶提供名字
    if ( empty( $_POST['first_name'] ) ) {
        $error->add( 'empty', 'First name is required' );
    }

    // 也需要姓氏
    if ( empty( $_POST['last_name'] ) ) {
        $error->add( 'empty', 'Last name is required' );
    }

    // 檢查電子郵件地址
    if ( empty( $_POST['email'] ) ) {
        $error->add( 'empty', 'Email is required' );
    } elseif ( ! is_email( $_POST['email'] ) ) {
        $error->add( 'invalid', 'Email address must be valid' );
    }

    // 最后，檢查消息
    if ( empty( $_POST['message'] ) ) {
        $error->add( 'empty', 'Your message is required' );
    }

    // 發(fā)送結(jié)果
    if ( empty( $error->get_error_codes() ) ) {
        return true; // 沒有錯誤
    }

    // 有錯誤
    return $error;
}

總結(jié)

在軟件開發(fā)中精益求精也意味著要知道當(dāng)你的代碼無法執(zhí)行其應(yīng)執(zhí)行的操作時該怎么做，并確保你的應(yīng)用程序能夠優(yōu)雅地處理它。

就 WordPress 而言，使用自帶的 WP_Error 類提供了一種相當(dāng)簡單但功能強大的錯誤處理實現(xiàn)，你可以將其集成到你的應(yīng)用程序中。

(此處省略了原文中的外部參考和常見問題解答部分，因為它們是原文的直接復(fù)制，不符合偽原創(chuàng)的要求。)

以上是WP_ERROR課程的簡介的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！