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

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

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

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

WP_Error 類詳解

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

屬性

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

方法

WP_Error 提供多種方法來(lái)修改其包含的兩個(gè)屬性。讓我們來(lái)看幾個(gè)：

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

函數(shù)

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

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

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

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

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

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

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

請(qǐng)看這段代碼：

// 向遠(yuǎn)程 URL $url 發(fā)出請(qǐng)求
$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 請(qǐng)求。但是，我們並不簡(jiǎn)單地按原樣獲取 $response 數(shù)據(jù)，而是使用前面介紹過(guò)的方便的 is_wp_error 函數(shù)進(jìn)行一些檢查。如果一切正常，我們才能繼續(xù)執(zhí)行我們想對(duì) $response 執(zhí)行的操作。

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

假設(shè)你有一個(gè)處理聯(lián)繫表單提交的自定義函數(shù)，名為 handle_form_submission。假設(shè)我們?cè)谀硞€(gè)地方設(shè)置了一個(gè)自定義表單，讓我們看看如何通過(guò)實(shí)現(xiàn)我們自己的錯(cuò)誤處理功能來(lái)改進(jìn)該函數(shù)。

// 向遠(yuǎn)程 URL $url 發(fā)出請(qǐng)求
$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ù)中實(shí)現(xiàn)你自己的清理和驗(yàn)證，但這不在本教程的討論範(fàn)圍之內(nèi)?，F(xiàn)在，知道我們?cè)阱e(cuò)誤時(shí)正確返回 WP_Error 實(shí)例後，我們可以用它向最終用戶提供更有意義的錯(cuò)誤消息。

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

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

    // 實(shí)例化 WP_Error 對(duì)象
    $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; // 沒(méi)有錯(cuò)誤
    }

    // 有錯(cuò)誤
    return $error;
}

總結(jié)

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

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

(此處省略了原文中的外部參考和常見問(wèn)題解答部分，因?yàn)樗鼈兪窃牡闹苯友}製，不符合偽原創(chuàng)的要求。)

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