Changeset 46660 for trunk/src/wp-includes/functions.php

Timestamp:

11/05/2019 09:21:46 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Improve documentation of known return types, plus other docs fixes.

See #48303

File:

• trunk/src/wp-includes/functions.php (modified) (7 diffs)

trunk/src/wp-includes/functions.php

@@ -767 +767 @@
  *
  * @param string $content Content to extract URLs from.
- * @return array URLs found in passed string.
+ * @return string[] Array of URLs found in passed string.
  */
 function wp_extract_urls( $content ) {
@@ -2488 +2488 @@
  * @param string       $name       Filename.
  * @param null|string  $deprecated Never used. Set to null.
- * @param mixed        $bits       File content
+ * @param string       $bits       File content
  * @param string       $time       Optional. Time formatted in 'yyyy/mm'. Default null.
  * @return array
@@ -3004 +3004 @@
  * @since 4.6.0
  *
- * @return array Array of file extensions types keyed by the type of file.
+ * @return array[] Multi-dimensional array of file extensions types keyed by the type of file.
  */
 function wp_get_ext_types() {
@@ -3015 +3015 @@
      * @see wp_ext2type()
      *
-     * @param array $ext2type Multi-dimensional array with extensions for a default set
-     *                        of file types.
+     * @param array[] $ext2type Multi-dimensional array of file extensions types keyed by the type of file.
      */
     return apply_filters(
@@ -4263 +4262 @@
  *
  * @param array|string $list List of ids.
- * @return array Sanitized array of IDs.
+ * @return int[] Sanitized array of IDs.
  */
 function wp_parse_id_list( $list ) {
@@ -4277 +4276 @@
  *
  * @param  array|string $list List of slugs.
- * @return array Sanitized array of slugs.
+ * @return string[] Sanitized array of slugs.
  */
 function wp_parse_slug_list( $list ) {
@@ -5843 +5842 @@
  * @param string $context         Optional. If specified adds filter hook {@see 'extra_$context_headers'}.
  *                                Default empty.
- * @return array Array of file headers in `HeaderKey => Header Value` format.
+ * @return string[] Array of file header values keyed by header name.
  */
 function get_file_data( $file, $default_headers, $context = '' ) {