wp_site_icon()

Compatibility

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

Performance profile

How much work a call to wp_site_icon() 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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

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

Instructions

7–78

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

Plugin surface

1 hook

Third-party callbacks on 'site_icon_meta_tags' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below wp_site_icon()

Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 65 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while wp_site_icon() runs, in this order:

1. 1
   apply_filters( site_icon_meta_tags )filterline 3594 (+33 into the body)

   Filters the site icon meta tags, so plugins can add their own.

Uses · 5

• has_site_icon()Determines whether the site has a Site Icon.
• is_customize_preview()Whether the site is being previewed in the Customizer.
• get_site_icon_url()Returns the Site Icon URL.
• esc_url()Checks and cleans a URL.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

View on Trac ↗View on GitHub ↗

3561function wp_site_icon() {3562	if ( ! has_site_icon() && ! is_customize_preview() ) {3563		return;3564	}3565 3566	$meta_tags = array();3567	$icon_32   = get_site_icon_url( 32 );3568	if ( empty( $icon_32 ) && is_customize_preview() ) {3569		$icon_32 = '/favicon.ico'; // Serve default favicon URL in customizer so element can be updated for preview.3570	}3571	if ( $icon_32 ) {3572		$meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="32x32" />', esc_url( $icon_32 ) );3573	}3574	$icon_192 = get_site_icon_url( 192 );3575	if ( $icon_192 ) {3576		$meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="192x192" />', esc_url( $icon_192 ) );3577	}3578	$icon_180 = get_site_icon_url( 180 );3579	if ( $icon_180 ) {3580		$meta_tags[] = sprintf( '<link rel="apple-touch-icon" href="%s" />', esc_url( $icon_180 ) );3581	}3582	$icon_270 = get_site_icon_url( 270 );3583	if ( $icon_270 ) {3584		$meta_tags[] = sprintf( '<meta name="msapplication-TileImage" content="%s" />', esc_url( $icon_270 ) );3585	}3586 3587	/**3588	 * Filters the site icon meta tags, so plugins can add their own.3589	 *3590	 * @since 4.3.03591	 *3592	 * @param string[] $meta_tags Array of Site Icon meta tags.3593	 */3594	$meta_tags = apply_filters( 'site_icon_meta_tags', $meta_tags );3595	$meta_tags = array_filter( $meta_tags );3596 3597	foreach ( $meta_tags as $meta_tag ) {3598		echo "$meta_tag\n";3599	}3600}

Changelog

Introduced in 4.3.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.8.8 tag, from src/wp-includes/general-template.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.