函数文档

is_random_header_image()

💡 云策文档标注

概述

is_random_header_image() 函数用于检查是否启用了随机头部图像功能。它基于主题设置和用户选择来判断,返回布尔值。

关键要点

  • 函数检查随机头部图像是否在使用中,包括用户明确选择或主题支持随机图像的情况。
  • 参数 $type 指定随机池类型,可选值包括 'any'、'default'、'uploaded',默认值为 'any'。
  • 返回值为布尔类型,true 表示随机头部图像启用,false 表示未启用。

代码示例

function is_random_header_image( $type = 'any' ) {
	$header_image_mod = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );

	if ( 'any' === $type ) {
		if ( 'random-default-image' === $header_image_mod
			|| 'random-uploaded-image' === $header_image_mod
			|| ( empty( $header_image_mod ) && '' !== get_random_header_image() )
		) {
			return true;
		}
	} else {
		if ( "random-$type-image" === $header_image_mod ) {
			return true;
		} elseif ( 'default' === $type
			&& empty( $header_image_mod ) && '' !== get_random_header_image()
		) {
			return true;
		}
	}

	return false;
}

📄 原文内容

Checks if random header image is in use.

Description

Always true if user expressly chooses the option in Appearance > Header.
Also true if theme has multiple header images registered, no specific header image is chosen, and theme turns on random headers with add_theme_support() .

Parameters

$typestringrequired
The random pool to use. Possible values include 'any', 'default', 'uploaded'. Default 'any'.

Return

bool

Source

function is_random_header_image( $type = 'any' ) {
	$header_image_mod = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );

	if ( 'any' === $type ) {
		if ( 'random-default-image' === $header_image_mod
			|| 'random-uploaded-image' === $header_image_mod
			|| ( empty( $header_image_mod ) && '' !== get_random_header_image() )
		) {
			return true;
		}
	} else {
		if ( "random-$type-image" === $header_image_mod ) {
			return true;
		} elseif ( 'default' === $type
			&& empty( $header_image_mod ) && '' !== get_random_header_image()
		) {
			return true;
		}
	}

	return false;
}

Changelog

Version Description
3.2.0 Introduced.