Custom_Image_Header::set_header_image( mixed $choice )

Choose a header image, selected from existing uploaded and default headers, or provide an array of uploaded header data (either new, or from media library).

Parameters

$choice

(Required) Which header image to select. Allows for values of 'random-default-image', for randomly cycling among the default images; 'random-uploaded-image', for randomly cycling among the uploaded images; the key of a default image registered for that theme; and the key of an image uploaded for that theme (the attachment ID of the image). Or an array of arguments: attachment_id, url, width, height. All are required.

Source

File: wp-admin/custom-header.php 

	final public function set_header_image( $choice ) {
		if ( is_array( $choice ) || is_object( $choice ) ) {
			$choice = (array) $choice;
			if ( ! isset( $choice['attachment_id'] ) || ! isset( $choice['url'] ) )
				return;

			$choice['url'] = esc_url_raw( $choice['url'] );

			$header_image_data = (object) array(
				'attachment_id' => $choice['attachment_id'],
				'url'           => $choice['url'],
				'thumbnail_url' => $choice['url'],
				'height'        => $choice['height'],
				'width'         => $choice['width'],
			);

			update_post_meta( $choice['attachment_id'], '_wp_attachment_is_custom_header', get_stylesheet() );
			set_theme_mod( 'header_image', $choice['url'] );
			set_theme_mod( 'header_image_data', $header_image_data );
			return;
		}

		if ( in_array( $choice, array( 'remove-header', 'random-default-image', 'random-uploaded-image' ) ) ) {
			set_theme_mod( 'header_image', $choice );
			remove_theme_mod( 'header_image_data' );
			return;
		}

		$uploaded = get_uploaded_header_images();
		if ( $uploaded && isset( $uploaded[ $choice ] ) ) {
			$header_image_data = $uploaded[ $choice ];

		} else {
			$this->process_default_headers();
			if ( isset( $this->default_headers[ $choice ] ) )
				$header_image_data = $this->default_headers[ $choice ];
			else
				return;
		}

		set_theme_mod( 'header_image', esc_url_raw( $header_image_data['url'] ) );
		set_theme_mod( 'header_image_data', $header_image_data );
	}

Expand Source Code View on GitHub

Related

Uses

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

Get the header images uploaded for the current theme.
wp-includes/theme.php: set_theme_mod()

Update theme modification value for the current theme.
wp-includes/theme.php: remove_theme_mod()

Remove theme modification name from current theme list.
wp-includes/theme.php: get_stylesheet()

Retrieve name of the current stylesheet.
wp-includes/post.php: update_post_meta()

Update post meta field based on post ID.
wp-includes/formatting.php: esc_url_raw()

Performs esc_url() for database usage.
wp-admin/custom-header.php: Custom_Image_Header::process_default_headers()

Process the default headers
Show 2 more uses Hide more uses

Used By

Used By
Used By Description
wp-includes/customize/class-wp-customize-header-image-setting.php: WP_Customize_Header_Image_Setting::update()
wp-admin/custom-header.php: Custom_Image_Header::remove_header_image()

Remove a header image.
wp-admin/custom-header.php: Custom_Image_Header::take_action()

Execute custom header modification.
wp-admin/custom-header.php: Custom_Image_Header::step_2()

Display second step of custom header image page.
wp-admin/custom-header.php: Custom_Image_Header::step_3()

Display third step of custom header image page.

Changelog

Changelog
Version Description
WP-3.4.0 Introduced.