From ab8847316c9a347ca70cebbffeb9b3ab80f50178 Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov.ru@gmail.com>
Date: Tue, 18 Feb 2014 21:36:14 +0000
Subject: [PATCH] Correct return values for update_metadata() and related
 functions.

fixes #21864.
Built from https://develop.svn.wordpress.org/trunk@27191


git-svn-id: http://core.svn.wordpress.org/trunk@27050 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-includes/comment.php | 2 +-
 wp-includes/meta.php    | 4 ++--
 wp-includes/post.php    | 2 +-
 wp-includes/user.php    | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/wp-includes/comment.php b/wp-includes/comment.php
index 72fef8bab1..e846b1f31b 100644
--- a/wp-includes/comment.php
+++ b/wp-includes/comment.php
@@ -648,7 +648,7 @@ function get_comment_meta($comment_id, $key = '', $single = false) {
  * @param string $meta_key Metadata key.
  * @param mixed $meta_value Metadata value.
  * @param mixed $prev_value Optional. Previous value to check before removing.
- * @return bool True on success, false on failure.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
  */
 function update_comment_meta($comment_id, $meta_key, $meta_value, $prev_value = '') {
 	return update_metadata('comment', $comment_id, $meta_key, $meta_value, $prev_value);
diff --git a/wp-includes/meta.php b/wp-includes/meta.php
index 55beadb1a4..e8bc2acdd3 100644
--- a/wp-includes/meta.php
+++ b/wp-includes/meta.php
@@ -26,7 +26,7 @@
  * @param bool $unique Optional, default is false. Whether the specified metadata key should be
  * 		unique for the object. If true, and the object already has a value for the specified
  * 		metadata key, no change will be made
- * @return int|bool The meta ID on successful update, false on failure.
+ * @return int|bool The meta ID on success, false on failure.
  */
 function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique = false) {
 	if ( !$meta_type || !$meta_key )
@@ -96,7 +96,7 @@ function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique =
  * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
  * @param mixed $prev_value Optional. If specified, only update existing metadata entries with
  * 		the specified value. Otherwise, update all entries.
- * @return bool True on successful update, false on failure.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
  */
 function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {
 	if ( !$meta_type || !$meta_key )
diff --git a/wp-includes/post.php b/wp-includes/post.php
index 4354270e0c..5ef96b33a9 100644
--- a/wp-includes/post.php
+++ b/wp-includes/post.php
@@ -1789,7 +1789,7 @@ function get_post_meta($post_id, $key = '', $single = false) {
  * @param string $meta_key Metadata key.
  * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
  * @param mixed $prev_value Optional. Previous value to check before removing.
- * @return bool True on success, false on failure.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
  */
 function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') {
 	// make sure meta is added to the post, not a revision
diff --git a/wp-includes/user.php b/wp-includes/user.php
index d90a41a147..731b5264b4 100644
--- a/wp-includes/user.php
+++ b/wp-includes/user.php
@@ -993,7 +993,7 @@ function get_user_meta($user_id, $key = '', $single = false) {
  * @param string $meta_key Metadata key.
  * @param mixed $meta_value Metadata value.
  * @param mixed $prev_value Optional. Previous value to check before removing.
- * @return bool True on success, false on failure.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
  */
 function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
 	return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);