get_site_icon_url() WordPress Function

The get_site_icon_url() function allows you to retrieve the URL of a site icon, also known as a favicon. A favicon is a small image that is displayed in the browser's address bar next to the site's URL. The get_site_icon_url() function returns the URL of the favicon for the current site.

get_site_icon_url( int $size = 512, string $url = '', int $blog_id ) #

Returns the Site Icon URL.


Parameters

$size

(int)(Optional) Size of the site icon. Default 512 (pixels).

Default value: 512

$url

(string)(Optional) Fallback url if no site icon is found.

Default value: ''

$blog_id

(int)(Optional) ID of the blog to get the site icon for. Default current blog.


Top ↑

Return

(string) Site Icon URL.


Top ↑

Source

File: wp-includes/general-template.php

function get_site_icon_url( $size = 512, $url = '', $blog_id = 0 ) {
	$switched_blog = false;

	if ( is_multisite() && ! empty( $blog_id ) && get_current_blog_id() !== (int) $blog_id ) {
		switch_to_blog( $blog_id );
		$switched_blog = true;
	}

	$site_icon_id = get_option( 'site_icon' );

	if ( $site_icon_id ) {
		if ( $size >= 512 ) {
			$size_data = 'full';
		} else {
			$size_data = array( $size, $size );
		}
		$url = wp_get_attachment_image_url( $site_icon_id, $size_data );
	}

	if ( $switched_blog ) {
		restore_current_blog();
	}

	/**
	 * Filters the site icon URL.
	 *
	 * @since 4.4.0
	 *
	 * @param string $url     Site icon URL.
	 * @param int    $size    Size of the site icon.
	 * @param int    $blog_id ID of the blog to get the site icon for.
	 */
	return apply_filters( 'get_site_icon_url', $url, $size, $blog_id );
}


Top ↑

Changelog

Changelog
VersionDescription
4.3.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More