钩子文档

is_wp_error_instance

💡 云策文档标注

概述

本文档描述了 WordPress 中的 `is_wp_error_instance` Hook,它在 `is_wp_error()` 函数被调用且参数是 `WP_Error` 实例时触发。开发者可以利用此 Hook 在错误检查时执行自定义操作。

关键要点

  • `is_wp_error_instance` 是一个动作 Hook,在 `is_wp_error()` 函数检测到 `WP_Error` 实例时触发。
  • Hook 参数 `$thing` 是传递给 `is_wp_error()` 的错误对象,类型为 `WP_Error`。
  • 此 Hook 从 WordPress 5.6.0 版本开始引入。

代码示例

do_action( 'is_wp_error_instance', $thing );

注意事项

  • Hook 主要用于在错误检查时添加自定义逻辑,如日志记录或错误处理。
  • 确保 `$thing` 参数是有效的 `WP_Error` 实例,以避免意外行为。

📄 原文内容

Fires when is_wp_error() is called and its parameter is an instance of WP_Error.

Parameters

$thingWP_Error
The error object passed to is_wp_error().

Source

do_action( 'is_wp_error_instance', $thing );

Changelog

Version Description
5.6.0 Introduced.