Changeset 27191

Timestamp:

02/18/2014 09:35:07 PM (10 years ago)

Author:

SergeyBiryukov

Message:

Correct return values for update_metadata() and related functions.

fixes #21864.

Location:

trunk/src/wp-includes

Files:

• comment.php (modified) (1 diff)
• meta.php (modified) (2 diffs)
• post.php (modified) (1 diff)
• user.php (modified) (1 diff)

trunk/src/wp-includes/comment.php

@@ -649 +649 @@
  * @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 = '') {

trunk/src/wp-includes/meta.php

@@ -27 +27 @@
  *      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) {
@@ -97 +97 @@
  * @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 = '') {

trunk/src/wp-includes/post.php

@@ -1790 +1790 @@
  * @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 = '') {

trunk/src/wp-includes/user.php

@@ -994 +994 @@
  * @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 = '') {