get_header_image_tag( array $attr = array() ): string

Parameters

$attrarrayoptional

Additional attributes for the image tag. Can be used to override the default attributes. Default empty.Default: array()

Return

string

HTML image element markup or empty string on failure.

Hooks fired · 2

2 hooks fire while get_header_image_tag() runs, in this order:

1. 1
   apply_filters( get_header_image_tag_attributes )filterline 1350 (+83 into the body)

   Filters the list of header image attributes.

2. 2
   apply_filters( get_header_image_tag )filterline 1370 (+103 into the body)

   Filters the markup of header images.

Uses · 9

• get_custom_header()Gets the header image data.
• get_header_image()Retrieves header image for custom header.
• absint()Converts a value to non-negative integer.
• get_post_meta()Retrieves a post meta field for the given post ID.
• wp_parse_args()Merges user defined arguments into defaults array.
• wp_calculate_image_srcset()A helper function to calculate the image sources to include in a 'srcset' attribute.
• wp_calculate_image_sizes()Creates a 'sizes' attribute value for an image.
• wp_get_loading_optimization_attributes()Gets loading optimization attributes.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• get_custom_header_markup()Retrieves the markup for a custom header.
• the_header_image_tag()Displays the image markup for a custom header image.

Source

View on Trac ↗View on GitHub ↗

1267function get_header_image_tag( $attr = array() ) {1268	$header      = get_custom_header();1269	$header->url = get_header_image();1270 1271	if ( ! $header->url ) {1272		return '';1273	}1274 1275	$width  = absint( $header->width );1276	$height = absint( $header->height );1277	$alt    = '';1278 1279	// Use alternative text assigned to the image, if available. Otherwise, leave it empty.1280	if ( ! empty( $header->attachment_id ) ) {1281		$image_alt = get_post_meta( $header->attachment_id, '_wp_attachment_image_alt', true );1282 1283		if ( is_string( $image_alt ) ) {1284			$alt = $image_alt;1285		}1286	}1287 1288	$attr = wp_parse_args(1289		$attr,1290		array(1291			'src'    => $header->url,1292			'width'  => $width,1293			'height' => $height,1294			'alt'    => $alt,1295		)1296	);1297 1298	// Generate 'srcset' and 'sizes' if not already present.1299	if ( empty( $attr['srcset'] ) && ! empty( $header->attachment_id ) ) {1300		$image_meta = get_post_meta( $header->attachment_id, '_wp_attachment_metadata', true );1301		$size_array = array( $width, $height );1302 1303		if ( is_array( $image_meta ) ) {1304			$srcset = wp_calculate_image_srcset( $size_array, $header->url, $image_meta, $header->attachment_id );1305 1306			if ( ! empty( $attr['sizes'] ) ) {1307				$sizes = $attr['sizes'];1308			} else {1309				$sizes = wp_calculate_image_sizes( $size_array, $header->url, $image_meta, $header->attachment_id );1310			}1311 1312			if ( $srcset && $sizes ) {1313				$attr['srcset'] = $srcset;1314				$attr['sizes']  = $sizes;1315			}1316		}1317	}1318 1319	$attr = array_merge(1320		$attr,1321		wp_get_loading_optimization_attributes( 'img', $attr, 'get_header_image_tag' )1322	);1323 1324	/*1325	 * If the default value of `lazy` for the `loading` attribute is overridden1326	 * to omit the attribute for this image, ensure it is not included.1327	 */1328	if ( isset( $attr['loading'] ) && ! $attr['loading'] ) {1329		unset( $attr['loading'] );1330	}1331 1332	// If the `fetchpriority` attribute is overridden and set to false or an empty string.1333	if ( isset( $attr['fetchpriority'] ) && ! $attr['fetchpriority'] ) {1334		unset( $attr['fetchpriority'] );1335	}1336 1337	// If the `decoding` attribute is overridden and set to false or an empty string.1338	if ( isset( $attr['decoding'] ) && ! $attr['decoding'] ) {1339		unset( $attr['decoding'] );1340	}1341 1342	/**1343	 * Filters the list of header image attributes.1344	 *1345	 * @since 5.9.01346	 *

History

Introduced in 4.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.0.4 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.