<!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>[11535] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone: Plugin Directory: API: Allow clients to disable the `versions` and `download_link` fields.</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/11535">11535</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/11535","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>2022-02-10 00:41:19 +0000 (Thu, 10 Feb 2022)</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: Allow clients to disable the `versions` and `download_link` fields.
Full changes:
- Can disable the `versions` response key.
- Can disable the `download_link` response key.
- Incorrectly documented `downloadlink` key will affect the `download_link` key.
- Requesting `reviews` without `sections` will now result in `sections.reviews` being returned still
- Typos in documentation & code cleanup.
See <a href="http://meta.trac.wordpress.org/ticket/6032">#6032</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 2022-02-09 07:52:24 UTC (rev 11534)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api-request.php 2022-02-10 00:41:19 UTC (rev 11535)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,13 +18,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'donate_link' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'downloaded' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'downloadlink' => false,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'download_link' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'homepage' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'icons' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'last_updated' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'rating' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'ratings' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'reviews' => false,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'reviews' => false, // NOTE: sub-key of 'sections'.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'requires' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'requires_php' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'sections' => false,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,6 +37,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_block_count' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_block_rating' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'language_packs' => false,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'versions' => false,
</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"> static $plugins_info_fields_defaults = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -45,7 +46,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'contributors' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'bare_contributors' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'downloaded' => true,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'downloadlink' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'download_link' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'donate_link' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'homepage' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'last_updated' => true,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,7 +76,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'compatibility' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'downloaded' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => true,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'downloadlink' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'download_link' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'donate_link' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'homepage' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'last_updated' => true,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -110,6 +111,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_block_rating' => 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">+ // Typo/incorrect field name transforms.
+ static $field_aliases = array(
+ // from => to
+ 'downloadlink' => 'download_link', // Incorrectly documented in plugins_api().
+ );
+
</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">@@ -159,7 +166,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"> // In WordPress 4.0+ we request the icons field however we don't use the
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // description and compatibility fields so we exclue those by default unless requested.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // description and compatibility fields so we exclude those by default unless requested.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $this->requested_fields['icons'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fields['compatibility'] = false;
</span><span class="cx" style="display: block; padding: 0 10px"> $fields['description'] = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -191,6 +198,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $field = substr( $field, 1 );
</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">+
+ // If the field is an aliased field, redirect to the proper field.
+ $field = self::$field_aliases[ $field ] ?? $field;
+
+ // If it's a valid field, include it.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( self::$fields[ $field ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $requested_fields[ $field ] = (bool) $include;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 2022-02-09 07:52:24 UTC (rev 11534)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api.php 2022-02-10 00:41:19 UTC (rev 11535)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -154,10 +154,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $request The request object for the request.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $method The requested method, used to determine the default fields to include.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array The $resonse with the extra fields removed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array The $response with the extra fields removed.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected function remove_unexpected_fields( $response, $request, $method = '' ) {
- $fields = $request->get_expected_fields( $method );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected function remove_unexpected_fields( $full_response, $request, $method = '' ) {
+ $response = $full_response;
+ $fields = $request->get_expected_fields( $method );
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $fields as $field => $include ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $include ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $response[ $field ] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -167,21 +168,26 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Support requesting reviews without sections.
+ if ( ! empty( $fields['reviews'] ) && empty( $fields['sections'] ) ) {
+ $response['sections'] = array(
+ 'reviews' => $full_response['sections']['reviews']
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Back-compatible routines.
</span><span class="cx" style="display: block; padding: 0 10px"> // WordPress 4.9 and older need a "bare" contributor map [ user => profile ]
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $fields['bare_contributors'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $contribs = $response['contributors'] ?? [];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $contributors = $response['contributors'] ?? [];
</ins><span class="cx" style="display: block; padding: 0 10px"> $response['contributors'] = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $contribs ) {
- foreach ( $contribs as $user => $data ) {
- $response['contributors'][ $user ] = $data['profile'];
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $contributors as $user => $data ) {
+ $response['contributors'][ $user ] = $data['profile'];
</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 class="cx" style="display: block; padding: 0 10px"> // Only include block translation data for the selected locale.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $response['block_translations'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response['block_translations'] = !empty( $response['block_translations'][ $request->locale ] ) ? $response['block_translations'][ $request->locale ] : [];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $response['block_translations'] = $response['block_translations'][ $request->locale ] ?? [];
</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"> return $response;
</span></span></pre>
</div>
</div>
</body>
</html>