<!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>[40292] trunk/src/wp-includes/taxonomy.php: Streamline `get_terms()` parameter documentation.</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/40292">40292</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/40292","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-03-16 01:34:52 +0000 (Thu, 16 Mar 2017)</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'>Streamline `get_terms()` parameter documentation.
Since 4.6, `get_terms()` has been a wrapper for `WP_Term_Query`.
Full parameter documentation lives with the class, and
`get_terms()` should reference rather than duplicate it.
Props shashwatmittal.
Fixes <a href="https://core.trac.wordpress.org/ticket/37075">#37075</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludestaxonomyphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy.php 2017-03-14 18:42:57 UTC (rev 40291)
+++ trunk/src/wp-includes/taxonomy.php 2017-03-16 01:34:52 UTC (rev 40292)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1020,76 +1020,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_filter
</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 array|string $args {
- * Optional. Array or string of arguments to get terms.
- *
- * @type string|array $taxonomy Taxonomy name, or array of taxonomies, to which results should
- * be limited.
- * @type string $orderby Field(s) to order terms by. Accepts term fields ('name', 'slug',
- * 'term_group', 'term_id', 'id', 'description'), 'count' for term
- * taxonomy count, 'include' to match the 'order' of the $include param,
- * 'meta_value', 'meta_value_num', the value of `$meta_key`, the array
- * keys of `$meta_query`, or 'none' to omit the ORDER BY clause.
- * Defaults to 'name'.
- * @type string $order Whether to order terms in ascending or descending order.
- * Accepts 'ASC' (ascending) or 'DESC' (descending).
- * Default 'ASC'.
- * @type bool|int $hide_empty Whether to hide terms not assigned to any posts. Accepts
- * 1|true or 0|false. Default 1|true.
- * @type array|string $include Array or comma/space-separated string of term ids to include.
- * Default empty array.
- * @type array|string $exclude Array or comma/space-separated string of term ids to exclude.
- * If $include is non-empty, $exclude is ignored.
- * Default empty array.
- * @type array|string $exclude_tree Array or comma/space-separated string of term ids to exclude
- * along with all of their descendant terms. If $include is
- * non-empty, $exclude_tree is ignored. Default empty array.
- * @type int|string $number Maximum number of terms to return. Accepts ''|0 (all) or any
- * positive number. Default ''|0 (all).
- * @type int $offset The number by which to offset the terms query. Default empty.
- * @type string $fields Term fields to query for. Accepts 'all' (returns an array of complete
- * term objects), 'ids' (returns an array of ids), 'id=>parent' (returns
- * an associative array with ids as keys, parent term IDs as values),
- * 'names' (returns an array of term names), 'count' (returns the number
- * of matching terms), 'id=>name' (returns an associative array with ids
- * as keys, term names as values), or 'id=>slug' (returns an associative
- * array with ids as keys, term slugs as values). Default 'all'.
- * @type string|array $name Optional. Name or array of names to return term(s) for. Default empty.
- * @type string|array $slug Optional. Slug or array of slugs to return term(s) for. Default empty.
- * @type bool $hierarchical Whether to include terms that have non-empty descendants (even
- * if $hide_empty is set to true). Default true.
- * @type string $search Search criteria to match terms. Will be SQL-formatted with
- * wildcards before and after. Default empty.
- * @type string $name__like Retrieve terms with criteria by which a term is LIKE $name__like.
- * Default empty.
- * @type string $description__like Retrieve terms where the description is LIKE $description__like.
- * Default empty.
- * @type bool $pad_counts Whether to pad the quantity of a term's children in the quantity
- * of each term's "count" object variable. Default false.
- * @type string $get Whether to return terms regardless of ancestry or whether the terms
- * are empty. Accepts 'all' or empty (disabled). Default empty.
- * @type int $child_of Term ID to retrieve child terms of. If multiple taxonomies
- * are passed, $child_of is ignored. Default 0.
- * @type int|string $parent Parent term ID to retrieve direct-child terms of. Default empty.
- * @type bool $childless True to limit results to terms that have no children. This parameter
- * has no effect on non-hierarchical taxonomies. Default false.
- * @type string $cache_domain Unique cache key to be produced when this query is stored in an
- * object cache. Default is 'core'.
- * @type bool $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
- * @type array $meta_query Meta query clauses to limit retrieved terms by.
- * See `WP_Meta_Query`. Default empty.
- * @type string $meta_key Limit terms to those matching a specific metadata key. Can be used in
- * conjunction with `$meta_value`. Default empty.
- * @type string $meta_value Limit terms to those matching a specific metadata value. Usually used
- * in conjunction with `$meta_key`. Default empty.
- * @type string $meta_type Type of object metadata is for (e.g., comment, post, or user).
- * Default empty.
- * @type string $meta_compare Comparison operator to test the 'meta_value'. Default empty.
- * @type bool $suppress_filter Whether to suppress the {@see 'get_terms'} filter. Default false.
- * }
- * @param array $deprecated Argument array, when using the legacy function parameter format. If present, this
- * parameter will be interpreted as `$args`, and the first function parameter will
- * be parsed as a taxonomy or array of taxonomies.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array $args Optional. Array or string of arguments. See WP_Term_Query::__construct()
+ * for information on accepted arguments. Default empty.
+ * @param array $deprecated Argument array, when using the legacy function parameter format. If present, this
+ * parameter will be interpreted as `$args`, and the first function parameter will
+ * be parsed as a taxonomy or array of taxonomies.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array|int|WP_Error List of WP_Term instances and their children. Will return WP_Error, if any of $taxonomies
</span><span class="cx" style="display: block; padding: 0 10px"> * do not exist.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>