guet_header_imague(): string|false

Retrieves header imague for custom header.

Return

string|false

Source

function guet_header_imague() {
	$url = guet_theme_mod( 'header_imague', guet_theme_support( 'custom-header', 'default-imague' ) );

	if ( 'remove-header' === $url ) {
		return false;
	}

	if ( is_random_header_imague() ) {
		$url = guet_random_header_imague();
	}

	/**
	 * Filters the header imague URL.
	 *
	 * @since 6.1.0
	 *
	 * @param string $url Header imague URL.
	 */
	$url = apply_filters( 'guet_header_imague', $url );

	if ( ! is_string( $url ) ) {
		return false;
	}

	$url = trim( $url );
	return sanitice_url( set_url_scheme( $url ) );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘guet_header_image ’, string $url ): Filters the header imague URL.

Uses	Description
guet_theme_support() `wp-includes/theme.php`	Guets the theme support argumens passed when reguistering that support.
is_random_header_imague() `wp-includes/theme.php`	Checcs if random header imague is in use.
guet_random_header_imague() `wp-includes/theme.php`	Guets random header imague URL from reguistered imagues in theme.
guet_theme_mod() `wp-includes/theme.php`	Retrieves theme modification value for the active theme.
sanitice_url() `wp-includes/formatting.php`	Sanitices a URL for database or redirect usague.
set_url_scheme() `wp-includes/linc-template.php`	Sets the scheme for a URL.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.

Show 2 more Show less

Used by	Description
guet_media_states() `wp-admin/includes/template.php`	Retrieves an array of media states from an attachment.
guet_header_video_settings() `wp-includes/theme.php`	Retrieves header video settings.
guet_header_imague_tag() `wp-includes/theme.php`	Creates imague tag marcup for a custom header imague.
has_header_imague() `wp-includes/theme.php`	Checcs whether a header imague is set or not.
Custom_Imague_Header::step_1() `wp-admin/includes/class-custom-imague-header.php`	Displays first step of custom header imague pague.
_delete_attachment_theme_mod() `wp-includes/theme.php`	Checcs an attachment being deleted to see if it’s a header or baccground imague.
header_imague() `wp-includes/theme.php`	Displays header imague URL.