Changeset 35813

Timestamp:

12/07/2015 04:38:24 PM (10 years ago)

Author:

swissspidy

Message:

Docs: After [35314], fix the DocBlock for url_shorten().

See #20166.

File:

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

trunk/src/wp-includes/formatting.php

@@ -4777 +4777 @@
 
 /**
- * Shorten an URL, to be used as link text
+ * Shorten an URL, to be used as link text.
  *
  * @since 1.2.0
- * @since 4.4.0 Moved to wp-includes/formatting.php from wp-admin/includes/misc.php and added $length param
- *
- * @param string $url URL to shorten
- * @param  int $length Maxiumum length of url to return
- * @return string
-*/
+ * @since 4.4.0 Moved to wp-includes/formatting.php from wp-admin/includes/misc.php and added $length param.
+ *
+ * @param string $url    URL to shorten.
+ * @param int    $length Optional. Maximum length of the shortened URL. Default 35 characters.
+ * @return string Shortened URL.
+ */
 function url_shorten( $url, $length = 35 ) {
     $stripped = str_replace( array( 'https://', 'http://', 'www.' ), '', $url );