is_random_header_image( string $type = 'any' )

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

$type

(string) (Optional) The random pool to use. Possible values include 'any', 'default', 'uploaded'.

Default value: 'any'

Return

(bool)

Source

File: wp-includes/theme.php 

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
			|| ( '' !== get_random_header_image() && empty( $header_image_mod ) )
		) {
			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;
}

Uses

Uses Description
wp-includes/theme.php: get_theme_support()

Gets the theme support arguments passed when registering that support.
wp-includes/theme.php: get_random_header_image()

Gets random header image URL from registered images in theme.
wp-includes/theme.php: get_theme_mod()

Retrieves theme modification value for the current theme.

Changelog

Version Description
3.2.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/is_random_header_image