<!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>[13332] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory: Plugin Directory: Adjust the query customisations to allow for custom sorting.</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://meta.trac.wordpress.org/changeset/13332">13332</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/13332","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-03-14 03:26:56 +0000 (Thu, 14 Mar 2024)</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'>Plugin Directory: Adjust the query customisations to allow for custom sorting.
This doesn't expose any UI, but provides the underlying API required for supporting it.
See <a href="http://meta.trac.wordpress.org/ticket/2753">#2753</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassplugindirectoryphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclasspluginsearchphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-search.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassplugindirectoryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php 2024-03-14 03:13:59 UTC (rev 13331)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php 2024-03-14 03:26:56 UTC (rev 13332)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -792,9 +792,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // For any invalid values passed to browse, set it to featured instead
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !empty ( $wp_query->query ['browse'] ) &&
- !in_array( $wp_query->query['browse'], array( 'featured', 'popular', 'beta', 'blocks', 'block', 'new', 'favorites', 'adopt-me', 'updated' ) ) ) {
- $wp_query->query['browse'] = 'featured';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ ! empty ( $wp_query->query['browse'] ) &&
+ ! in_array( $wp_query->query['browse'], array( 'featured', 'popular', 'beta', 'blocks', 'block', 'new', 'favorites', 'adopt-me', 'updated' ) )
+ ) {
+ $wp_query->query['browse'] = 'featured';
</ins><span class="cx" style="display: block; padding: 0 10px"> $wp_query->query_vars['browse'] = 'featured';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -801,9 +803,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Set up custom queries for the /browse/ URLs
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $wp_query->get( 'browse' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'beta':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_query->query_vars['meta_key'] = 'last_updated';
- $wp_query->query_vars['orderby'] = 'meta_value';
- $wp_query->query_vars['order'] = 'DESC';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_query->query_vars['orderby'] ??= 'last_updated';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Limit the Beta tab to plugins updated within 12 months.
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_query = $wp_query->get( 'meta_query' ) ?: [];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -832,8 +832,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_query->query_vars['favorites_user'] = $favorites_user->user_nicename;
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_query->query_vars['post_name__in'] = get_user_meta( $favorites_user->ID, 'plugin_favorites', true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_query->query_vars['orderby'] = 'post_title';
- $wp_query->query_vars['order'] = 'ASC';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_query->query_vars['orderby'] ??= 'post_title';
+ $wp_query->query_vars['order'] ??= 'ASC';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $favorites_user || ! $wp_query->query_vars['post_name__in'] ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -842,12 +842,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'updated':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_query->query_vars['orderby'] = 'post_modified';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_query->query_vars['orderby'] ??= 'last_updated';
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'block':
</span><span class="cx" style="display: block; padding: 0 10px"> case 'new':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_query->query_vars['orderby'] = 'post_date';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_query->query_vars['orderby'] ??= 'post_date';
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -904,8 +904,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</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">- $wp_query->query_vars['orderby'] = 'post_title';
- $wp_query->query_vars['order'] = 'ASC';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_query->query_vars['orderby'] ??= 'post_title';
+ $wp_query->query_vars['order'] ??= 'ASC';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Treat it as a taxonomy query now, not the author archive.
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_query->is_author = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -978,10 +978,97 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // By default, all archives are sorted by active installs
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $wp_query->is_archive() && empty( $wp_query->query_vars['orderby'] ) ) {
- $wp_query->query_vars['orderby'] = 'meta_value_num';
- $wp_query->query_vars['meta_key'] = '_active_installs';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $wp_query->is_archive() && ! $wp_query->is_search() && empty( $wp_query->query_vars['orderby'] ) ) {
+ $wp_query->query_vars['orderby'] = 'active_installs';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Adjust the rules for other sorts.
+ // Support orderby={orderby}_{order}
+ if ( isset( $wp_query->query_vars['orderby'] ) && is_string( $wp_query->query_vars['orderby'] ) ) {
+ $orderby = $wp_query->query_vars['orderby'];
+ if ( str_ends_with( $orderby, '_desc' ) ) {
+ $wp_query->query_vars['order'] = 'DESC';
+ $wp_query->query_vars['orderby'] = substr( $orderby, 0, -5 );
+ } elseif ( str_ends_with( $orderby, '_asc' ) ) {
+ $wp_query->query_vars['order'] = 'ASC';
+ $wp_query->query_vars['orderby'] = substr( $orderby, 0, -4 );
+ }
+ }
+
+ // The custom sorts.
+ $orderby = $wp_query->query_vars['orderby'] ?? '';
+ $order = $wp_query->query_vars['order'] ?? 'DESC';
+ switch( $orderby ) {
+ case 'rating':
+ // TODO: Round out the rating to be based on half-stars. A 4.95 rating vs a 5.00 appears the same, but sorts differently.
+ $wp_query->query_vars['meta_query']['rating'] ??= [
+ 'key' => 'rating',
+ 'type' => 'DECIMAL(3,2)',
+ 'compare' => 'EXISTS',
+ ];
+ $wp_query->query_vars['meta_query']['num_ratings'] ??= [
+ 'key' => 'num_ratings',
+ 'type' => 'UNSIGNED',
+ 'compare' => '>',
+ 'value' => 0,
+ ];
+
+ // Should be a multisort, with an additional `num_ratings`.
+ $wp_query->query_vars['orderby'] = array(
+ 'rating' => $order,
+ 'num_ratings' => $order,
+ );
+
+ break;
+
+ case 'num_ratings':
+ case 'ratings':
+ $wp_query->query_vars['meta_query']['num_ratings'] ??= [
+ 'key' => 'num_ratings',
+ 'type' => 'UNSIGNED',
+ 'compare' => '>',
+ 'value' => 0,
+ ];
+
+ $wp_query->query_vars['orderby'] = 'num_ratings';
+ break;
+
+ case '_active_installs':
+ case 'active_installs':
+ $wp_query->query_vars['meta_query']['active_installs'] ??= [
+ 'key' => '_active_installs',
+ 'type' => 'UNSIGNED',
+ 'compare' => 'EXISTS'
+ ];
+
+ $wp_query->query_vars['orderby'] = 'active_installs';
+ break;
+
+ case 'last_updated':
+ $wp_query->query_vars['meta_query']['last_updated'] ??= [
+ 'key' => 'last_updated',
+ 'type' => 'DATE',
+ 'compare' => 'EXISTS',
+ ];
+ break;
+
+ case 'tested':
+ $wp_query->query_vars['meta_query']['tested'] ??= [
+ 'key' => 'tested',
+ 'type' => 'DECIMAL(2,1)',
+ 'compare' => 'EXISTS',
+ ];
+ break;
+
+ case 'downloads':
+ $wp_query->query_vars['meta_query']['downloads'] ??= [
+ 'key' => 'downloads',
+ 'type' => 'UNSIGNED',
+ 'compare' => 'EXISTS',
+ ];
+ $wp_query->query_vars['orderby'] = 'downloads';
+ break;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</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="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclasspluginsearchphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-search.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-search.php 2024-03-14 03:13:59 UTC (rev 13331)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-search.php 2024-03-14 03:26:56 UTC (rev 13332)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -182,16 +182,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function jetpack_search_es_query_args( $es_query_args, $query ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // These are the things that jetpack_search_es_wp_query_args doesn't let us change, so we need to filter the es_query_args late in the code path to add more custom stuff.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $es_query_args['filter']['and'] ??= [];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Exclude disabled plugins.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $es_query_args[ 'filter' ] = [
- 'and' => [
- 0 => [
- 'term' => [
- 'disabled' => [
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $es_query_args['filter']['and'][] = [
+ 'term' => [
+ 'disabled' => [
</ins><span class="cx" style="display: block; padding: 0 10px"> 'value' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ],
</del><span class="cx" style="display: block; padding: 0 10px"> ],
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ],
</del><span class="cx" style="display: block; padding: 0 10px"> ]
</span><span class="cx" style="display: block; padding: 0 10px"> ];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -206,16 +204,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ];
</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">- if ( $query->get( 'plugin_business_model' ) ) {
- $es_query_args['filter']['and'][] = [
- 'term' => [
- 'taxonomy.plugin_business_model.name' => [
- 'value' => $query->get( 'plugin_business_model' )
- ]
- ]
- ];
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Set boost on the match query
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'must' ][0][ 'multi_match' ] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -232,7 +220,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'should' ][0][ 'multi_match' ][ 'operator' ] );
</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">-
</del><span class="cx" style="display: block; padding: 0 10px"> // Some extra fields here
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'should' ][0][ 'multi_match' ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $es_query_args[ 'query' ][ 'function_score' ][ 'query' ][ 'bool' ][ 'should' ][0][ 'multi_match' ][ 'boost' ] = 2;
</span></span></pre>
</div>
</div>
</body>
</html>