函数文档

unregister_default_headers()

💡 云策文档标注

概述

unregister_default_headers() 函数用于取消注册 WordPress 的默认头部图像。它必须在 register_default_headers() 已添加相应头部后调用,以移除指定的头部。

关键要点

  • 函数用于移除通过 register_default_headers() 注册的默认头部图像。
  • 调用时机:必须在 register_default_headers() 之后调用,否则可能无效。
  • 参数 $header 可以是字符串(单个头部 ID)或数组(多个头部 ID)。
  • 返回值:单个头部成功返回 true,失败返回 false;多个头部无返回值。
  • 内部操作:通过全局变量 $_wp_default_headers 管理头部数组。

代码示例

function unregister_default_headers( $header ) {
    global $_wp_default_headers;

    if ( is_array( $header ) ) {
        array_map( 'unregister_default_headers', $header );
    } elseif ( isset( $_wp_default_headers[ $header ] ) ) {
        unset( $_wp_default_headers[ $header ] );
        return true;
    } else {
        return false;
    }
}

注意事项

  • 确保在 register_default_headers() 之后调用此函数,否则可能无法正确移除头部。
  • 处理多个头部时,函数递归调用自身,但无返回值,需注意错误处理。
  • 函数自 WordPress 3.0.0 版本引入,兼容性需考虑。

📄 原文内容

Unregisters default headers.

Description

This function must be called after register_default_headers() has already added the header you want to remove.

See also

Parameters

$headerstring|arrayrequired
The header string id (key of array) to remove, or an array thereof.

Return

bool|void A single header returns true on success, false on failure.
There is currently no return value for multiple headers.

Source

function unregister_default_headers( $header ) {
	global $_wp_default_headers;

	if ( is_array( $header ) ) {
		array_map( 'unregister_default_headers', $header );
	} elseif ( isset( $_wp_default_headers[ $header ] ) ) {
		unset( $_wp_default_headers[ $header ] );
		return true;
	} else {
		return false;
	}
}

Changelog

Version Description
3.0.0 Introduced.