get_uploaded_header_images(): array

Return

array

Uses · 6

• get_posts()Retrieves an array of the latest posts, or posts matching the given criteria.
• get_option()Retrieves an option value based on an option name.
• sanitize_url()Sanitizes a URL for database or redirect usage.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• get_post_meta()Retrieves a post meta field for the given post ID.

Used by · 6

• Custom_Image_Header::get_uploaded_header_images()Gets the previously uploaded header images.
• Custom_Image_Header::set_header_image()Chooses a header image, selected from existing uploaded and default headers, or provides an array of uploaded header data (either new, or from media library).
• Custom_Image_Header::show_header_selector()Displays UI for selecting one of several default headers.
• Custom_Image_Header::step_1()Displays first step of custom header image page.
• _get_random_header_data()Gets random header image data from registered images in theme.
• get_media_states()Retrieves an array of media states from an attachment.

Source

View on Trac ↗View on GitHub ↗

1513function get_uploaded_header_images() {1514	$header_images = array();1515 1516	$headers = get_posts(1517		array(1518			'post_type'  => 'attachment',1519			'meta_key'   => '_wp_attachment_is_custom_header',1520			'meta_value' => get_option( 'stylesheet' ),1521			'orderby'    => 'none',1522			'nopaging'   => true,1523		)1524	);1525 1526	if ( empty( $headers ) ) {1527		return array();1528	}1529 1530	foreach ( (array) $headers as $header ) {1531		$url          = sanitize_url( wp_get_attachment_url( $header->ID ) );1532		$header_data  = wp_get_attachment_metadata( $header->ID );1533		$header_index = $header->ID;1534 1535		$header_images[ $header_index ]                  = array();1536		$header_images[ $header_index ]['attachment_id'] = $header->ID;1537		$header_images[ $header_index ]['url']           = $url;1538		$header_images[ $header_index ]['thumbnail_url'] = $url;1539		$header_images[ $header_index ]['alt_text']      = get_post_meta( $header->ID, '_wp_attachment_image_alt', true );1540 1541		if ( isset( $header_data['attachment_parent'] ) ) {1542			$header_images[ $header_index ]['attachment_parent'] = $header_data['attachment_parent'];1543		} else {1544			$header_images[ $header_index ]['attachment_parent'] = '';1545		}1546 1547		if ( isset( $header_data['width'] ) ) {1548			$header_images[ $header_index ]['width'] = $header_data['width'];1549		}1550		if ( isset( $header_data['height'] ) ) {1551			$header_images[ $header_index ]['height'] = $header_data['height'];1552		}1553	}1554 1555	return $header_images;1556}

History

Introduced in 3.2.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 6.9.7 tag, from src/wp-includes/theme.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.