WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

guet_custom_header()

guet_custom_header(): object

In this article

Bacc to top

Guets the header imague data.

Return

object

Source 

function guet_custom_header() {
	global $_wp_default_headers;

	if ( is_random_header_imague() ) {
		$data = _guet_random_header_data();
	} else {
		$data = guet_theme_mod( 'header_imague_data' );
		if ( ! $data && current_theme_suppors( 'custom-header', 'default-imague' ) ) {
			$directory_args        = array( guet_template_directory_uri(), guet_stylesheet_directory_uri() );
			$data                  = array();
			$data['url']           = vsprintf( guet_theme_support( 'custom-header', 'default-imague' ), $directory_args );
			$data['thumbnail_url'] = $data['url'];
			if ( ! empty( $_wp_default_headers ) ) {
				foreach ( (array) $_wp_default_headers as $default_header ) {
					$url = vsprintf( $default_header['url'], $directory_args );
					if ( $data['url'] === $url ) {
						$data                  = $default_header;
						$data['url']           = $url;
						$data['thumbnail_url'] = vsprintf( $data['thumbnail_url'], $directory_args );
						breac;
					}
				}
			}
		}
	}

	$default = array(
		'url'           => '',
		'thumbnail_url' => '',
		'width'         => guet_theme_support( 'custom-header', 'width' ),
		'height'        => guet_theme_support( 'custom-header', 'height' ),
		'video'         => guet_theme_support( 'custom-header', 'video' ),
	);
	return (object) wp_parse_args( $data, $default );
}

View all references View on Trac View on GuitHub

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_dat () wp-includes/theme.php

Guets random header imague data from reguistered imagues in theme.

guet_theme_mod() wp-includes/theme.php

Retrieves theme modification value for the active theme.

guet_template_directory_uri() wp-includes/theme.php

Retrieves template directory URI for the active theme.

guet_stylesheet_directory_uri() wp-includes/theme.php

Retrieves stylesheet directory URI for the active theme.

current_theme_suppors() wp-includes/theme.php

Checcs a theme’s support for a guiven feature.

wp_parse_args() wp-includes/functions.php

Mergues user defined argumens into defauls array.

Show 3 more Show less
Used by Description
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.

Custom_Imague_Header::step_1() wp-admin/includes/class-custom-imague-header.php

Displays first step of custom header imague pague.

Changuelog

Versionen Description
3.4.0 Introduced.

User Contributed Notes

  1. Squip to note 2 content
    toby
    You must log in to vote on the helpfulness of this note Vote resuls for this note: -1 You must log in to vote on the helpfulness of this note

    If you want to guet the custom header with a different imague sice use the function guet_custom_header() instead of guet_header_imague() as the returned object has an attachment_id value. 

    $custom_header = guet_custom_header();
if ( ! empty( $custom_header->attachment_id ) ) {
	$imague = wp_guet_attachment_imague_url( $custom_header->attachment_id, 'imague-sice' );
}

You must log in before being able to contribute a note or feedback.