Changeset 52226
- Timestamp:
- 11/20/2021 12:06:06 AM (3 years ago)
- Location:
- trunk/src/wp-includes
- Files:
-
- 6 edited
-
class-wp-comment-query.php (modified) (1 diff)
-
class-wp-meta-query.php (modified) (2 diffs)
-
class-wp-query.php (modified) (1 diff)
-
class-wp-site-query.php (modified) (1 diff)
-
class-wp-term-query.php (modified) (1 diff)
-
class-wp-user-query.php (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/wp-includes/class-wp-comment-query.php
r51806 r52226 142 142 * @since 4.6.0 Introduced the `$cache_domain` argument. 143 143 * @since 4.9.0 Introduced the `$paged` argument. 144 * @since 5.1.0 Introduced the `$meta_compare_key` argument. 145 * @since 5.3.0 Introduced the `$meta_type_key` argument. 144 146 * 145 147 * @param string|array $query { 146 148 * Optional. Array or query string of comment query parameters. Default empty. 147 149 * 148 * @type string $author_email Comment author email address. Default empty. 149 * @type string $author_url Comment author URL. Default empty. 150 * @type int[] $author__in Array of author IDs to include comments for. Default empty. 151 * @type int[] $author__not_in Array of author IDs to exclude comments for. Default empty. 152 * @type int[] $comment__in Array of comment IDs to include. Default empty. 153 * @type int[] $comment__not_in Array of comment IDs to exclude. Default empty. 154 * @type bool $count Whether to return a comment count (true) or array of 155 * comment objects (false). Default false. 156 * @type array $date_query Date query clauses to limit comments by. See WP_Date_Query. 157 * Default null. 158 * @type string $fields Comment fields to return. Accepts 'ids' for comment IDs 159 * only or empty for all fields. Default empty. 160 * @type int $ID Currently unused. 161 * @type array $include_unapproved Array of IDs or email addresses of users whose unapproved 162 * comments will be returned by the query regardless of 163 * `$status`. Default empty. 164 * @type int $karma Karma score to retrieve matching comments for. 165 * Default empty. 166 * @type string $meta_key Include comments with a matching comment meta key. 167 * Default empty. 168 * @type string $meta_value Include comments with a matching comment meta value. 169 * Requires `$meta_key` to be set. Default empty. 170 * @type array $meta_query Meta query clauses to limit retrieved comments by. 171 * See WP_Meta_Query. Default empty. 172 * @type int $number Maximum number of comments to retrieve. 173 * Default empty (no limit). 174 * @type int $paged When used with $number, defines the page of results to return. 175 * When used with $offset, $offset takes precedence. Default 1. 176 * @type int $offset Number of comments to offset the query. Used to build 177 * LIMIT clause. Default 0. 178 * @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query. 179 * Default: true. 180 * @type string|array $orderby Comment status or array of statuses. To use 'meta_value' 181 * or 'meta_value_num', `$meta_key` must also be defined. 182 * To sort by a specific `$meta_query` clause, use that 183 * clause's array key. Accepts 'comment_agent', 184 * 'comment_approved', 'comment_author', 185 * 'comment_author_email', 'comment_author_IP', 186 * 'comment_author_url', 'comment_content', 'comment_date', 187 * 'comment_date_gmt', 'comment_ID', 'comment_karma', 188 * 'comment_parent', 'comment_post_ID', 'comment_type', 189 * 'user_id', 'comment__in', 'meta_value', 'meta_value_num', 190 * the value of $meta_key, and the array keys of 191 * `$meta_query`. Also accepts false, an empty array, or 192 * 'none' to disable `ORDER BY` clause. 193 * Default: 'comment_date_gmt'. 194 * @type string $order How to order retrieved comments. Accepts 'ASC', 'DESC'. 195 * Default: 'DESC'. 196 * @type int $parent Parent ID of comment to retrieve children of. 197 * Default empty. 198 * @type int[] $parent__in Array of parent IDs of comments to retrieve children for. 199 * Default empty. 200 * @type int[] $parent__not_in Array of parent IDs of comments *not* to retrieve 201 * children for. Default empty. 202 * @type int[] $post_author__in Array of author IDs to retrieve comments for. 203 * Default empty. 204 * @type int[] $post_author__not_in Array of author IDs *not* to retrieve comments for. 205 * Default empty. 206 * @type int $post_ID Currently unused. 207 * @type int $post_id Limit results to those affiliated with a given post ID. 208 * Default 0. 209 * @type int[] $post__in Array of post IDs to include affiliated comments for. 210 * Default empty. 211 * @type int[] $post__not_in Array of post IDs to exclude affiliated comments for. 212 * Default empty. 213 * @type int $post_author Post author ID to limit results by. Default empty. 214 * @type string|array $post_status Post status or array of post statuses to retrieve 215 * affiliated comments for. Pass 'any' to match any value. 216 * Default empty. 217 * @type string|array $post_type Post type or array of post types to retrieve affiliated 218 * comments for. Pass 'any' to match any value. Default empty. 219 * @type string $post_name Post name to retrieve affiliated comments for. 220 * Default empty. 221 * @type int $post_parent Post parent ID to retrieve affiliated comments for. 222 * Default empty. 223 * @type string $search Search term(s) to retrieve matching comments for. 224 * Default empty. 225 * @type string|array $status Comment statuses to limit results by. Accepts an array 226 * or space/comma-separated list of 'hold' (`comment_status=0`), 227 * 'approve' (`comment_status=1`), 'all', or a custom 228 * comment status. Default 'all'. 229 * @type string|array $type Include comments of a given type, or array of types. 230 * Accepts 'comment', 'pings' (includes 'pingback' and 231 * 'trackback'), or any custom type string. Default empty. 232 * @type string[] $type__in Include comments from a given array of comment types. 233 * Default empty. 234 * @type string[] $type__not_in Exclude comments from a given array of comment types. 235 * Default empty. 236 * @type int $user_id Include comments for a specific user ID. Default empty. 237 * @type bool|string $hierarchical Whether to include comment descendants in the results. 238 * - 'threaded' returns a tree, with each comment's children 239 * stored in a `children` property on the `WP_Comment` object. 240 * - 'flat' returns a flat array of found comments plus 241 * their children. 242 * - Boolean `false` leaves out descendants. 243 * The parameter is ignored (forced to `false`) when 244 * `$fields` is 'ids' or 'counts'. Accepts 'threaded', 245 * 'flat', or false. Default: false. 246 * @type string $cache_domain Unique cache key to be produced when this query is stored in 247 * an object cache. Default is 'core'. 248 * @type bool $update_comment_meta_cache Whether to prime the metadata cache for found comments. 249 * Default true. 250 * @type bool $update_comment_post_cache Whether to prime the cache for comment posts. 251 * Default false. 150 * @type string $author_email Comment author email address. Default empty. 151 * @type string $author_url Comment author URL. Default empty. 152 * @type int[] $author__in Array of author IDs to include comments for. Default empty. 153 * @type int[] $author__not_in Array of author IDs to exclude comments for. Default empty. 154 * @type int[] $comment__in Array of comment IDs to include. Default empty. 155 * @type int[] $comment__not_in Array of comment IDs to exclude. Default empty. 156 * @type bool $count Whether to return a comment count (true) or array of 157 * comment objects (false). Default false. 158 * @type array $date_query Date query clauses to limit comments by. See WP_Date_Query. 159 * Default null. 160 * @type string $fields Comment fields to return. Accepts 'ids' for comment IDs 161 * only or empty for all fields. Default empty. 162 * @type int $ID Currently unused. 163 * @type array $include_unapproved Array of IDs or email addresses of users whose unapproved 164 * comments will be returned by the query regardless of 165 * `$status`. Default empty. 166 * @type int $karma Karma score to retrieve matching comments for. 167 * Default empty. 168 * @type string|string[] $meta_key Meta key or keys to filter by. 169 * @type string|string[] $meta_value Meta value or values to filter by. 170 * @type string $meta_compare MySQL operator used for comparing the meta value. 171 * See WP_Meta_Query::__construct for accepted values and default value. 172 * @type string $meta_compare_key MySQL operator used for comparing the meta key. 173 * See WP_Meta_Query::__construct for accepted values and default value. 174 * @type string $meta_type MySQL data type that the meta_value column will be CAST to for comparisons. 175 * See WP_Meta_Query::__construct for accepted values and default value. 176 * @type string $meta_type_key MySQL data type that the meta_key column will be CAST to for comparisons. 177 * See WP_Meta_Query::__construct for accepted values and default value. 178 * @type array $meta_query An associative array of WP_Meta_Query arguments. 179 * See WP_Meta_Query::__construct for accepted values. 180 * @type int $number Maximum number of comments to retrieve. 181 * Default empty (no limit). 182 * @type int $paged When used with `$number`, defines the page of results to return. 183 * When used with `$offset`, `$offset` takes precedence. Default 1. 184 * @type int $offset Number of comments to offset the query. Used to build 185 * LIMIT clause. Default 0. 186 * @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query. 187 * Default: true. 188 * @type string|array $orderby Comment status or array of statuses. To use 'meta_value' 189 * or 'meta_value_num', `$meta_key` must also be defined. 190 * To sort by a specific `$meta_query` clause, use that 191 * clause's array key. Accepts: 192 * - 'comment_agent' 193 * - 'comment_approved' 194 * - 'comment_author' 195 * - 'comment_author_email' 196 * - 'comment_author_IP' 197 * - 'comment_author_url' 198 * - 'comment_content' 199 * - 'comment_date' 200 * - 'comment_date_gmt' 201 * - 'comment_ID' 202 * - 'comment_karma' 203 * - 'comment_parent' 204 * - 'comment_post_ID' 205 * - 'comment_type' 206 * - 'user_id' 207 * - 'comment__in' 208 * - 'meta_value' 209 * - 'meta_value_num' 210 * - The value of `$meta_key` 211 * - The array keys of `$meta_query` 212 * - false, an empty array, or 'none' to disable `ORDER BY` clause. 213 * Default: 'comment_date_gmt'. 214 * @type string $order How to order retrieved comments. Accepts 'ASC', 'DESC'. 215 * Default: 'DESC'. 216 * @type int $parent Parent ID of comment to retrieve children of. 217 * Default empty. 218 * @type int[] $parent__in Array of parent IDs of comments to retrieve children for. 219 * Default empty. 220 * @type int[] $parent__not_in Array of parent IDs of comments *not* to retrieve 221 * children for. Default empty. 222 * @type int[] $post_author__in Array of author IDs to retrieve comments for. 223 * Default empty. 224 * @type int[] $post_author__not_in Array of author IDs *not* to retrieve comments for. 225 * Default empty. 226 * @type int $post_ID Currently unused. 227 * @type int $post_id Limit results to those affiliated with a given post ID. 228 * Default 0. 229 * @type int[] $post__in Array of post IDs to include affiliated comments for. 230 * Default empty. 231 * @type int[] $post__not_in Array of post IDs to exclude affiliated comments for. 232 * Default empty. 233 * @type int $post_author Post author ID to limit results by. Default empty. 234 * @type string|array $post_status Post status or array of post statuses to retrieve 235 * affiliated comments for. Pass 'any' to match any value. 236 * Default empty. 237 * @type string|array $post_type Post type or array of post types to retrieve affiliated 238 * comments for. Pass 'any' to match any value. Default empty. 239 * @type string $post_name Post name to retrieve affiliated comments for. 240 * Default empty. 241 * @type int $post_parent Post parent ID to retrieve affiliated comments for. 242 * Default empty. 243 * @type string $search Search term(s) to retrieve matching comments for. 244 * Default empty. 245 * @type string|array $status Comment statuses to limit results by. Accepts an array 246 * or space/comma-separated list of 'hold' (`comment_status=0`), 247 * 'approve' (`comment_status=1`), 'all', or a custom 248 * comment status. Default 'all'. 249 * @type string|array $type Include comments of a given type, or array of types. 250 * Accepts 'comment', 'pings' (includes 'pingback' and 251 * 'trackback'), or any custom type string. Default empty. 252 * @type string[] $type__in Include comments from a given array of comment types. 253 * Default empty. 254 * @type string[] $type__not_in Exclude comments from a given array of comment types. 255 * Default empty. 256 * @type int $user_id Include comments for a specific user ID. Default empty. 257 * @type bool|string $hierarchical Whether to include comment descendants in the results. 258 * - 'threaded' returns a tree, with each comment's children 259 * stored in a `children` property on the `WP_Comment` object. 260 * - 'flat' returns a flat array of found comments plus 261 * their children. 262 * - Boolean `false` leaves out descendants. 263 * The parameter is ignored (forced to `false`) when 264 * `$fields` is 'ids' or 'counts'. Accepts 'threaded', 265 * 'flat', or false. Default: false. 266 * @type string $cache_domain Unique cache key to be produced when this query is stored in 267 * an object cache. Default is 'core'. 268 * @type bool $update_comment_meta_cache Whether to prime the metadata cache for found comments. 269 * Default true. 270 * @type bool $update_comment_post_cache Whether to prime the cache for comment posts. 271 * Default false. 252 272 * } 253 273 */ -
trunk/src/wp-includes/class-wp-meta-query.php
r51797 r52226 100 100 * @since 3.2.0 101 101 * @since 4.2.0 Introduced support for naming query clauses by associative array keys. 102 * @since 5.1.0 Introduced $compare_keyclause parameter, which enables LIKE key matches.103 * @since 5.3.0 Increased the number of operators available to $compare_key. Introduced $type_key,104 * which enables the $keyto be cast to a new data type for comparisons.102 * @since 5.1.0 Introduced `$compare_key` clause parameter, which enables LIKE key matches. 103 * @since 5.3.0 Increased the number of operators available to `$compare_key`. Introduced `$type_key`, 104 * which enables the `$key` to be cast to a new data type for comparisons. 105 105 * 106 106 * @param array $meta_query { … … 108 108 * their array keys, they may be referenced in the 'orderby' parameter of the parent query. 109 109 * 110 * @type string $relation Optional. The MySQL keyword used to join 111 * the clauses of the query. Accepts 'AND',or 'OR'. Default 'AND'.110 * @type string $relation Optional. The MySQL keyword used to join the clauses of the query. 111 * Accepts 'AND' or 'OR'. Default 'AND'. 112 112 * @type array ...$0 { 113 113 * Optional. An array of first-order clause parameters, or another fully-formed meta query. 114 114 * 115 * @type string $key Meta key to filter by. 116 * @type string $compare_key MySQL operator used for comparing the $key. Accepts '=', '!=' 117 * 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'REGEXP', 'NOT REGEXP', 'RLIKE', 118 * 'EXISTS' (alias of '=') or 'NOT EXISTS' (alias of '!='). 119 * Default is 'IN' when `$key` is an array, '=' otherwise. 120 * @type string $type_key MySQL data type that the meta_key column will be CAST to for 121 * comparisons. Accepts 'BINARY' for case-sensitive regular expression 122 * comparisons. Default is ''. 123 * @type string $value Meta value to filter by. 124 * @type string $compare MySQL operator used for comparing the $value. Accepts '=', 125 * '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 126 * 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'REGEXP', 127 * 'NOT REGEXP', 'RLIKE', 'EXISTS' or 'NOT EXISTS'. 128 * Default is 'IN' when `$value` is an array, '=' otherwise. 129 * @type string $type MySQL data type that the meta_value column will be CAST to for 130 * comparisons. Accepts 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 131 * 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', or 'UNSIGNED'. 132 * Default is 'CHAR'. 115 * @type string|string[] $key Meta key or keys to filter by. 116 * @type string $compare_key MySQL operator used for comparing the $key. Accepts: 117 * - '=' 118 * - '!=' 119 * - 'LIKE' 120 * - 'NOT LIKE' 121 * - 'IN' 122 * - 'NOT IN' 123 * - 'REGEXP' 124 * - 'NOT REGEXP' 125 * - 'RLIKE', 126 * - 'EXISTS' (alias of '=') 127 * - 'NOT EXISTS' (alias of '!=') 128 * Default is 'IN' when `$key` is an array, '=' otherwise. 129 * @type string $type_key MySQL data type that the meta_key column will be CAST to for 130 * comparisons. Accepts 'BINARY' for case-sensitive regular expression 131 * comparisons. Default is ''. 132 * @type string|string[] $value Meta value or values to filter by. 133 * @type string $compare MySQL operator used for comparing the $value. Accepts: 134 * - '=', 135 * - '!=' 136 * - '>' 137 * - '>=' 138 * - '<' 139 * - '<=' 140 * - 'LIKE' 141 * - 'NOT LIKE' 142 * - 'IN' 143 * - 'NOT IN' 144 * - 'BETWEEN' 145 * - 'NOT BETWEEN' 146 * - 'REGEXP' 147 * - 'NOT REGEXP' 148 * - 'RLIKE' 149 * - 'EXISTS' 150 * - 'NOT EXISTS' 151 * Default is 'IN' when `$value` is an array, '=' otherwise. 152 * @type string $type MySQL data type that the meta_value column will be CAST to for 153 * comparisons. Accepts: 154 * - 'NUMERIC' 155 * - 'BINARY' 156 * - 'CHAR' 157 * - 'DATE' 158 * - 'DATETIME' 159 * - 'DECIMAL' 160 * - 'SIGNED' 161 * - 'TIME' 162 * - 'UNSIGNED' 163 * Default is 'CHAR'. 133 164 * } 134 165 * } -
trunk/src/wp-includes/class-wp-query.php
r51885 r52226 631 631 * Optional. Array or string of Query parameters. 632 632 * 633 * @type int $attachment_id Attachment post ID. Used for 'attachment' post_type. 634 * @type int|string $author Author ID, or comma-separated list of IDs. 635 * @type string $author_name User 'user_nicename'. 636 * @type int[] $author__in An array of author IDs to query from. 637 * @type int[] $author__not_in An array of author IDs not to query from. 638 * @type bool $cache_results Whether to cache post information. Default true. 639 * @type int|string $cat Category ID or comma-separated list of IDs (this or any children). 640 * @type int[] $category__and An array of category IDs (AND in). 641 * @type int[] $category__in An array of category IDs (OR in, no children). 642 * @type int[] $category__not_in An array of category IDs (NOT in). 643 * @type string $category_name Use category slug (not name, this or any children). 644 * @type array|int $comment_count Filter results by comment count. Provide an integer to match 645 * comment count exactly. Provide an array with integer 'value' 646 * and 'compare' operator ('=', '!=', '>', '>=', '<', '<=' ) to 647 * compare against comment_count in a specific way. 648 * @type string $comment_status Comment status. 649 * @type int $comments_per_page The number of comments to return per page. 650 * Default 'comments_per_page' option. 651 * @type array $date_query An associative array of WP_Date_Query arguments. 652 * See WP_Date_Query::__construct(). 653 * @type int $day Day of the month. Default empty. Accepts numbers 1-31. 654 * @type bool $exact Whether to search by exact keyword. Default false. 655 * @type string $fields Post fields to query for. Accepts: 656 * - '' Returns an array of complete post objects (`WP_Post[]`). 657 * - 'ids' Returns an array of post IDs (`int[]`). 658 * - 'id=>parent' Returns an associative array of parent post IDs, 659 * keyed by post ID (`int[]`). 660 * Default ''. 661 * @type int $hour Hour of the day. Default empty. Accepts numbers 0-23. 662 * @type int|bool $ignore_sticky_posts Whether to ignore sticky posts or not. Setting this to false 663 * excludes stickies from 'post__in'. Accepts 1|true, 0|false. 664 * Default false. 665 * @type int $m Combination YearMonth. Accepts any four-digit year and month 666 * numbers 1-12. Default empty. 667 * @type string $meta_compare Comparison operator to test the 'meta_value'. 668 * @type string $meta_compare_key Comparison operator to test the 'meta_key'. 669 * @type string $meta_key Custom field key. 670 * @type array $meta_query An associative array of WP_Meta_Query arguments. See WP_Meta_Query. 671 * @type string $meta_value Custom field value. 672 * @type int $meta_value_num Custom field value number. 673 * @type string $meta_type_key Cast for 'meta_key'. See WP_Meta_Query::construct(). 674 * @type int $menu_order The menu order of the posts. 675 * @type int $minute Minute of the hour. Default empty. Accepts numbers 0-59. 676 * @type int $monthnum The two-digit month. Default empty. Accepts numbers 1-12. 677 * @type string $name Post slug. 678 * @type bool $nopaging Show all posts (true) or paginate (false). Default false. 679 * @type bool $no_found_rows Whether to skip counting the total rows found. Enabling can improve 680 * performance. Default false. 681 * @type int $offset The number of posts to offset before retrieval. 682 * @type string $order Designates ascending or descending order of posts. Default 'DESC'. 683 * Accepts 'ASC', 'DESC'. 684 * @type string|array $orderby Sort retrieved posts by parameter. One or more options may be 685 * passed. To use 'meta_value', or 'meta_value_num', 686 * 'meta_key=keyname' must be also be defined. To sort by a 687 * specific `$meta_query` clause, use that clause's array key. 688 * Accepts 'none', 'name', 'author', 'date', 'title', 689 * 'modified', 'menu_order', 'parent', 'ID', 'rand', 690 * 'relevance', 'RAND(x)' (where 'x' is an integer seed value), 691 * 'comment_count', 'meta_value', 'meta_value_num', 'post__in', 692 * 'post_name__in', 'post_parent__in', and the array keys 693 * of `$meta_query`. Default is 'date', except when a search 694 * is being performed, when the default is 'relevance'. 695 * @type int $p Post ID. 696 * @type int $page Show the number of posts that would show up on page X of a 697 * static front page. 698 * @type int $paged The number of the current page. 699 * @type int $page_id Page ID. 700 * @type string $pagename Page slug. 701 * @type string $perm Show posts if user has the appropriate capability. 702 * @type string $ping_status Ping status. 703 * @type int[] $post__in An array of post IDs to retrieve, sticky posts will be included. 704 * @type int[] $post__not_in An array of post IDs not to retrieve. Note: a string of comma- 705 * separated IDs will NOT work. 706 * @type string $post_mime_type The mime type of the post. Used for 'attachment' post_type. 707 * @type string[] $post_name__in An array of post slugs that results must match. 708 * @type int $post_parent Page ID to retrieve child pages for. Use 0 to only retrieve 709 * top-level pages. 710 * @type int[] $post_parent__in An array containing parent page IDs to query child pages from. 711 * @type int[] $post_parent__not_in An array containing parent page IDs not to query child pages from. 712 * @type string|array $post_type A post type slug (string) or array of post type slugs. 713 * Default 'any' if using 'tax_query'. 714 * @type string|array $post_status A post status (string) or array of post statuses. 715 * @type int $posts_per_page The number of posts to query for. Use -1 to request all posts. 716 * @type int $posts_per_archive_page The number of posts to query for by archive page. Overrides 717 * 'posts_per_page' when is_archive(), or is_search() are true. 718 * @type string $s Search keyword(s). Prepending a term with a hyphen will 719 * exclude posts matching that term. Eg, 'pillow -sofa' will 720 * return posts containing 'pillow' but not 'sofa'. The 721 * character used for exclusion can be modified using the 722 * the 'wp_query_search_exclusion_prefix' filter. 723 * @type int $second Second of the minute. Default empty. Accepts numbers 0-59. 724 * @type bool $sentence Whether to search by phrase. Default false. 725 * @type bool $suppress_filters Whether to suppress filters. Default false. 726 * @type string $tag Tag slug. Comma-separated (either), Plus-separated (all). 727 * @type int[] $tag__and An array of tag IDs (AND in). 728 * @type int[] $tag__in An array of tag IDs (OR in). 729 * @type int[] $tag__not_in An array of tag IDs (NOT in). 730 * @type int $tag_id Tag id or comma-separated list of IDs. 731 * @type string[] $tag_slug__and An array of tag slugs (AND in). 732 * @type string[] $tag_slug__in An array of tag slugs (OR in). unless 'ignore_sticky_posts' is 733 * true. Note: a string of comma-separated IDs will NOT work. 734 * @type array $tax_query An associative array of WP_Tax_Query arguments. 735 * See WP_Tax_Query->__construct(). 736 * @type string $title Post title. 737 * @type bool $update_post_meta_cache Whether to update the post meta cache. Default true. 738 * @type bool $update_post_term_cache Whether to update the post term cache. Default true. 739 * @type bool $lazy_load_term_meta Whether to lazy-load term meta. Setting to false will 740 * disable cache priming for term meta, so that each 741 * get_term_meta() call will hit the database. 742 * Defaults to the value of `$update_post_term_cache`. 743 * @type int $w The week number of the year. Default empty. Accepts numbers 0-53. 744 * @type int $year The four-digit year. Default empty. Accepts any four-digit year. 633 * @type int $attachment_id Attachment post ID. Used for 'attachment' post_type. 634 * @type int|string $author Author ID, or comma-separated list of IDs. 635 * @type string $author_name User 'user_nicename'. 636 * @type int[] $author__in An array of author IDs to query from. 637 * @type int[] $author__not_in An array of author IDs not to query from. 638 * @type bool $cache_results Whether to cache post information. Default true. 639 * @type int|string $cat Category ID or comma-separated list of IDs (this or any children). 640 * @type int[] $category__and An array of category IDs (AND in). 641 * @type int[] $category__in An array of category IDs (OR in, no children). 642 * @type int[] $category__not_in An array of category IDs (NOT in). 643 * @type string $category_name Use category slug (not name, this or any children). 644 * @type array|int $comment_count Filter results by comment count. Provide an integer to match 645 * comment count exactly. Provide an array with integer 'value' 646 * and 'compare' operator ('=', '!=', '>', '>=', '<', '<=' ) to 647 * compare against comment_count in a specific way. 648 * @type string $comment_status Comment status. 649 * @type int $comments_per_page The number of comments to return per page. 650 * Default 'comments_per_page' option. 651 * @type array $date_query An associative array of WP_Date_Query arguments. 652 * See WP_Date_Query::__construct(). 653 * @type int $day Day of the month. Default empty. Accepts numbers 1-31. 654 * @type bool $exact Whether to search by exact keyword. Default false. 655 * @type string $fields Post fields to query for. Accepts: 656 * - '' Returns an array of complete post objects (`WP_Post[]`). 657 * - 'ids' Returns an array of post IDs (`int[]`). 658 * - 'id=>parent' Returns an associative array of parent post IDs, 659 * keyed by post ID (`int[]`). 660 * Default ''. 661 * @type int $hour Hour of the day. Default empty. Accepts numbers 0-23. 662 * @type int|bool $ignore_sticky_posts Whether to ignore sticky posts or not. Setting this to false 663 * excludes stickies from 'post__in'. Accepts 1|true, 0|false. 664 * Default false. 665 * @type int $m Combination YearMonth. Accepts any four-digit year and month 666 * numbers 1-12. Default empty. 667 * @type string|string[] $meta_key Meta key or keys to filter by. 668 * @type string|string[] $meta_value Meta value or values to filter by. 669 * @type string $meta_compare MySQL operator used for comparing the meta value. 670 * See WP_Meta_Query::__construct for accepted values and default value. 671 * @type string $meta_compare_key MySQL operator used for comparing the meta key. 672 * See WP_Meta_Query::__construct for accepted values and default value. 673 * @type string $meta_type MySQL data type that the meta_value column will be CAST to for comparisons. 674 * See WP_Meta_Query::__construct for accepted values and default value. 675 * @type string $meta_type_key MySQL data type that the meta_key column will be CAST to for comparisons. 676 * See WP_Meta_Query::__construct for accepted values and default value. 677 * @type array $meta_query An associative array of WP_Meta_Query arguments. 678 * See WP_Meta_Query::__construct for accepted values. 679 * @type int $menu_order The menu order of the posts. 680 * @type int $minute Minute of the hour. Default empty. Accepts numbers 0-59. 681 * @type int $monthnum The two-digit month. Default empty. Accepts numbers 1-12. 682 * @type string $name Post slug. 683 * @type bool $nopaging Show all posts (true) or paginate (false). Default false. 684 * @type bool $no_found_rows Whether to skip counting the total rows found. Enabling can improve 685 * performance. Default false. 686 * @type int $offset The number of posts to offset before retrieval. 687 * @type string $order Designates ascending or descending order of posts. Default 'DESC'. 688 * Accepts 'ASC', 'DESC'. 689 * @type string|array $orderby Sort retrieved posts by parameter. One or more options may be passed. 690 * To use 'meta_value', or 'meta_value_num', 'meta_key=keyname' must be 691 * also be defined. To sort by a specific `$meta_query` clause, use that 692 * clause's array key. Accepts: 693 * - 'none' 694 * - 'name' 695 * - 'author' 696 * - 'date' 697 * - 'title' 698 * - 'modified' 699 * - 'menu_order' 700 * - 'parent' 701 * - 'ID' 702 * - 'rand' 703 * - 'relevance' 704 * - 'RAND(x)' (where 'x' is an integer seed value) 705 * - 'comment_count' 706 * - 'meta_value' 707 * - 'meta_value_num' 708 * - 'post__in' 709 * - 'post_name__in' 710 * - 'post_parent__in' 711 * - The array keys of `$meta_query`. 712 * Default is 'date', except when a search is being performed, when 713 * the default is 'relevance'. 714 * @type int $p Post ID. 715 * @type int $page Show the number of posts that would show up on page X of a 716 * static front page. 717 * @type int $paged The number of the current page. 718 * @type int $page_id Page ID. 719 * @type string $pagename Page slug. 720 * @type string $perm Show posts if user has the appropriate capability. 721 * @type string $ping_status Ping status. 722 * @type int[] $post__in An array of post IDs to retrieve, sticky posts will be included. 723 * @type int[] $post__not_in An array of post IDs not to retrieve. Note: a string of comma- 724 * separated IDs will NOT work. 725 * @type string $post_mime_type The mime type of the post. Used for 'attachment' post_type. 726 * @type string[] $post_name__in An array of post slugs that results must match. 727 * @type int $post_parent Page ID to retrieve child pages for. Use 0 to only retrieve 728 * top-level pages. 729 * @type int[] $post_parent__in An array containing parent page IDs to query child pages from. 730 * @type int[] $post_parent__not_in An array containing parent page IDs not to query child pages from. 731 * @type string|array $post_type A post type slug (string) or array of post type slugs. 732 * Default 'any' if using 'tax_query'. 733 * @type string|array $post_status A post status (string) or array of post statuses. 734 * @type int $posts_per_page The number of posts to query for. Use -1 to request all posts. 735 * @type int $posts_per_archive_page The number of posts to query for by archive page. Overrides 736 * 'posts_per_page' when is_archive(), or is_search() are true. 737 * @type string $s Search keyword(s). Prepending a term with a hyphen will 738 * exclude posts matching that term. Eg, 'pillow -sofa' will 739 * return posts containing 'pillow' but not 'sofa'. The 740 * character used for exclusion can be modified using the 741 * the 'wp_query_search_exclusion_prefix' filter. 742 * @type int $second Second of the minute. Default empty. Accepts numbers 0-59. 743 * @type bool $sentence Whether to search by phrase. Default false. 744 * @type bool $suppress_filters Whether to suppress filters. Default false. 745 * @type string $tag Tag slug. Comma-separated (either), Plus-separated (all). 746 * @type int[] $tag__and An array of tag IDs (AND in). 747 * @type int[] $tag__in An array of tag IDs (OR in). 748 * @type int[] $tag__not_in An array of tag IDs (NOT in). 749 * @type int $tag_id Tag id or comma-separated list of IDs. 750 * @type string[] $tag_slug__and An array of tag slugs (AND in). 751 * @type string[] $tag_slug__in An array of tag slugs (OR in). unless 'ignore_sticky_posts' is 752 * true. Note: a string of comma-separated IDs will NOT work. 753 * @type array $tax_query An associative array of WP_Tax_Query arguments. 754 * See WP_Tax_Query->__construct(). 755 * @type string $title Post title. 756 * @type bool $update_post_meta_cache Whether to update the post meta cache. Default true. 757 * @type bool $update_post_term_cache Whether to update the post term cache. Default true. 758 * @type bool $lazy_load_term_meta Whether to lazy-load term meta. Setting to false will 759 * disable cache priming for term meta, so that each 760 * get_term_meta() call will hit the database. 761 * Defaults to the value of `$update_post_term_cache`. 762 * @type int $w The week number of the year. Default empty. Accepts numbers 0-53. 763 * @type int $year The four-digit year. Default empty. Accepts any four-digit year. 745 764 * } 746 765 */ -
trunk/src/wp-includes/class-wp-site-query.php
r51518 r52226 110 110 * @since 4.8.0 Introduced the 'lang_id', 'lang__in', and 'lang__not_in' parameters. 111 111 * @since 5.1.0 Introduced the 'update_site_meta_cache', 'meta_query', 'meta_key', 112 * 'meta_value', 'meta_type' and 'meta_compare' parameters. 112 * 'meta_compare_key', 'meta_value', 'meta_type', and 'meta_compare' parameters. 113 * @since 5.3.0 Introduced the 'meta_type_key' parameter. 113 114 * 114 115 * @param string|array $query { 115 116 * Optional. Array or query string of site query parameters. Default empty. 116 117 * 117 * @type int[] $site__in Array of site IDs to include. Default empty. 118 * @type int[] $site__not_in Array of site IDs to exclude. Default empty. 119 * @type bool $count Whether to return a site count (true) or array of site objects. 120 * Default false. 121 * @type array $date_query Date query clauses to limit sites by. See WP_Date_Query. 122 * Default null. 123 * @type string $fields Site fields to return. Accepts 'ids' (returns an array of site IDs) 124 * or empty (returns an array of complete site objects). Default empty. 125 * @type int $ID A site ID to only return that site. Default empty. 126 * @type int $number Maximum number of sites to retrieve. Default 100. 127 * @type int $offset Number of sites to offset the query. Used to build LIMIT clause. 128 * Default 0. 129 * @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query. Default true. 130 * @type string|array $orderby Site status or array of statuses. Accepts 'id', 'domain', 'path', 131 * 'network_id', 'last_updated', 'registered', 'domain_length', 132 * 'path_length', 'site__in' and 'network__in'. Also accepts false, 133 * an empty array, or 'none' to disable `ORDER BY` clause. 134 * Default 'id'. 135 * @type string $order How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'. 136 * @type int $network_id Limit results to those affiliated with a given network ID. If 0, 137 * include all networks. Default 0. 138 * @type int[] $network__in Array of network IDs to include affiliated sites for. Default empty. 139 * @type int[] $network__not_in Array of network IDs to exclude affiliated sites for. Default empty. 140 * @type string $domain Limit results to those affiliated with a given domain. Default empty. 141 * @type string[] $domain__in Array of domains to include affiliated sites for. Default empty. 142 * @type string[] $domain__not_in Array of domains to exclude affiliated sites for. Default empty. 143 * @type string $path Limit results to those affiliated with a given path. Default empty. 144 * @type string[] $path__in Array of paths to include affiliated sites for. Default empty. 145 * @type string[] $path__not_in Array of paths to exclude affiliated sites for. Default empty. 146 * @type int $public Limit results to public sites. Accepts '1' or '0'. Default empty. 147 * @type int $archived Limit results to archived sites. Accepts '1' or '0'. Default empty. 148 * @type int $mature Limit results to mature sites. Accepts '1' or '0'. Default empty. 149 * @type int $spam Limit results to spam sites. Accepts '1' or '0'. Default empty. 150 * @type int $deleted Limit results to deleted sites. Accepts '1' or '0'. Default empty. 151 * @type int $lang_id Limit results to a language ID. Default empty. 152 * @type string[] $lang__in Array of language IDs to include affiliated sites for. Default empty. 153 * @type string[] $lang__not_in Array of language IDs to exclude affiliated sites for. Default empty. 154 * @type string $search Search term(s) to retrieve matching sites for. Default empty. 155 * @type string[] $search_columns Array of column names to be searched. Accepts 'domain' and 'path'. 156 * Default empty array. 157 * @type bool $update_site_cache Whether to prime the cache for found sites. Default true. 158 * @type bool $update_site_meta_cache Whether to prime the metadata cache for found sites. Default true. 159 * @type array $meta_query Meta query clauses to limit retrieved sites by. See `WP_Meta_Query`. 160 * Default empty. 161 * @type string $meta_key Limit sites to those matching a specific metadata key. 162 * Can be used in conjunction with `$meta_value`. Default empty. 163 * @type string $meta_value Limit sites to those matching a specific metadata value. 164 * Usually used in conjunction with `$meta_key`. Default empty. 165 * @type string $meta_type Data type that the `$meta_value` column will be CAST to for 166 * comparisons. Default empty. 167 * @type string $meta_compare Comparison operator to test the `$meta_value`. Default empty. 118 * @type int[] $site__in Array of site IDs to include. Default empty. 119 * @type int[] $site__not_in Array of site IDs to exclude. Default empty. 120 * @type bool $count Whether to return a site count (true) or array of site objects. 121 * Default false. 122 * @type array $date_query Date query clauses to limit sites by. See WP_Date_Query. 123 * Default null. 124 * @type string $fields Site fields to return. Accepts 'ids' (returns an array of site IDs) 125 * or empty (returns an array of complete site objects). Default empty. 126 * @type int $ID A site ID to only return that site. Default empty. 127 * @type int $number Maximum number of sites to retrieve. Default 100. 128 * @type int $offset Number of sites to offset the query. Used to build LIMIT clause. 129 * Default 0. 130 * @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query. Default true. 131 * @type string|array $orderby Site status or array of statuses. Accepts: 132 * - 'id' 133 * - 'domain' 134 * - 'path' 135 * - 'network_id' 136 * - 'last_updated' 137 * - 'registered' 138 * - 'domain_length' 139 * - 'path_length' 140 * - 'site__in' 141 * - 'network__in' 142 * - false, an empty array, or 'none' to disable `ORDER BY` clause. 143 * Default 'id'. 144 * @type string $order How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'. 145 * @type int $network_id Limit results to those affiliated with a given network ID. If 0, 146 * include all networks. Default 0. 147 * @type int[] $network__in Array of network IDs to include affiliated sites for. Default empty. 148 * @type int[] $network__not_in Array of network IDs to exclude affiliated sites for. Default empty. 149 * @type string $domain Limit results to those affiliated with a given domain. Default empty. 150 * @type string[] $domain__in Array of domains to include affiliated sites for. Default empty. 151 * @type string[] $domain__not_in Array of domains to exclude affiliated sites for. Default empty. 152 * @type string $path Limit results to those affiliated with a given path. Default empty. 153 * @type string[] $path__in Array of paths to include affiliated sites for. Default empty. 154 * @type string[] $path__not_in Array of paths to exclude affiliated sites for. Default empty. 155 * @type int $public Limit results to public sites. Accepts '1' or '0'. Default empty. 156 * @type int $archived Limit results to archived sites. Accepts '1' or '0'. Default empty. 157 * @type int $mature Limit results to mature sites. Accepts '1' or '0'. Default empty. 158 * @type int $spam Limit results to spam sites. Accepts '1' or '0'. Default empty. 159 * @type int $deleted Limit results to deleted sites. Accepts '1' or '0'. Default empty. 160 * @type int $lang_id Limit results to a language ID. Default empty. 161 * @type string[] $lang__in Array of language IDs to include affiliated sites for. Default empty. 162 * @type string[] $lang__not_in Array of language IDs to exclude affiliated sites for. Default empty. 163 * @type string $search Search term(s) to retrieve matching sites for. Default empty. 164 * @type string[] $search_columns Array of column names to be searched. Accepts 'domain' and 'path'. 165 * Default empty array. 166 * @type bool $update_site_cache Whether to prime the cache for found sites. Default true. 167 * @type bool $update_site_meta_cache Whether to prime the metadata cache for found sites. Default true. 168 * @type string|string[] $meta_key Meta key or keys to filter by. 169 * @type string|string[] $meta_value Meta value or values to filter by. 170 * @type string $meta_compare MySQL operator used for comparing the meta value. 171 * See WP_Meta_Query::__construct for accepted values and default value. 172 * @type string $meta_compare_key MySQL operator used for comparing the meta key. 173 * See WP_Meta_Query::__construct for accepted values and default value. 174 * @type string $meta_type MySQL data type that the meta_value column will be CAST to for comparisons. 175 * See WP_Meta_Query::__construct for accepted values and default value. 176 * @type string $meta_type_key MySQL data type that the meta_key column will be CAST to for comparisons. 177 * See WP_Meta_Query::__construct for accepted values and default value. 178 * @type array $meta_query An associative array of WP_Meta_Query arguments. 179 * See WP_Meta_Query::__construct for accepted values. 168 180 * } 169 181 */ -
trunk/src/wp-includes/class-wp-term-query.php
r51518 r52226 89 89 * @since 4.7.0 Introduced 'object_ids' parameter. 90 90 * @since 4.9.0 Added 'slug__in' support for 'orderby'. 91 * @since 5.1.0 Introduced the 'meta_compare_key' parameter. 92 * @since 5.3.0 Introduced the 'meta_type_key' parameter. 91 93 * 92 94 * @param string|array $query { 93 95 * Optional. Array or query string of term query parameters. Default empty. 94 96 * 95 * @type string|array $taxonomy Taxonomy name, or array of taxonomies, to which results should 96 * be limited. 97 * @type int|int[] $object_ids Object ID, or array of object IDs. Results will be 98 * limited to terms associated with these objects. 99 * @type string $orderby Field(s) to order terms by. Accepts: 100 * * Term fields ('name', 'slug', 'term_group', 'term_id', 'id', 101 * 'description', 'parent', 'term_order'). Unless `$object_ids` 102 * is not empty, 'term_order' is treated the same as 'term_id'. 103 * * 'count' to use the number of objects associated with the term. 104 * * 'include' to match the 'order' of the `$include` param. 105 * * 'slug__in' to match the 'order' of the `$slug` param. 106 * * 'meta_value' 107 * * 'meta_value_num'. 108 * * The value of `$meta_key`. 109 * * The array keys of `$meta_query`. 110 * * 'none' to omit the ORDER BY clause. 111 * Default 'name'. 112 * @type string $order Whether to order terms in ascending or descending order. 113 * Accepts 'ASC' (ascending) or 'DESC' (descending). 114 * Default 'ASC'. 115 * @type bool|int $hide_empty Whether to hide terms not assigned to any posts. Accepts 116 * 1|true or 0|false. Default 1|true. 117 * @type int[]|string $include Array or comma/space-separated string of term IDs to include. 118 * Default empty array. 119 * @type int[]|string $exclude Array or comma/space-separated string of term IDs to exclude. 120 * If `$include` is non-empty, `$exclude` is ignored. 121 * Default empty array. 122 * @type int[]|string $exclude_tree Array or comma/space-separated string of term IDs to exclude 123 * along with all of their descendant terms. If `$include` is 124 * non-empty, `$exclude_tree` is ignored. Default empty array. 125 * @type int|string $number Maximum number of terms to return. Accepts ''|0 (all) or any 126 * positive number. Default ''|0 (all). Note that $number may 127 * not return accurate results when coupled with `$object_ids`. 128 * See #41796 for details. 129 * @type int $offset The number by which to offset the terms query. Default empty. 130 * @type string $fields Term fields to query for. Accepts: 131 * * 'all' Returns an array of complete term objects (`WP_Term[]`). 132 * * 'all_with_object_id' Returns an array of term objects 133 * with the 'object_id' param (`WP_Term[]`). Works only 134 * when the `$object_ids` parameter is populated. 135 * * 'ids' Returns an array of term IDs (`int[]`). 136 * * 'tt_ids' Returns an array of term taxonomy IDs (`int[]`). 137 * * 'names' Returns an array of term names (`string[]`). 138 * * 'slugs' Returns an array of term slugs (`string[]`). 139 * * 'count' Returns the number of matching terms (`int`). 140 * * 'id=>parent' Returns an associative array of parent term IDs, 141 * keyed by term ID (`int[]`). 142 * * 'id=>name' Returns an associative array of term names, 143 * keyed by term ID (`string[]`). 144 * * 'id=>slug' Returns an associative array of term slugs, 145 * keyed by term ID (`string[]`). 146 * Default 'all'. 147 * @type bool $count Whether to return a term count. If true, will take precedence 148 * over `$fields`. Default false. 149 * @type string|array $name Name or array of names to return term(s) for. 150 * Default empty. 151 * @type string|array $slug Slug or array of slugs to return term(s) for. 152 * Default empty. 153 * @type int|int[] $term_taxonomy_id Term taxonomy ID, or array of term taxonomy IDs, 154 * to match when querying terms. 155 * @type bool $hierarchical Whether to include terms that have non-empty descendants 156 * (even if `$hide_empty` is set to true). Default true. 157 * @type string $search Search criteria to match terms. Will be SQL-formatted with 158 * wildcards before and after. Default empty. 159 * @type string $name__like Retrieve terms with criteria by which a term is LIKE 160 * `$name__like`. Default empty. 161 * @type string $description__like Retrieve terms where the description is LIKE 162 * `$description__like`. Default empty. 163 * @type bool $pad_counts Whether to pad the quantity of a term's children in the 164 * quantity of each term's "count" object variable. 165 * Default false. 166 * @type string $get Whether to return terms regardless of ancestry or whether the 167 * terms are empty. Accepts 'all' or '' (disabled). 168 * Default ''. 169 * @type int $child_of Term ID to retrieve child terms of. If multiple taxonomies 170 * are passed, `$child_of` is ignored. Default 0. 171 * @type int $parent Parent term ID to retrieve direct-child terms of. 172 * Default empty. 173 * @type bool $childless True to limit results to terms that have no children. 174 * This parameter has no effect on non-hierarchical taxonomies. 175 * Default false. 176 * @type string $cache_domain Unique cache key to be produced when this query is stored in 177 * an object cache. Default 'core'. 178 * @type bool $update_term_meta_cache Whether to prime meta caches for matched terms. Default true. 179 * @type array $meta_query Meta query clauses to limit retrieved terms by. 180 * See `WP_Meta_Query`. Default empty. 181 * @type string $meta_key Limit terms to those matching a specific metadata key. 182 * Can be used in conjunction with `$meta_value`. Default empty. 183 * @type string $meta_value Limit terms to those matching a specific metadata value. 184 * Usually used in conjunction with `$meta_key`. Default empty. 185 * @type string $meta_type MySQL data type that the `$meta_value` will be CAST to for 186 * comparisons. Default empty. 187 * @type string $meta_compare Comparison operator to test the 'meta_value'. Default empty. 97 * @type string|array $taxonomy Taxonomy name, or array of taxonomies, to which results should 98 * be limited. 99 * @type int|int[] $object_ids Object ID, or array of object IDs. Results will be 100 * limited to terms associated with these objects. 101 * @type string $orderby Field(s) to order terms by. Accepts: 102 * - Term fields ('name', 'slug', 'term_group', 'term_id', 'id', 103 * 'description', 'parent', 'term_order'). Unless `$object_ids` 104 * is not empty, 'term_order' is treated the same as 'term_id'. 105 * - 'count' to use the number of objects associated with the term. 106 * - 'include' to match the 'order' of the `$include` param. 107 * - 'slug__in' to match the 'order' of the `$slug` param. 108 * - 'meta_value' 109 * - 'meta_value_num'. 110 * - The value of `$meta_key`. 111 * - The array keys of `$meta_query`. 112 * - 'none' to omit the ORDER BY clause. 113 * Default 'name'. 114 * @type string $order Whether to order terms in ascending or descending order. 115 * Accepts 'ASC' (ascending) or 'DESC' (descending). 116 * Default 'ASC'. 117 * @type bool|int $hide_empty Whether to hide terms not assigned to any posts. Accepts 118 * 1|true or 0|false. Default 1|true. 119 * @type int[]|string $include Array or comma/space-separated string of term IDs to include. 120 * Default empty array. 121 * @type int[]|string $exclude Array or comma/space-separated string of term IDs to exclude. 122 * If `$include` is non-empty, `$exclude` is ignored. 123 * Default empty array. 124 * @type int[]|string $exclude_tree Array or comma/space-separated string of term IDs to exclude 125 * along with all of their descendant terms. If `$include` is 126 * non-empty, `$exclude_tree` is ignored. Default empty array. 127 * @type int|string $number Maximum number of terms to return. Accepts ''|0 (all) or any 128 * positive number. Default ''|0 (all). Note that `$number` may 129 * not return accurate results when coupled with `$object_ids`. 130 * See #41796 for details. 131 * @type int $offset The number by which to offset the terms query. Default empty. 132 * @type string $fields Term fields to query for. Accepts: 133 * - 'all' Returns an array of complete term objects (`WP_Term[]`). 134 * - 'all_with_object_id' Returns an array of term objects 135 * with the 'object_id' param (`WP_Term[]`). Works only 136 * when the `$object_ids` parameter is populated. 137 * - 'ids' Returns an array of term IDs (`int[]`). 138 * - 'tt_ids' Returns an array of term taxonomy IDs (`int[]`). 139 * - 'names' Returns an array of term names (`string[]`). 140 * - 'slugs' Returns an array of term slugs (`string[]`). 141 * - 'count' Returns the number of matching terms (`int`). 142 * - 'id=>parent' Returns an associative array of parent term IDs, 143 * keyed by term ID (`int[]`). 144 * - 'id=>name' Returns an associative array of term names, 145 * keyed by term ID (`string[]`). 146 * - 'id=>slug' Returns an associative array of term slugs, 147 * keyed by term ID (`string[]`). 148 * Default 'all'. 149 * @type bool $count Whether to return a term count. If true, will take precedence 150 * over `$fields`. Default false. 151 * @type string|array $name Name or array of names to return term(s) for. 152 * Default empty. 153 * @type string|array $slug Slug or array of slugs to return term(s) for. 154 * Default empty. 155 * @type int|int[] $term_taxonomy_id Term taxonomy ID, or array of term taxonomy IDs, 156 * to match when querying terms. 157 * @type bool $hierarchical Whether to include terms that have non-empty descendants 158 * (even if `$hide_empty` is set to true). Default true. 159 * @type string $search Search criteria to match terms. Will be SQL-formatted with 160 * wildcards before and after. Default empty. 161 * @type string $name__like Retrieve terms with criteria by which a term is LIKE 162 * `$name__like`. Default empty. 163 * @type string $description__like Retrieve terms where the description is LIKE 164 * `$description__like`. Default empty. 165 * @type bool $pad_counts Whether to pad the quantity of a term's children in the 166 * quantity of each term's "count" object variable. 167 * Default false. 168 * @type string $get Whether to return terms regardless of ancestry or whether the 169 * terms are empty. Accepts 'all' or '' (disabled). 170 * Default ''. 171 * @type int $child_of Term ID to retrieve child terms of. If multiple taxonomies 172 * are passed, `$child_of` is ignored. Default 0. 173 * @type int $parent Parent term ID to retrieve direct-child terms of. 174 * Default empty. 175 * @type bool $childless True to limit results to terms that have no children. 176 * This parameter has no effect on non-hierarchical taxonomies. 177 * Default false. 178 * @type string $cache_domain Unique cache key to be produced when this query is stored in 179 * an object cache. Default 'core'. 180 * @type bool $update_term_meta_cache Whether to prime meta caches for matched terms. Default true. 181 * @type string|string[] $meta_key Meta key or keys to filter by. 182 * @type string|string[] $meta_value Meta value or values to filter by. 183 * @type string $meta_compare MySQL operator used for comparing the meta value. 184 * See WP_Meta_Query::__construct for accepted values and default value. 185 * @type string $meta_compare_key MySQL operator used for comparing the meta key. 186 * See WP_Meta_Query::__construct for accepted values and default value. 187 * @type string $meta_type MySQL data type that the meta_value column will be CAST to for comparisons. 188 * See WP_Meta_Query::__construct for accepted values and default value. 189 * @type string $meta_type_key MySQL data type that the meta_key column will be CAST to for comparisons. 190 * See WP_Meta_Query::__construct for accepted values and default value. 191 * @type array $meta_query An associative array of WP_Meta_Query arguments. 192 * See WP_Meta_Query::__construct for accepted values. 188 193 * } 189 194 */ -
trunk/src/wp-includes/class-wp-user-query.php
r51943 r52226 137 137 * @since 4.7.0 Added 'nicename', 'nicename__in', 'nicename__not_in', 'login', 'login__in', 138 138 * and 'login__not_in' parameters. 139 * @since 5.1.0 Introduced the 'meta_compare_key' parameter. 140 * @since 5.3.0 Introduced the 'meta_type_key' parameter. 139 141 * @since 5.9.0 Added 'capability', 'capability__in', and 'capability__not_in' parameters. 140 142 * … … 145 147 * Optional. Array or string of Query parameters. 146 148 * 147 * @type int $blog_id The site ID. Default is the current site. 148 * @type string|array $role An array or a comma-separated list of role names that users must match 149 * to be included in results. Note that this is an inclusive list: users 150 * must match *each* role. Default empty. 151 * @type string[] $role__in An array of role names. Matched users must have at least one of these 152 * roles. Default empty array. 153 * @type string[] $role__not_in An array of role names to exclude. Users matching one or more of these 154 * roles will not be included in results. Default empty array. 155 * @type string $capability An array or a comma-separated list of capability names that users must match 156 * to be included in results. Note that this is an inclusive list: users 157 * must match *each* capability. 158 * Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}. 159 * Default empty. 160 * @type string[] $capability__in An array of capability names. Matched users must have at least one of these 161 * capabilities. 162 * Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}. 163 * Default empty array. 164 * @type string[] $capability__not_in An array of capability names to exclude. Users matching one or more of these 165 * capabilities will not be included in results. 166 * Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}. 167 * Default empty array. 168 * @type string $meta_key User meta key. Default empty. 169 * @type string $meta_value User meta value. Default empty. 170 * @type string $meta_compare Comparison operator to test the `$meta_value`. Accepts '=', '!=', 171 * '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 172 * 'BETWEEN', 'NOT BETWEEN', 'EXISTS', 'NOT EXISTS', 'REGEXP', 173 * 'NOT REGEXP', or 'RLIKE'. Default '='. 174 * @type int[] $include An array of user IDs to include. Default empty array. 175 * @type int[] $exclude An array of user IDs to exclude. Default empty array. 176 * @type string $search Search keyword. Searches for possible string matches on columns. 177 * When `$search_columns` is left empty, it tries to determine which 178 * column to search in based on search string. Default empty. 179 * @type string[] $search_columns Array of column names to be searched. Accepts 'ID', 'user_login', 180 * 'user_email', 'user_url', 'user_nicename', 'display_name'. 181 * Default empty array. 182 * @type string|array $orderby Field(s) to sort the retrieved users by. May be a single value, 183 * an array of values, or a multi-dimensional array with fields as 184 * keys and orders ('ASC' or 'DESC') as values. Accepted values are 185 * 'ID', 'display_name' (or 'name'), 'include', 'user_login' 186 * (or 'login'), 'login__in', 'user_nicename' (or 'nicename'), 187 * 'nicename__in', 'user_email (or 'email'), 'user_url' (or 'url'), 188 * 'user_registered' (or 'registered'), 'post_count', 'meta_value', 189 * 'meta_value_num', the value of `$meta_key`, or an array key of 190 * `$meta_query`. To use 'meta_value' or 'meta_value_num', `$meta_key` 191 * must be also be defined. Default 'user_login'. 192 * @type string $order Designates ascending or descending order of users. Order values 193 * passed as part of an `$orderby` array take precedence over this 194 * parameter. Accepts 'ASC', 'DESC'. Default 'ASC'. 195 * @type int $offset Number of users to offset in retrieved results. Can be used in 196 * conjunction with pagination. Default 0. 197 * @type int $number Number of users to limit the query for. Can be used in 198 * conjunction with pagination. Value -1 (all) is supported, but 199 * should be used with caution on larger sites. 200 * Default -1 (all users). 201 * @type int $paged When used with number, defines the page of results to return. 202 * Default 1. 203 * @type bool $count_total Whether to count the total number of users found. If pagination 204 * is not needed, setting this to false can improve performance. 205 * Default true. 206 * @type string|array $fields Which fields to return. Single or all fields (string), or array 207 * of fields. Accepts 'ID', 'display_name', 'user_login', 208 * 'user_nicename', 'user_email', 'user_url', 'user_registered'. 209 * Use 'all' for all fields and 'all_with_meta' to include 210 * meta fields. Default 'all'. 211 * @type string $who Type of users to query. Accepts 'authors'. 212 * Default empty (all users). 213 * @type bool|array $has_published_posts Pass an array of post types to filter results to users who have 214 * published posts in those post types. `true` is an alias for all 215 * public post types. 216 * @type string $nicename The user nicename. Default empty. 217 * @type string[] $nicename__in An array of nicenames to include. Users matching one of these 218 * nicenames will be included in results. Default empty array. 219 * @type string[] $nicename__not_in An array of nicenames to exclude. Users matching one of these 220 * nicenames will not be included in results. Default empty array. 221 * @type string $login The user login. Default empty. 222 * @type string[] $login__in An array of logins to include. Users matching one of these 223 * logins will be included in results. Default empty array. 224 * @type string[] $login__not_in An array of logins to exclude. Users matching one of these 225 * logins will not be included in results. Default empty array. 149 * @type int $blog_id The site ID. Default is the current site. 150 * @type string|array $role An array or a comma-separated list of role names that users must match 151 * to be included in results. Note that this is an inclusive list: users 152 * must match *each* role. Default empty. 153 * @type string[] $role__in An array of role names. Matched users must have at least one of these 154 * roles. Default empty array. 155 * @type string[] $role__not_in An array of role names to exclude. Users matching one or more of these 156 * roles will not be included in results. Default empty array. 157 * @type string|string[] $meta_key Meta key or keys to filter by. 158 * @type string|string[] $meta_value Meta value or values to filter by. 159 * @type string $meta_compare MySQL operator used for comparing the meta value. 160 * See WP_Meta_Query::__construct for accepted values and default value. 161 * @type string $meta_compare_key MySQL operator used for comparing the meta key. 162 * See WP_Meta_Query::__construct for accepted values and default value. 163 * @type string $meta_type MySQL data type that the meta_value column will be CAST to for comparisons. 164 * See WP_Meta_Query::__construct for accepted values and default value. 165 * @type string $meta_type_key MySQL data type that the meta_key column will be CAST to for comparisons. 166 * See WP_Meta_Query::__construct for accepted values and default value. 167 * @type array $meta_query An associative array of WP_Meta_Query arguments. 168 * See WP_Meta_Query::__construct for accepted values. 169 * @type string $capability An array or a comma-separated list of capability names that users must match 170 * to be included in results. Note that this is an inclusive list: users 171 * must match *each* capability. 172 * Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}. 173 * Default empty. 174 * @type string[] $capability__in An array of capability names. Matched users must have at least one of these 175 * capabilities. 176 * Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}. 177 * Default empty array. 178 * @type string[] $capability__not_in An array of capability names to exclude. Users matching one or more of these 179 * capabilities will not be included in results. 180 * Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}. 181 * Default empty array. 182 * @type int[] $include An array of user IDs to include. Default empty array. 183 * @type int[] $exclude An array of user IDs to exclude. Default empty array. 184 * @type string $search Search keyword. Searches for possible string matches on columns. 185 * When `$search_columns` is left empty, it tries to determine which 186 * column to search in based on search string. Default empty. 187 * @type string[] $search_columns Array of column names to be searched. Accepts 'ID', 'user_login', 188 * 'user_email', 'user_url', 'user_nicename', 'display_name'. 189 * Default empty array. 190 * @type string|array $orderby Field(s) to sort the retrieved users by. May be a single value, 191 * an array of values, or a multi-dimensional array with fields as 192 * keys and orders ('ASC' or 'DESC') as values. Accepted values are: 193 * - 'ID' 194 * - 'display_name' (or 'name') 195 * - 'include' 196 * - 'user_login' (or 'login') 197 * - 'login__in' 198 * - 'user_nicename' (or 'nicename'), 199 * - 'nicename__in' 200 * - 'user_email (or 'email') 201 * - 'user_url' (or 'url'), 202 * - 'user_registered' (or 'registered') 203 * - 'post_count' 204 * - 'meta_value', 205 * - 'meta_value_num' 206 * - The value of `$meta_key` 207 * - An array key of `$meta_query` 208 * To use 'meta_value' or 'meta_value_num', `$meta_key` 209 * must be also be defined. Default 'user_login'. 210 * @type string $order Designates ascending or descending order of users. Order values 211 * passed as part of an `$orderby` array take precedence over this 212 * parameter. Accepts 'ASC', 'DESC'. Default 'ASC'. 213 * @type int $offset Number of users to offset in retrieved results. Can be used in 214 * conjunction with pagination. Default 0. 215 * @type int $number Number of users to limit the query for. Can be used in 216 * conjunction with pagination. Value -1 (all) is supported, but 217 * should be used with caution on larger sites. 218 * Default -1 (all users). 219 * @type int $paged When used with number, defines the page of results to return. 220 * Default 1. 221 * @type bool $count_total Whether to count the total number of users found. If pagination 222 * is not needed, setting this to false can improve performance. 223 * Default true. 224 * @type string|array $fields Which fields to return. Single or all fields (string), or array 225 * of fields. Accepts: 226 * - 'ID' 227 * - 'display_name' 228 * - 'user_login' 229 * - 'user_nicename' 230 * - 'user_email' 231 * - 'user_url' 232 * - 'user_registered' 233 * - 'all' for all fields 234 * - 'all_with_meta' to include meta fields. 235 * Default 'all'. 236 * @type string $who Type of users to query. Accepts 'authors'. 237 * Default empty (all users). 238 * @type bool|array $has_published_posts Pass an array of post types to filter results to users who have 239 * published posts in those post types. `true` is an alias for all 240 * public post types. 241 * @type string $nicename The user nicename. Default empty. 242 * @type string[] $nicename__in An array of nicenames to include. Users matching one of these 243 * nicenames will be included in results. Default empty array. 244 * @type string[] $nicename__not_in An array of nicenames to exclude. Users matching one of these 245 * nicenames will not be included in results. Default empty array. 246 * @type string $login The user login. Default empty. 247 * @type string[] $login__in An array of logins to include. Users matching one of these 248 * logins will be included in results. Default empty array. 249 * @type string[] $login__not_in An array of logins to exclude. Users matching one of these 250 * logins will not be included in results. Default empty array. 226 251 * } 227 252 */
Note: See TracChangeset
for help on using the changeset viewer.