<!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>[58873] trunk/src/wp-admin/includes/plugin-install.php: Docs: Remove unsupported values in `plugins_api()` DocBlocks.</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/58873">58873</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/58873","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-08-09 00:16:33 +0000 (Fri, 09 Aug 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'>Docs: Remove unsupported values in `plugins_api()` DocBlocks.
The `group` field and the `hot_categories` action were never actually implemented on the WordPress.org side.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/34596">[34596]</a>, [meta3227].
Props lopo, milana_cap.
See <a href="https://core.trac.wordpress.org/ticket/55645">#55645</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesplugininstallphp">trunk/src/wp-admin/includes/plugin-install.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesplugininstallphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/plugin-install.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/plugin-install.php 2024-08-08 19:35:24 UTC (rev 58872)
+++ trunk/src/wp-admin/includes/plugin-install.php 2024-08-09 00:16:33 UTC (rev 58873)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,8 +20,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The second filter, {@see 'plugins_api'}, allows a plugin to override the WordPress.org
</span><span class="cx" style="display: block; padding: 0 10px"> * Plugin Installation API entirely. If `$action` is 'query_plugins' or 'plugin_information',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * an object MUST be passed. If `$action` is 'hot_tags' or 'hot_categories', an array MUST
- * be passed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * an object MUST be passed. If `$action` is 'hot_tags', an array MUST be passed.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Finally, the third filter, {@see 'plugins_api_result'}, makes it possible to filter the
</span><span class="cx" style="display: block; padding: 0 10px"> * response object or array, depending on the `$action` type.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,26 +27,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Supported arguments per action:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * | Argument Name | query_plugins | plugin_information | hot_tags | hot_categories |
- * | -------------------- | :-----------: | :----------------: | :------: | :------------: |
- * | `$slug` | No | Yes | No | No |
- * | `$per_page` | Yes | No | No | No |
- * | `$page` | Yes | No | No | No |
- * | `$number` | No | No | Yes | Yes |
- * | `$search` | Yes | No | No | No |
- * | `$tag` | Yes | No | No | No |
- * | `$author` | Yes | No | No | No |
- * | `$user` | Yes | No | No | No |
- * | `$browse` | Yes | No | No | No |
- * | `$locale` | Yes | Yes | No | No |
- * | `$installed_plugins` | Yes | No | No | No |
- * | `$is_ssl` | Yes | Yes | No | No |
- * | `$fields` | Yes | Yes | No | No |
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * | Argument Name | query_plugins | plugin_information | hot_tags |
+ * | -------------------- | :-----------: | :----------------: | :------: |
+ * | `$slug` | No | Yes | No |
+ * | `$per_page` | Yes | No | No |
+ * | `$page` | Yes | No | No |
+ * | `$number` | No | No | Yes |
+ * | `$search` | Yes | No | No |
+ * | `$tag` | Yes | No | No |
+ * | `$author` | Yes | No | No |
+ * | `$user` | Yes | No | No |
+ * | `$browse` | Yes | No | No |
+ * | `$locale` | Yes | Yes | No |
+ * | `$installed_plugins` | Yes | No | No |
+ * | `$is_ssl` | Yes | Yes | No |
+ * | `$fields` | Yes | Yes | No |
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $action API action to perform: 'query_plugins', 'plugin_information',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'hot_tags' or 'hot_categories'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * or 'hot_tags'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array|object $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array or object of arguments to serialize for the Plugin Info API.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -91,7 +90,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $banners Whether to return the banner images links. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $icons Whether to return the icon links. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $active_installs Whether to return the number of active installations. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type bool $group Whether to return the assigned group. Default false.
</del><span class="cx" style="display: block; padding: 0 10px"> * @type bool $contributors Whether to return the list of contributors. Default false.
</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">@@ -136,7 +134,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Returning a non-false value will effectively short-circuit the WordPress.org API request.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If `$action` is 'query_plugins' or 'plugin_information', an object MUST be passed.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If `$action` is 'hot_tags' or 'hot_categories', an array should be passed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If `$action` is 'hot_tags', an array should be passed.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>