<!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>[6496] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone: Plugin Directory: API: Update the list of fields included by default in the `info/1.2` endpoint.</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="http://meta.trac.wordpress.org/changeset/6496">6496</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/6496","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>2018-02-01 04:27:18 +0000 (Thu, 01 Feb 2018)</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: API: Update the list of fields included by default in the `info/1.2` endpoint.
See <a href="http://meta.trac.wordpress.org/ticket/111">#111</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorystandaloneclasspluginsinfoapirequestphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api-request.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorystandaloneclasspluginsinfoapiphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorystandaloneclasspluginsinfoapirequestphp"></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/standalone/class-plugins-info-api-request.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/standalone/class-plugins-info-api-request.php 2018-01-31 23:39:47 UTC (rev 6495)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api-request.php 2018-02-01 04:27:18 UTC (rev 6496)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,23 +35,36 @@
</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"> static $plugins_info_fields_defaults = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'added' => true,
- 'compatibility' => true,
- 'contributors' => true,
- 'downloaded' => true,
- 'downloadlink' => true,
- 'donate_link' => true,
- 'homepage' => true,
- 'last_updated' => true,
- 'rating' => true,
- 'ratings' => true,
- 'requires' => true,
- 'requires_php' => true,
- 'sections' => true,
- 'tags' => true,
- 'tested' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'added' => true,
+ 'compatibility' => true,
+ 'contributors' => false,
+ 'bare_contributors' => true,
+ 'downloaded' => true,
+ 'downloadlink' => true,
+ 'donate_link' => true,
+ 'homepage' => true,
+ 'last_updated' => true,
+ 'rating' => true,
+ 'ratings' => true,
+ 'requires' => true,
+ 'requires_php' => true,
+ 'sections' => true,
+ 'tags' => true,
+ 'tested' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Alterations made to default fields in the info/1.2 API.
+ static $plugins_info_fields_defaults_12 = array(
+ 'downloaded' => false,
+ 'bare_contributors' => false,
+ 'compatibility' => false,
+ 'description' => false,
+ 'banners' => true,
+ 'reviews' => true,
+ 'active_installs' => true,
+ 'contributors' => true,
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> static $query_plugins_fields_defaults = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'added' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'compatibility' => true,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -71,6 +84,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'tested' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Alterations made to the default fields in the info/1.2 API.
+ static $query_plugins_fields_defaults_12 = array(
+ 'compatibility' => false,
+ 'sections' => false,
+ 'contributors' => false,
+ 'versions' => false,
+ 'screenshots' => false,
+ 'last_updated' => true,
+ 'icons' => true,
+ 'active_installs' => true,
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args = (object) $args;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -104,9 +129,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = self::$fields;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'plugin_information' == $method ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $fields = array_merge( $fields, self::$plugins_info_fields_defaults );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $fields = array_merge(
+ $fields,
+ self::$plugins_info_fields_defaults,
+ ( defined( 'PLUGINS_API_VERSION' ) && PLUGINS_API_VERSION >= 1.2 ) ? self::$plugins_info_fields_defaults_12 : array()
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'query_plugins' == $method ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $fields = array_merge( $fields, self::$query_plugins_fields_defaults );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $fields = array_merge(
+ $fields,
+ self::$query_plugins_fields_defaults,
+ ( defined( 'PLUGINS_API_VERSION' ) && PLUGINS_API_VERSION >= 1.2 ) ? self::$query_plugins_fields_defaults_12 : array()
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> return array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,14 +151,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $fields['description'] = false;
</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">- // In the 1.2+ version of the info API, we default to returning a more detailed list of contributors.
- // This can be enabled in older versions of the API by passing the 'contributors' field.
- if ( defined( 'PLUGINS_API_VERSION' ) && PLUGINS_API_VERSION >= 1.2 ) {
- $fields['contributors'] = true;
- } elseif ( ! isset( $this->requested_fields['contributors'] ) ) {
- $fields['bare_contributors'] = true;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $fields = array_merge( $fields, $this->requested_fields );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $fields;
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorystandaloneclasspluginsinfoapiphp"></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/standalone/class-plugins-info-api.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/standalone/class-plugins-info-api.php 2018-01-31 23:39:47 UTC (rev 6495)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api.php 2018-02-01 04:27:18 UTC (rev 6496)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -168,7 +168,7 @@
</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"> // Back-compatible routines.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // WordPress 4.x and older need a "bare" contributor map
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // WordPress 4.9 and older need a "bare" contributor map [ user => profile ]
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $fields['bare_contributors'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $contribs = $response['contributors'];
</span><span class="cx" style="display: block; padding: 0 10px"> $response['contributors'] = array();
</span></span></pre>
</div>
</div>
</body>
</html>