云策 WordPress 开发者社区

函数文档

has_custom_header()

查看官方原文 ↗
💡 云策文档标注

概述

has_custom_header() 函数用于检查 WordPress 主题中是否设置了自定义页眉（包括图像或视频）。它返回布尔值，帮助开发者判断自定义页眉的可用性。

关键要点

  • 函数返回 true 如果设置了自定义页眉图像，或者设置了自定义页眉视频且视频在当前页面可激活。
  • 函数返回 false 如果未设置自定义页眉。
  • 内部实现依赖于 has_header_image()、has_header_video() 和 is_header_video_active() 函数。

代码示例

if ( has_custom_header() ) {
    // 自定义页眉已设置，执行相关操作
    echo get_custom_header_markup();
} else {
    // 自定义页眉未设置，使用默认页眉或备用内容
    echo 'No custom header set.';
}

注意事项

  • 此函数从 WordPress 4.7.0 版本开始引入。
  • 相关函数包括 has_header_video()、is_header_video_active() 和 has_header_image()，用于更细粒度的检查。
  • get_custom_header_markup() 函数可用于获取自定义页眉的标记，通常与 has_custom_header() 结合使用。
📄 原文内容

Checks whether a custom header is set or not.

Return

bool True if a custom header is set. False if not.

Source

function has_custom_header() {
	if ( has_header_image() || ( has_header_video() && is_header_video_active() ) ) {
		return true;
	}

	return false;
}

View all references View on Trac View on GitHub

Uses Description
has_header_video()wp-includes/theme.php

Checks whether a header video is set or not.
is_header_video_active()wp-includes/theme.php

Checks whether the custom header video is eligible to show on the current page.
has_header_image()wp-includes/theme.php

Checks whether a header image is set or not.
Used by Description
get_custom_header_markup()wp-includes/theme.php

Retrieves the markup for a custom header.

Changelog

Version Description
4.7.0 Introduced.