<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[32331] trunk: Allow metadata to be deleted when meta_value matches 0 or '0'.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/32331">32331</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/32331","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-01 16:37:35 +0000 (Fri, 01 May 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/32224">#32224</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmetaphp">trunk/src/wp-includes/meta.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsmetadeleteMetadataphp">trunk/tests/phpunit/tests/meta/deleteMetadata.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmetaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/meta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/meta.php 2015-04-30 21:39:52 UTC (rev 32330)
+++ trunk/src/wp-includes/meta.php 2015-05-01 16:37:35 UTC (rev 32331)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -294,14 +294,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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 string $meta_key Metadata key
- * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete 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
- * for all objects, ignoring the specified object_id. Otherwise, only delete matching
- * metadata entries for the specified object_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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 string $meta_key Metadata key
+ * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete
+ * metadata entries with this value. Otherwise, delete all entries with the specified meta_key.
+ * Pass `null, `false`, or an empty string to skip this check. (For backward compatibility,
+ * it is not possible to pass an empty string to delete those entries with an empty string
+ * 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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on successful delete, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -356,7 +359,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !$delete_all )
</span><span class="cx" style="display: block; padding: 0 10px"> $query .= $wpdb->prepare(" AND $type_column = %d", $object_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $meta_value )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( '' !== $meta_value && null !== $meta_value && false !== $meta_value )
</ins><span class="cx" style="display: block; padding: 0 10px"> $query .= $wpdb->prepare(" AND meta_value = %s", $meta_value );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_ids = $wpdb->get_col( $query );
</span></span></pre></div>
<a id="trunktestsphpunittestsmetadeleteMetadataphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/meta/deleteMetadata.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/meta/deleteMetadata.php (rev 0)
+++ trunk/tests/phpunit/tests/meta/deleteMetadata.php 2015-05-01 16:37:35 UTC (rev 32331)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,100 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?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 );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>