Changeset 33665

Timestamp:

08/20/2015 07:35:43 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Correct the phpDoc type to a boolean for the $single parameter in the get_{$meta_type}_metadata hook docs.

Props dlh.
Fixes #33451.

File:

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

trunk/src/wp-includes/meta.php

@@ -476 +476 @@
      * @since 3.1.0
      *
-     * @param null|array|string $value     The value get_metadata() should
-     *                                     return - a single metadata value,
+     * @param null|array|string $value     The value get_metadata() should return - a single metadata value,
      *                                     or an array of values.
      * @param int               $object_id Object ID.
      * @param string            $meta_key  Meta key.
-     * @param string|array      $single    Meta value, or an array of values.
+     * @param bool              $single    Whether to return only the first value of the specified $meta_key.
      */
     $check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single );