Commit 8555ea17 authored by Sergey Biryukov's avatar Sergey Biryukov
Browse files

Correct return values for update_metadata() and related functions. 

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


git-svn-id: https://core.svn.wordpress.org/trunk@27050 1a063a9b-81f0-0310-95a4-ce76da25c4cd
parent de9bb95e

wp-includes/comment.php

+1 −1
Original line number Diff line number Diff line
@@ -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);

wp-includes/meta.php

+2 −2
Original line number Diff line number Diff line
@@ -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 )

wp-includes/post.php

+1 −1
Original line number Diff line number Diff line
@@ -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

wp-includes/user.php

+1 −1
Original line number Diff line number Diff line
@@ -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);