Docs: Improve documentation for `get_site_icon_url()`, introduced in [32994].

Adds a missing `@since` version, fixes optional parameter syntax, adds default values, and fixes the return description.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@35064 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-10-12 16:37:13 +00:00
parent 6cfda71af7
commit 6e4fdc4cbf
1 changed files with 6 additions and 4 deletions

View File

@ -726,10 +726,12 @@ function get_bloginfo( $show = '', $filter = 'raw' ) {
/**
* Returns the Site Icon URL.
*
* @param int $size Size of the site icon.
* @param string $url Fallback url if no site icon is found.
* @param int $blog_id Id of the blog to get the site icon for.
* @return string Site Icon URL.
* @since 4.3.0
*
* @param int $size Optional. Size of the site icon. Default 512 (pixels).
* @param string $url Optional. Fallback url if no site icon is found. Default empty.
* @param int $blog_id Optional. ID of the blog to get the site icon for. Default current blog.
* @return string Site Icon URL.
*/
function get_site_icon_url( $size = 512, $url = '', $blog_id = 0 ) {
if ( $blog_id && is_multisite() ) {