<!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>[50380] trunk: Posts/Post Types: Prevent duplicates in sticky posts option.</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 { white-space: pre-line; 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/50380">50380</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/50380","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-02-17 22:56:34 +0000 (Wed, 17 Feb 2021)</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'>Posts/Post Types: Prevent duplicates in sticky posts option.
In `unstick_post()` if a post ID is duplicated in the `sticky_posts` option remove all instances.
In both `stick_post()` and `unstick_post()` check for duplicate IDs already stored in the `sticky_post` option and remove them if the option is updated.
Props rahmohn, archon810.
Fixes <a href="https://core.trac.wordpress.org/ticket/52007">#52007</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
<li><a href="#trunktestsphpunittestspostphp">trunk/tests/phpunit/tests/post.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespostphp"></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/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2021-02-17 19:31:25 UTC (rev 50379)
+++ trunk/src/wp-includes/post.php 2021-02-17 22:56:34 UTC (rev 50380)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2626,19 +2626,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function stick_post( $post_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = (int) $post_id;
</span><span class="cx" style="display: block; padding: 0 10px"> $stickies = get_option( 'sticky_posts' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $updated = false;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $stickies ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $stickies = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $stickies = array( $post_id );
+ } else {
+ $stickies = array_unique( array_map( 'intval', $stickies ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $stickies = array_map( 'intval', $stickies );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $post_id, $stickies, true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $stickies[] = $post_id;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $updated = update_option( 'sticky_posts', array_values( $stickies ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $updated = update_option( 'sticky_posts', $stickies );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( $updated ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires once a post has been added to the sticky list.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2668,7 +2668,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $stickies = array_map( 'intval', $stickies );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $stickies = array_values( array_unique( array_map( 'intval', $stickies ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $post_id, $stickies, true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span></span></pre></div>
<a id="trunktestsphpunittestspostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post.php 2021-02-17 19:31:25 UTC (rev 50379)
+++ trunk/tests/phpunit/tests/post.php 2021-02-17 22:56:34 UTC (rev 50380)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1637,4 +1637,158 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $resolved_post_date = wp_resolve_post_date( $invalid_date, $invalid_date );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $resolved_post_date );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Ensure sticking post updates option.
+ *
+ * @covers ::stick_post
+ */
+ function test_sticky_posts() {
+ stick_post( 1 );
+ $this->assertSameSets( array( 1 ), get_option( 'sticky_posts' ) );
+
+ stick_post( 2 );
+ $this->assertSameSets( array( 1, 2 ), get_option( 'sticky_posts' ) );
+ }
+
+ /**
+ * Ensure sticking posts can not duplicate options.
+ *
+ * @ticket 52007
+ * @covers ::stick_post
+ * @dataProvider data_sticky_posts_not_duplicate_with_the_same_value
+ *
+ * @param mixed $stick Value to pass to stick_post().
+ */
+ function test_sticky_posts_not_duplicate_with_the_same_value( $stick ) {
+ update_option( 'sticky_posts', array( 1, 2 ) );
+
+ stick_post( $stick );
+ $this->assertSameSets( array( 1, 2 ), get_option( 'sticky_posts' ) );
+ }
+
+ /**
+ * Data provider for test_sticky_posts_not_duplicate_with_the_same_value().
+ *
+ * @return array[] {
+ * Arguments passed to test.
+ *
+ * @type mixed $stick Value to pass to stick_post().
+ * }
+ */
+ function data_sticky_posts_not_duplicate_with_the_same_value() {
+ return array(
+ array( 1 ),
+ array( '1' ),
+ array( 2.0 ),
+ );
+ }
+
+ /**
+ * Ensure sticking post removes other duplicates.
+ *
+ * @ticket 52007
+ * @covers ::stick_post
+ *
+ * @param mixed $stick Value to pass to stick_post().
+ */
+ function test_sticky_posts_remove_duplicate_ids_when_add_new_value() {
+ update_option( 'sticky_posts', array( 1, 1, 2, 2 ) );
+
+ stick_post( 3 );
+ $this->assertSameSets( array( 1, 2, 3 ), get_option( 'sticky_posts' ) );
+ }
+
+ function test_unsticky_posts() {
+ update_option( 'sticky_posts', array( 1 ) );
+ unstick_post( 1 );
+ $this->assertEmpty( get_option( 'sticky_posts' ) );
+
+ update_option( 'sticky_posts', array( 1, 2 ) );
+ unstick_post( 1 );
+ $this->assertSameSets( array( 2 ), get_option( 'sticky_posts' ) );
+ }
+
+ /**
+ * Ensure duplicates removed when unsticking posts.
+ *
+ * @ticket 52007
+ * @covers ::unstick_post
+ *
+ * @dataProvider data_unstick_posts_with_duplicate_id
+ *
+ * @param array $starting_option Original value of `sticky_posts` option.
+ * @param mixed $unstick Parameter passed to `unstick_post()`
+ * @param array $expected
+ */
+ function test_unstick_posts_with_duplicate_id( $starting_option, $unstick, $expected ) {
+ update_option( 'sticky_posts', $starting_option );
+ unstick_post( $unstick );
+ $this->assertSameSets( $expected, get_option( 'sticky_posts' ) );
+ }
+
+ /**
+ * Data provider for test_unstick_posts_with_duplicate_id
+ *
+ * @return array[] {
+ * Arguments passed to test.
+ *
+ * @type array $starting_option Original value of `sticky_posts` option.
+ * @type mixed $unstick Parameter passed to `unstick_post()`
+ * @type array $expected
+ * }
+ */
+ function data_unstick_posts_with_duplicate_id() {
+ return array(
+ array(
+ array( 1, 1 ),
+ 1,
+ array(),
+ ),
+ array(
+ array( 1, 1 ),
+ '1',
+ array(),
+ ),
+ array(
+ array( 1, 2, 1 ),
+ 1,
+ array( 2 ),
+ ),
+ array(
+ array( 1, 2, 1 ),
+ 2,
+ array( 1 ),
+ ),
+ array(
+ array( 1, 2, 1 ),
+ 2.0,
+ array( 1 ),
+ ),
+ );
+ }
+
+ /**
+ * Ensure sticking duplicate does not trigger db update.
+ *
+ * @ticket 52007
+ * @covers ::stick_post
+ */
+ function test_sticking_dupes_does_not_trigger_update() {
+ update_option( 'sticky_posts', array( 1, 2, 2 ) );
+ stick_post( 2 );
+ $this->assertEquals( array( 1, 2, 2 ), get_option( 'sticky_posts' ) );
+ }
+
+ /**
+ * Ensure unsticking unstuck post does not trigger db update.
+ *
+ * @ticket 52007
+ * @covers ::unstick_post
+ */
+ function test_unsticking_unstuck_post_does_not_trigger_update() {
+ update_option( 'sticky_posts', array( 1, 2, 2 ) );
+ unstick_post( 3 );
+ $this->assertEquals( array( 1, 2, 2 ), get_option( 'sticky_posts' ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>