Ticket #40519: 40519.diff

src/wp-includes/comment.php

@@ -454 +454 @@
  * @param int $comment_id Comment ID.
  * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
  * @param bool $single Whether to return a single value.
- * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
- *  is true.
+ * @return mixed Will be an array if $single is false. Will be value of meta data
+ *               field if $single is true. Will return false for an invalid $comment_id.
  */
 function get_comment_meta($comment_id, $key = '', $single = false) {
         return get_metadata('comment', $comment_id, $key, $single);

src/wp-includes/meta.php

@@ -456 +456 @@
  * @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 Single metadata value, or array of values
+ * @return mixed Single metadata value, or array of values. False is returned for invalid parameters.
  */
 function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
         if ( ! $meta_type || ! is_numeric( $object_id ) ) {

src/wp-includes/post.php

@@ -1749 +1749 @@
  *                        data for all keys. Default empty.
  * @param bool   $single  Optional. Whether to return a single value. Default false.
  * @return mixed Will be an array if $single is false. Will be value of meta data
- *               field if $single is true.
+ *               field if $single is true. Will return false for an invalid $post_id.
  */
 function get_post_meta( $post_id, $key = '', $single = false ) {
         return get_metadata('post', $post_id, $key, $single);

src/wp-includes/taxonomy.php

@@ -1173 +1173 @@
  * @param string $key     Optional. The meta key to retrieve. If no key is provided, fetches all metadata for the term.
  * @param bool   $single  Whether to return a single value. If false, an array of all values matching the
  *                        `$term_id`/`$key` pair will be returned. Default: false.
- * @return mixed If `$single` is false, an array of metadata values. If `$single` is true, a single metadata value.
+ * @return mixed If `$single` is false, an array of metadata values. If `$single` is true,
+ *               a single metadata value. If $term_id is invalid, a bool value of false.
  */
 function get_term_meta( $term_id, $key = '', $single = false ) {
         // Bail if term meta table is not installed.

src/wp-includes/user.php

@@ -794 +794 @@
  * @param int    $user_id User ID.
  * @param string $key     Optional. The meta key to retrieve. By default, returns data for all keys.
  * @param bool   $single  Whether to return a single value.
- * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
+ * @return mixed Will be an array if $single is false. Will be value of meta data
+ *               field if $single is true. Will return false for an invalid $user_id.
  */
 function get_user_meta($user_id, $key = '', $single = false) {
         return get_metadata('user', $user_id, $key, $single);