is_random_header_image() – Checks if random header image is in use.

You appear to be a bot. Output may be restricted

Description

Checks if random header image is in use.

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().

Usage

$bool = is_random_header_image( $type );

Parameters

$type
( string ) optional default: any – The random pool to use. Possible values include 'any', 'default', 'uploaded'. Default 'any'.

Returns

bool

Source

File name: wordpress/wp-includes/theme.php
Lines:

1 to 20 of 20
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;
}
 

 View on GitHub View on Trac