函数文档

site_icon_url()

💡 云策文档标注

概述

site_icon_url() 是一个 WordPress 函数,用于直接输出网站图标的 URL。它基于 get_site_icon_url() 函数,并自动进行 URL 转义以确保安全性。

关键要点

  • 函数直接输出转义后的网站图标 URL,适用于模板中快速显示图标。
  • 接受三个可选参数:$size(图标尺寸,默认 512 像素)、$url(备用 URL,默认空)、$blog_id(博客 ID,默认当前博客)。
  • 内部调用 get_site_icon_url() 获取 URL,并使用 esc_url() 进行清理和转义。
  • 自 WordPress 4.3.0 版本引入,是核心模板函数的一部分。

代码示例

function site_icon_url( $size = 512, $url = '', $blog_id = 0 ) {
    echo esc_url( get_site_icon_url( $size, $url, $blog_id ) );
}

📄 原文内容

Displays the Site Icon URL.

Parameters

$sizeintoptional
Size of the site icon. Default 512 (pixels).

Default:512

$urlstringoptional
Fallback url if no site icon is found. Default empty.
$blog_idintoptional
ID of the blog to get the site icon for. Default current blog.

Source

function site_icon_url( $size = 512, $url = '', $blog_id = 0 ) {
	echo esc_url( get_site_icon_url( $size, $url, $blog_id ) );
}

Changelog

Version Description
4.3.0 Introduced.