Allow metadata to be deleted when meta_value matches 0 or '0'.

In `delete_metadata()`, be stricter about when to ignore a falsey value of
`$meta_value`.

For backward compatibility, an empty string for `$meta_value` is equivalent to
`null` or `false`.

Props sc0ttkclark.
Fixes #32224.

git-svn-id: https://develop.svn.wordpress.org/trunk@32331 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Boone Gorges 2015-05-01 16:37:35 +00:00
parent 625e7135f3
commit e5e467a41b
2 changed files with 112 additions and 9 deletions

View File

@ -294,14 +294,17 @@ function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_v
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
* @param int $object_id ID of the object metadata is for * @param int $object_id ID of the object metadata is for
* @param string $meta_key Metadata key * @param string $meta_key Metadata key
* @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete metadata entries * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete
* with this value. Otherwise, delete all entries with the specified meta_key. * metadata entries with this value. Otherwise, delete all entries with the specified meta_key.
* @param bool $delete_all Optional, default is false. If true, delete matching metadata entries * Pass `null, `false`, or an empty string to skip this check. (For backward compatibility,
* for all objects, ignoring the specified object_id. Otherwise, only delete matching * it is not possible to pass an empty string to delete those entries with an empty string
* metadata entries for the specified object_id. * for a value.)
* @param bool $delete_all Optional, default is false. If true, delete matching metadata entries for all objects,
* ignoring the specified object_id. Otherwise, only delete matching metadata entries for
* the specified object_id.
* @return bool True on successful delete, false on failure. * @return bool True on successful delete, false on failure.
*/ */
function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) { function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) {
@ -356,7 +359,7 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d
if ( !$delete_all ) if ( !$delete_all )
$query .= $wpdb->prepare(" AND $type_column = %d", $object_id ); $query .= $wpdb->prepare(" AND $type_column = %d", $object_id );
if ( $meta_value ) if ( '' !== $meta_value && null !== $meta_value && false !== $meta_value )
$query .= $wpdb->prepare(" AND meta_value = %s", $meta_value ); $query .= $wpdb->prepare(" AND meta_value = %s", $meta_value );
$meta_ids = $wpdb->get_col( $query ); $meta_ids = $wpdb->get_col( $query );

View File

@ -0,0 +1,100 @@
<?php
/**
* @group meta
*/
class Tests_Meta_DeleteMetadata extends WP_UnitTestCase {
public function test_all_metas_for_key_should_be_deleted_when_no_meta_value_is_provided() {
$vals = array( '0', '1', '2' );
foreach ( $vals as $val ) {
add_metadata( 'post', 12345, 'foo', $val );
}
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( $vals, $m );
delete_metadata( 'post', 12345, 'foo' );
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( array(), $m );
}
public function test_with_meta_value() {
$vals = array( '0', '1', '2' );
foreach ( $vals as $val ) {
add_metadata( 'post', 12345, 'foo', $val );
}
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( $vals, $m );
delete_metadata( 'post', 12345, 'foo', '1' );
$m = get_metadata( 'post', 12345, 'foo', false );
$expected = array_diff( $vals, array( '1' ) );;
$this->assertEqualSets( $expected, $m );
}
/**
* @ticket 32224
*/
public function test_with_falsey_meta_value_should_not_delete_all_meta() {
$vals = array( '0', '1', '2' );
foreach ( $vals as $val ) {
add_metadata( 'post', 12345, 'foo', $val );
}
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( $vals, $m );
delete_metadata( 'post', 12345, 'foo', '0' );
$m = get_metadata( 'post', 12345, 'foo', false );
$expected = array_diff( $vals, array( '0' ) );;
$this->assertEqualSets( $expected, $m );
}
/**
* @ticket 32224
*
* This is a backwards compatiblity quirk.
*/
public function test_meta_value_should_be_ignored_when_empty_string() {
$vals = array( '0', '1', '2', '' );
foreach ( $vals as $val ) {
add_metadata( 'post', 12345, 'foo', $val );
}
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( $vals, $m );
delete_metadata( 'post', 12345, 'foo', '' );
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( array(), $m );
}
/**
* @ticket 32224
*/
public function test_meta_value_should_be_ignored_when_null() {
$vals = array( '0', '1', '2', '' );
foreach ( $vals as $val ) {
add_metadata( 'post', 12345, 'foo', $val );
}
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( $vals, $m );
delete_metadata( 'post', 12345, 'foo', null );
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( array(), $m );
}
/**
* @ticket 32224
*/
public function test_meta_value_should_be_ignored_when_false() {
$vals = array( '0', '1', '2', '' );
foreach ( $vals as $val ) {
add_metadata( 'post', 12345, 'foo', $val );
}
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( $vals, $m );
delete_metadata( 'post', 12345, 'foo', false );
$m = get_metadata( 'post', 12345, 'foo', false );
$this->assertEqualSets( array(), $m );
}
}