Custom_Image_Header::set_header_image( mixed $choice )

Parameters

$choicemixed

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.

Uses · 7

• sanitize_url()Sanitizes a URL for database or redirect usage.
• update_post_meta()Updates a post meta field based on the given post ID.
• get_stylesheet()Retrieves name of the current stylesheet.
• set_theme_mod()Updates theme modification value for the active theme.
• remove_theme_mod()Removes theme modification name from active theme list.
• get_uploaded_header_images()Gets the header images uploaded for the active theme.
• Custom_Image_Header::process_default_headers()Processes the default headers.

Used by · 4

• Custom_Image_Header::remove_header_image()Removes a header image.
• Custom_Image_Header::step_2()Displays second step of custom header image page.
• Custom_Image_Header::step_3()Displays third step of custom header image page.
• Custom_Image_Header::take_action()Executes custom header modification.

Source

View on Trac ↗View on GitHub ↗

1173	final public function set_header_image( $choice ) {1174		if ( is_array( $choice ) || is_object( $choice ) ) {1175			$choice = (array) $choice;1176 1177			if ( ! isset( $choice['attachment_id'] ) || ! isset( $choice['url'] ) ) {1178				return;1179			}1180 1181			$choice['url'] = sanitize_url( $choice['url'] );1182 1183			$header_image_data = (object) array(1184				'attachment_id' => $choice['attachment_id'],1185				'url'           => $choice['url'],1186				'thumbnail_url' => $choice['url'],1187				'height'        => $choice['height'],1188				'width'         => $choice['width'],1189			);1190 1191			update_post_meta( $choice['attachment_id'], '_wp_attachment_is_custom_header', get_stylesheet() );1192 1193			set_theme_mod( 'header_image', $choice['url'] );1194			set_theme_mod( 'header_image_data', $header_image_data );1195 1196			return;1197		}1198 1199		if ( in_array( $choice, array( 'remove-header', 'random-default-image', 'random-uploaded-image' ), true ) ) {1200			set_theme_mod( 'header_image', $choice );1201			remove_theme_mod( 'header_image_data' );1202 1203			return;1204		}1205 1206		$uploaded = get_uploaded_header_images();1207 1208		if ( $uploaded && isset( $uploaded[ $choice ] ) ) {1209			$header_image_data = $uploaded[ $choice ];1210		} else {1211			$this->process_default_headers();1212			if ( isset( $this->default_headers[ $choice ] ) ) {1213				$header_image_data = $this->default_headers[ $choice ];1214			} else {1215				return;1216			}1217		}1218 1219		set_theme_mod( 'header_image', sanitize_url( $header_image_data['url'] ) );1220		set_theme_mod( 'header_image_data', $header_image_data );1221	}

History

Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-custom-image-header.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.