get_uploaded_header_images(): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

array

Performance profile

How much work a call to get_uploaded_header_images() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_posts().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

16–20

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 83.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

6

6 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_posts()called directly
• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()one call below get_uploaded_header_images()
• cacheobject cachewp_cache_get()one call below get_uploaded_header_images()
• serializeserialisationmaybe_unserialize()one call below get_uploaded_header_images()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_uploaded_header_images() can have, taken from its control-flow graph on PHP 8.5.

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 code

View on Trac ↗View on GitHub ↗

1500function get_uploaded_header_images() {1501	$header_images = array();1502 1503	// @todo Caching.1504	$headers = get_posts(1505		array(1506			'post_type'  => 'attachment',1507			'meta_key'   => '_wp_attachment_is_custom_header',1508			'meta_value' => get_option( 'stylesheet' ),1509			'orderby'    => 'none',1510			'nopaging'   => true,1511		)1512	);1513 1514	if ( empty( $headers ) ) {1515		return array();1516	}1517 1518	foreach ( (array) $headers as $header ) {1519		$url          = sanitize_url( wp_get_attachment_url( $header->ID ) );1520		$header_data  = wp_get_attachment_metadata( $header->ID );1521		$header_index = $header->ID;1522 1523		$header_images[ $header_index ]                  = array();1524		$header_images[ $header_index ]['attachment_id'] = $header->ID;1525		$header_images[ $header_index ]['url']           = $url;1526		$header_images[ $header_index ]['thumbnail_url'] = $url;1527		$header_images[ $header_index ]['alt_text']      = get_post_meta( $header->ID, '_wp_attachment_image_alt', true );1528 1529		if ( isset( $header_data['attachment_parent'] ) ) {1530			$header_images[ $header_index ]['attachment_parent'] = $header_data['attachment_parent'];1531		} else {1532			$header_images[ $header_index ]['attachment_parent'] = '';1533		}1534 1535		if ( isset( $header_data['width'] ) ) {1536			$header_images[ $header_index ]['width'] = $header_data['width'];1537		}1538		if ( isset( $header_data['height'] ) ) {1539			$header_images[ $header_index ]['height'] = $header_data['height'];1540		}1541	}1542 1543	return $header_images;1544}

Changelog

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.7.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.