函数描述
中止 WordPress 执行并根据情况返回 HTML 信息来告诉用户为什么执行被中止了。
该函数是 PHP die()
函数的扩展,主要区别在于它可以在 Web 请求中直接向用户显示友好的 HTML 错误信息。建议仅在函数后续需要执行时使用此函数,尽量以静默方式处理错误信息。
如果确实需要停止并退出执行 PHP 脚本而不输出任何内容,可使用 exit;
。与 die()
相比,wp_die()
被设计为在终止脚本执行之前输出一些信息,以避免返回空响应或超时响应。
使用方法
<?php wp_die( $message, $title, $args ) ?>
参数
参数 | 数据类型 | 是否必需 | 描述 | 默认值 |
---|---|---|---|---|
$message | 多种 | 否 | 错误信息或一个 WP_Error 对象 | 无 |
$title | 字符串 | 否 | 错误标题,如果你使用了一个 WP_Error 对象,此标题默认添加到 $data[‘title’] ( DOING_AJAX 为 true 时忽略 ) | ” |
$args | 字符串|数组 | 否 | 控制函数行为的可选参数 ( DOING_AJAX 为 true 时忽略 ) | none |
$args 参数
response (integer) (可选) 返回的HTML状态码。 默认: 500 back_link (boolean) (可选) 是否在返回的页面中显示返回链接。 默认: false text_direction (string) (可选) 文字书写方向是 ltr 或 rtl。 默认: ‘ltr’
返回值
(void) 此函数没有返回值
使用示例
查看一个filter中 $post 变量的内容。
add_filter( 'body_class', 'add_body_class_cb' );
// Testing what is in the $post variable.
function add_body_class_cb( $classes ) {
global $post;
wp_die( '<pre>' . var_export( $post, true ) . '</pre>' );
}