Changeset 42227 for trunk/src/wp-includes/post.php

Timestamp:

11/26/2017 03:16:55 AM (7 years ago)

Author:

dd32

Message:

Docs: Update the documentation for get_post_meta() to clarify that $single has no effect when the $meta_key is not provided.

Props chetan200891, titodevera.
Fixes #42687.

File:

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

trunk/src/wp-includes/post.php

@@ -1771 +1771 @@
  * @param string $key     Optional. The meta key to retrieve. By default, returns
  *                        data for all keys. Default empty.
- * @param bool   $single  Optional. Whether to return a single value. Default false.
+ * @param bool   $single  Optional, default is false.
+ *                        If true, return only the first value of the specified meta_key.
+ *                        This parameter has no effect if meta_key is not specified.
  * @return mixed Will be an array if $single is false. Will be value of meta data
  *               field if $single is true.