From 563d70aa0d91507a7b549a11ba514586853be427 Mon Sep 17 00:00:00 2001 From: Boone Gorges Date: Fri, 25 Sep 2015 04:05:24 +0000 Subject: [PATCH] After [34529], normalize documentation for `get_terms()` and `wp_get_object_terms()`. See #10142. Built from https://develop.svn.wordpress.org/trunk@34530 git-svn-id: http://core.svn.wordpress.org/trunk@34494 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/taxonomy-functions.php | 113 +++++++++++++++-------------- wp-includes/version.php | 2 +- 2 files changed, 58 insertions(+), 57 deletions(-) diff --git a/wp-includes/taxonomy-functions.php b/wp-includes/taxonomy-functions.php index 125bc3612e..e53503c3db 100644 --- a/wp-includes/taxonomy-functions.php +++ b/wp-includes/taxonomy-functions.php @@ -966,54 +966,54 @@ function get_term_to_edit( $id, $taxonomy ) { * @param array|string $args { * Optional. Array or string of arguments to get terms. * - * @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, - * or 'none' to skip ORDER BY. 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 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, + * or 'none' to skip ORDER BY. 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. @@ -2176,14 +2176,15 @@ function wp_delete_category( $cat_ID ) { * @param string|array $taxonomies The taxonomies to retrieve terms from. * @param array|string $args { * Array of arguments. - * @type string $orderby Field by which results should be sorted. Accepts 'name', 'count', 'slug', 'term_group', - * 'term_order', 'taxonomy', 'parent', or 'term_taxonomy_id'. Default 'name'. - * @type string $order Sort order. Accepts 'ASC' or 'DESC'. Default 'ASC'. - * @type string $fields Fields to return for matched terms. Accepts 'all', 'ids', 'names', and - * 'all_with_object_id'. Note that 'all' or 'all_with_object_id' will result in an array of - * term objects being returned, 'ids' will return an array of integers, and 'names' an array - * of strings. - * @type int $parent Optional. Limit results to the direct children of a given term ID. + * @type string $orderby Field by which results should be sorted. Accepts 'name', 'count', 'slug', + * 'term_group', 'term_order', 'taxonomy', 'parent', or 'term_taxonomy_id'. + * Default 'name'. + * @type string $order Sort order. Accepts 'ASC' or 'DESC'. Default 'ASC'. + * @type string $fields Fields to return for matched terms. Accepts 'all', 'ids', 'names', and + * 'all_with_object_id'. Note that 'all' or 'all_with_object_id' will result + * in an array of term objects being returned, 'ids' will return an array of + * integers, and 'names' an array of strings. + * @type int $parent Optional. Limit results to the direct children of a given term ID. * @type bool $update_term_meta_cache Whether to prime termmeta cache for matched terms. Only applies when * `$fields` is 'all', 'all_with_object_id', or 'term_id'. Default true. * @type array $meta_query Meta query clauses to limit retrieved terms by. See `WP_Meta_Query`. diff --git a/wp-includes/version.php b/wp-includes/version.php index faf407523a..dab232b439 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.4-alpha-34529'; +$wp_version = '4.4-alpha-34530'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.