<!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>[BuddyPress][12635] trunk: BP Signup: add a whitelist of available `orderby` arguments</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="http://buddypress.trac.wordpress.org/changeset/12635">12635</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12635","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-04-26 03:58:20 +0000 (Sun, 26 Apr 2020)</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'>BP Signup: add a whitelist of available `orderby` arguments
The BP Signup::get() method `orderby` argument's possible values are : `signup_id`, `login`, `email`, `registered` and `activated`. The Default value remains `signup_id`.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8284">#8284</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersclassesclassbpsignupphp">trunk/src/bp-members/classes/class-bp-signup.php</a></li>
<li><a href="#trunktestsphpunittestcasesmembersclassbpsignupphp">trunk/tests/phpunit/testcases/members/class-bp-signup.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersclassesclassbpsignupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/classes/class-bp-signup.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/classes/class-bp-signup.php 2020-04-26 03:24:12 UTC (rev 12634)
+++ trunk/src/bp-members/classes/class-bp-signup.php 2020-04-26 03:58:20 UTC (rev 12635)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -121,6 +121,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Fetch signups based on parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.0.0 Adds a whitelist of allowed orderby parameters.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * The argument to retrieve desired signups.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,7 +128,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $offset Offset amount. Default 0.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $number How many to fetch. Default 1.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool|string $usersearch Whether or not to search for a username. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $orderby Order By parameter. Default 'signup_id'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $orderby Order By parameter. Possible values are `signup_id`, `login`, `email`,
+ * `registered`, `activated`. Default `signup_id`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $order Order direction. Default 'DESC'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $include Whether or not to include more specific query params.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $activation_key Activation key to search for.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -158,8 +160,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'bp_core_signups_get_args'
</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">- // @todo whitelist sanitization
- if ( $r['orderby'] !== 'signup_id' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Whitelist sanitization.
+ if ( ! in_array( $r['orderby'], array( 'login', 'email', 'registered', 'activated' ), true ) ) {
+ $r['orderby'] = 'signup_id';
+ }
+
+ if ( 'login' === $r['orderby'] || 'email' === $r['orderby'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $r['orderby'] = 'user_' . $r['orderby'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmembersclassbpsignupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/members/class-bp-signup.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/members/class-bp-signup.php 2020-04-26 03:24:12 UTC (rev 12634)
+++ trunk/tests/phpunit/testcases/members/class-bp-signup.php 2020-04-26 03:58:20 UTC (rev 12635)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -198,6 +198,56 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @group get
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_get_with_orderby_login_asc() {
+ $s1 = self::factory()->signup->create( array(
+ 'user_login' => 'fghij',
+ ) );
+ $s2 = self::factory()->signup->create( array(
+ 'user_login' => 'abcde',
+ ) );
+ $s3 = self::factory()->signup->create( array(
+ 'user_login' => 'zzzzz',
+ ) );
+
+ $ss = BP_Signup::get( array(
+ 'orderby' => 'login',
+ 'number' => 3,
+ 'order' => 'ASC',
+ 'fields' => 'ids',
+ ) );
+
+ $this->assertEquals( array( $s2, $s1, $s3 ), $ss['signups'] );
+ }
+
+ /**
+ * @group get
+ */
+ public function test_get_with_orderby_registered_asc() {
+ $now = time();
+
+ $s1 = self::factory()->signup->create( array(
+ 'registered' => date( 'Y-m-d H:i:s', $now - 50 ),
+ ) );
+ $s2 = self::factory()->signup->create( array(
+ 'registered' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $s3 = self::factory()->signup->create( array(
+ 'registered' => date( 'Y-m-d H:i:s', $now - 10 ),
+ ) );
+
+ $ss = BP_Signup::get( array(
+ 'orderby' => 'registered',
+ 'number' => 3,
+ 'order' => 'ASC',
+ 'fields' => 'ids',
+ ) );
+
+ $this->assertEquals( array( $s2, $s1, $s3 ), $ss['signups'] );
+ }
+
+ /**
+ * @group get
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_with_include() {
</span><span class="cx" style="display: block; padding: 0 10px"> $s1 = self::factory()->signup->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $s2 = self::factory()->signup->create();
</span></span></pre>
</div>
</div>
</body>
</html>