wp_site_icon() WordPress Function
The wp_site_icon function enables a user to set a custom site icon (also known as a favicon) for their WordPress site. This icon can be displayed in a browser's URL bar, on bookmark lists, and next to the site's name in search results. To set a custom site icon, a user first needs to upload an image to their WordPress site. This image should be square and have a minimum size of 512 pixels. Once the image is uploaded, the user can then use the wp_site_icon function to set it as their site's icon. Custom site icons can be a great way to make your WordPress site more recognizable and memorable. If you're looking to set a custom icon for your site, the wp_site_icon function is the way to do it.
wp_site_icon() #
Display site icon meta tags.
Source
File: wp-includes/general-template.php
function wp_site_icon() {
if ( ! has_site_icon() && ! is_customize_preview() ) {
return;
}
$meta_tags = array();
$icon_32 = get_site_icon_url( 32 );
if ( empty( $icon_32 ) && is_customize_preview() ) {
$icon_32 = '/favicon.ico'; // Serve default favicon URL in customizer so element can be updated for preview.
}
if ( $icon_32 ) {
$meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="32x32" />', esc_url( $icon_32 ) );
}
$icon_192 = get_site_icon_url( 192 );
if ( $icon_192 ) {
$meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="192x192" />', esc_url( $icon_192 ) );
}
$icon_180 = get_site_icon_url( 180 );
if ( $icon_180 ) {
$meta_tags[] = sprintf( '<link rel="apple-touch-icon" href="%s" />', esc_url( $icon_180 ) );
}
$icon_270 = get_site_icon_url( 270 );
if ( $icon_270 ) {
$meta_tags[] = sprintf( '<meta name="msapplication-TileImage" content="%s" />', esc_url( $icon_270 ) );
}
/**
* Filters the site icon meta tags, so plugins can add their own.
*
* @since 4.3.0
*
* @param string[] $meta_tags Array of Site Icon meta tags.
*/
$meta_tags = apply_filters( 'site_icon_meta_tags', $meta_tags );
$meta_tags = array_filter( $meta_tags );
foreach ( $meta_tags as $meta_tag ) {
echo "$meta_tag\n";
}
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.3.0 | Introduced. |