<!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>[34640] trunk/src/wp-admin/includes/theme.php: Docs: Vastly improve documentation for `themes_api()`.</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="https://core.trac.wordpress.org/changeset/34640">34640</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/34640","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-27 21:51:18 +0000 (Sun, 27 Sep 2015)</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: Vastly improve documentation for `themes_api()`.
Adds:
* A hash notation with descriptions for all accepted arguments
* A matrix-like data table demonstrating which arguments are available for the different `$action` types
* A better summary and description with linked hooks
* An improved return description with a link to external information
Props ocean90.
See <a href="https://core.trac.wordpress.org/ticket/34036">#34036</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesthemephp">trunk/src/wp-admin/includes/theme.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesthemephp"></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/theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/theme.php 2015-09-27 21:37:00 UTC (rev 34639)
+++ trunk/src/wp-admin/includes/theme.php 2015-09-27 21:51:18 UTC (rev 34640)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -296,27 +296,82 @@
</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">- * Retrieve theme installer pages from WordPress Themes API.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves theme installer pages from the WordPress.org Themes API.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * It is possible for a theme to override the Themes API result with three
</span><span class="cx" style="display: block; padding: 0 10px"> * filters. Assume this is for themes, which can extend on the Theme Info to
</span><span class="cx" style="display: block; padding: 0 10px"> * offer more choices. This is very powerful and must be used with care, when
</span><span class="cx" style="display: block; padding: 0 10px"> * overriding the filters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The first filter, 'themes_api_args', is for the args and gives the action as
- * the second parameter. The hook for 'themes_api_args' must ensure that an
- * object is returned.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The first filter, {@see 'themes_api_args'}, is for the args and gives the action
+ * as the second parameter. The hook for {@see 'themes_api_args'} must ensure that
+ * an object is returned.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The second filter, 'themes_api', is the result that would be returned.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The second filter, {@see 'themes_api'}, is the result that would be returned.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Supported arguments per action:
+ *
+ * | Argument Name | 'query_plugins' | 'theme_information' | 'hot_tags' | 'feature_list' |
+ * | -------------------| :-------------: | :-----------------: | :--------: | :--------------: |
+ * | `$slug` | No | Yes | No | No |
+ * | `$per_page` | Yes | No | No | No |
+ * | `$page` | Yes | No | No | No |
+ * | `$number` | No | No | Yes | No |
+ * | `$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 |
+ * | `$fields` | Yes | Yes | No | No |
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $action The requested action. Likely values are 'theme_information',
- * 'feature_list', or 'query_themes'.
- * @param array|object $args Optional. Arguments to serialize for the Theme Info API.
- * @return mixed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $action API action to perform: 'query_themes', 'theme_information',
+ * 'hot_tags' or 'feature_list'.
+ * @param array|object $args {
+ * Optional. Array or object of arguments to serialize for the Plugin Info API.
+ *
+ * @type string $slug The plugin slug. Default empty.
+ * @type int $per_page Number of themes per page. Default 24.
+ * @type int $page Number of current page. Default 1.
+ * @type int $number Number of tags to be queried.
+ * @type string $search A search term. Default empty.
+ * @type string $tag Tag to filter themes. Default empty.
+ * @type string $author Username of an author to filter themes. Default empty.
+ * @type string $user Username to query for their favorites. Default empty.
+ * @type string $browse Browse view: 'featured', 'popular', 'updated', 'favorites'.
+ * @type string $locale Locale to provide context-sensitive results. Default is the value of get_locale().
+ * @type array $fields {
+ * Array of fields which should or should not be returned.
+ *
+ * @type bool $description Whether to return the theme full description. Default false.
+ * @type bool $sections Whether to return the theme readme sections: description, installation,
+ * FAQ, screenshots, other notes, and changelog. Default false.
+ * @type bool $rating Whether to return the rating in percent and total number of ratings.
+ * Default false.
+ * @type bool $ratings Whether to return the number of rating for each star (1-5). Default false.
+ * @type bool $downloaded Whether to return the download count. Default false.
+ * @type bool $downloadlink Whether to return the download link for the package. Default false.
+ * @type bool $last_updated Whether to return the date of the last update. Default false.
+ * @type bool $tags Whether to return the assigned tags. Default false.
+ * @type bool $homepage Whether to return the theme homepage link. Default false.
+ * @type bool $screenshots Whether to return the screenshots. Default false.
+ * @type int $screenshot_count Number of screenshots to return. Default 1.
+ * @type bool $screenshot_url Whether to return the URL of the first screenshot. Default false.
+ * @type bool $photon_screenshots Whether to return the screenshots via Photon. Default false.
+ * @type bool $template Whether to return the slug of the parent theme. Default false.
+ * @type bool $parent Whether to return the slug, name and homepage of the parent theme. Default false.
+ * @type bool $versions Whether to return the list of all available versions. Default false.
+ * @type bool $theme_url Whether to return theme's URL. Default false.
+ * @type bool $extended_author Whether to return nicename or nicename and display name. Default false.
+ * }
+ * }
+ * @return object|array|WP_Error Response object or array on success, WP_Error on failure. See the
+ * {@link https://developer.wordpress.org/reference/functions/themes_api/ function reference article}
+ * for more information on the make-up of possible return objects depending on the value of `$action`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function themes_api( $action, $args = null ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function themes_api( $action, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $args ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args = (object) $args;
</span></span></pre>
</div>
</div>
</body>
</html>