Changeset 35064

Timestamp:

10/12/2015 04:37:13 PM (9 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/general-template.php (modified) (1 diff)

trunk/src/wp-includes/general-template.php

@@ -727 +727 @@
  * 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 ) {