Docs: Document parameters that accept an array of integers using typed array notation.
While many of these parameters also technically accept an array of numerical strings, they are all ultimately cast to an array of integers. Documenting them as such assists developers in understanding the expected types. See #51800, #41756 Built from https://develop.svn.wordpress.org/trunk@49672 git-svn-id: http://core.svn.wordpress.org/trunk@49395 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn
parent
6e472178d1
commit
35f6c356c1
|
|
@ -405,8 +405,8 @@ function get_author_posts_url( $author_id, $author_nicename = '' ) {
|
|||
* @type string $style If 'list', each author is wrapped in an `<li>` element, otherwise the authors
|
||||
* will be separated by commas.
|
||||
* @type bool $html Whether to list the items in HTML form or plaintext. Default true.
|
||||
* @type array|string $exclude Array or comma/space-separated list of author IDs to exclude. Default empty.
|
||||
* @type array|string $include Array or comma/space-separated list of author IDs to include. Default empty.
|
||||
* @type int[]|string $exclude Array or comma/space-separated list of author IDs to exclude. Default empty.
|
||||
* @type int[]|string $include Array or comma/space-separated list of author IDs to include. Default empty.
|
||||
* }
|
||||
* @return void|string Void if 'echo' argument is true, list of authors if 'echo' is false.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -486,16 +486,16 @@ function wp_dropdown_categories( $args = '' ) {
|
|||
* Array of optional arguments. See get_categories(), get_terms(), and WP_Term_Query::__construct()
|
||||
* for information on additional accepted arguments.
|
||||
*
|
||||
* @type int|array $current_category ID of category, or array of IDs of categories, that should get the
|
||||
* @type int|int[] $current_category ID of category, or array of IDs of categories, that should get the
|
||||
* 'current-cat' class. Default 0.
|
||||
* @type int $depth Category depth. Used for tab indentation. Default 0.
|
||||
* @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1, or their
|
||||
* bool equivalents. Default 1.
|
||||
* @type array|string $exclude Array or comma/space-separated string of term IDs to exclude.
|
||||
* @type int[]|string $exclude Array or comma/space-separated string of term IDs to exclude.
|
||||
* If `$hierarchical` is true, descendants of `$exclude` terms will also
|
||||
* be excluded; see `$exclude_tree`. See get_terms().
|
||||
* Default empty string.
|
||||
* @type array|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along
|
||||
* @type int[]|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along
|
||||
* with their descendants. See get_terms(). Default empty string.
|
||||
* @type string $feed Text to use for the feed link. Default 'Feed for all posts filed
|
||||
* under [cat name]'.
|
||||
|
|
|
|||
|
|
@ -147,10 +147,10 @@ class WP_Comment_Query {
|
|||
*
|
||||
* @type string $author_email Comment author email address. Default empty.
|
||||
* @type string $author_url Comment author URL. Default empty.
|
||||
* @type array $author__in Array of author IDs to include comments for. Default empty.
|
||||
* @type array $author__not_in Array of author IDs to exclude comments for. Default empty.
|
||||
* @type array $comment__in Array of comment IDs to include. Default empty.
|
||||
* @type array $comment__not_in Array of comment IDs to exclude. Default empty.
|
||||
* @type int[] $author__in Array of author IDs to include comments for. Default empty.
|
||||
* @type int[] $author__not_in Array of author IDs to exclude comments for. Default empty.
|
||||
* @type int[] $comment__in Array of comment IDs to include. Default empty.
|
||||
* @type int[] $comment__not_in Array of comment IDs to exclude. Default empty.
|
||||
* @type bool $count Whether to return a comment count (true) or array of
|
||||
* comment objects (false). Default false.
|
||||
* @type array $date_query Date query clauses to limit comments by. See WP_Date_Query.
|
||||
|
|
@ -195,20 +195,20 @@ class WP_Comment_Query {
|
|||
* Default: 'DESC'.
|
||||
* @type int $parent Parent ID of comment to retrieve children of.
|
||||
* Default empty.
|
||||
* @type array $parent__in Array of parent IDs of comments to retrieve children for.
|
||||
* @type int[] $parent__in Array of parent IDs of comments to retrieve children for.
|
||||
* Default empty.
|
||||
* @type array $parent__not_in Array of parent IDs of comments *not* to retrieve
|
||||
* @type int[] $parent__not_in Array of parent IDs of comments *not* to retrieve
|
||||
* children for. Default empty.
|
||||
* @type array $post_author__in Array of author IDs to retrieve comments for.
|
||||
* @type int[] $post_author__in Array of author IDs to retrieve comments for.
|
||||
* Default empty.
|
||||
* @type array $post_author__not_in Array of author IDs *not* to retrieve comments for.
|
||||
* @type int[] $post_author__not_in Array of author IDs *not* to retrieve comments for.
|
||||
* Default empty.
|
||||
* @type int $post_ID Currently unused.
|
||||
* @type int $post_id Limit results to those affiliated with a given post ID.
|
||||
* Default 0.
|
||||
* @type array $post__in Array of post IDs to include affiliated comments for.
|
||||
* @type int[] $post__in Array of post IDs to include affiliated comments for.
|
||||
* Default empty.
|
||||
* @type array $post__not_in Array of post IDs to exclude affiliated comments for.
|
||||
* @type int[] $post__not_in Array of post IDs to exclude affiliated comments for.
|
||||
* Default empty.
|
||||
* @type int $post_author Post author ID to limit results by. Default empty.
|
||||
* @type string|array $post_status Post status or array of post statuses to retrieve
|
||||
|
|
|
|||
|
|
@ -115,27 +115,27 @@ class WP_Date_Query {
|
|||
* arrays in some time-related parameters. Default '='.
|
||||
* @type bool $inclusive Optional. Include results from dates specified in 'before' or
|
||||
* 'after'. Default false.
|
||||
* @type int|array $year Optional. The four-digit year number. Accepts any four-digit year
|
||||
* @type int|int[] $year Optional. The four-digit year number. Accepts any four-digit year
|
||||
* or an array of years if `$compare` supports it. Default empty.
|
||||
* @type int|array $month Optional. The two-digit month number. Accepts numbers 1-12 or an
|
||||
* @type int|int[] $month Optional. The two-digit month number. Accepts numbers 1-12 or an
|
||||
* array of valid numbers if `$compare` supports it. Default empty.
|
||||
* @type int|array $week Optional. The week number of the year. Accepts numbers 0-53 or an
|
||||
* @type int|int[] $week Optional. The week number of the year. Accepts numbers 0-53 or an
|
||||
* array of valid numbers if `$compare` supports it. Default empty.
|
||||
* @type int|array $dayofyear Optional. The day number of the year. Accepts numbers 1-366 or an
|
||||
* @type int|int[] $dayofyear Optional. The day number of the year. Accepts numbers 1-366 or an
|
||||
* array of valid numbers if `$compare` supports it.
|
||||
* @type int|array $day Optional. The day of the month. Accepts numbers 1-31 or an array
|
||||
* @type int|int[] $day Optional. The day of the month. Accepts numbers 1-31 or an array
|
||||
* of valid numbers if `$compare` supports it. Default empty.
|
||||
* @type int|array $dayofweek Optional. The day number of the week. Accepts numbers 1-7 (1 is
|
||||
* @type int|int[] $dayofweek Optional. The day number of the week. Accepts numbers 1-7 (1 is
|
||||
* Sunday) or an array of valid numbers if `$compare` supports it.
|
||||
* Default empty.
|
||||
* @type int|array $dayofweek_iso Optional. The day number of the week (ISO). Accepts numbers 1-7
|
||||
* @type int|int[] $dayofweek_iso Optional. The day number of the week (ISO). Accepts numbers 1-7
|
||||
* (1 is Monday) or an array of valid numbers if `$compare` supports it.
|
||||
* Default empty.
|
||||
* @type int|array $hour Optional. The hour of the day. Accepts numbers 0-23 or an array
|
||||
* @type int|int[] $hour Optional. The hour of the day. Accepts numbers 0-23 or an array
|
||||
* of valid numbers if `$compare` supports it. Default empty.
|
||||
* @type int|array $minute Optional. The minute of the hour. Accepts numbers 0-60 or an array
|
||||
* @type int|int[] $minute Optional. The minute of the hour. Accepts numbers 0-60 or an array
|
||||
* of valid numbers if `$compare` supports it. Default empty.
|
||||
* @type int|array $second Optional. The second of the minute. Accepts numbers 0-60 or an
|
||||
* @type int|int[] $second Optional. The second of the minute. Accepts numbers 0-60 or an
|
||||
* array of valid numbers if `$compare` supports it. Default empty.
|
||||
* }
|
||||
* }
|
||||
|
|
|
|||
|
|
@ -89,8 +89,8 @@ class WP_Network_Query {
|
|||
* @param string|array $query {
|
||||
* Optional. Array or query string of network query parameters. Default empty.
|
||||
*
|
||||
* @type array $network__in Array of network IDs to include. Default empty.
|
||||
* @type array $network__not_in Array of network IDs to exclude. Default empty.
|
||||
* @type int[] $network__in Array of network IDs to include. Default empty.
|
||||
* @type int[] $network__not_in Array of network IDs to exclude. Default empty.
|
||||
* @type bool $count Whether to return a network count (true) or array of network objects.
|
||||
* Default false.
|
||||
* @type string $fields Network fields to return. Accepts 'ids' (returns an array of network IDs)
|
||||
|
|
|
|||
|
|
@ -630,13 +630,13 @@ class WP_Query {
|
|||
* @type int $attachment_id Attachment post ID. Used for 'attachment' post_type.
|
||||
* @type int|string $author Author ID, or comma-separated list of IDs.
|
||||
* @type string $author_name User 'user_nicename'.
|
||||
* @type array $author__in An array of author IDs to query from.
|
||||
* @type array $author__not_in An array of author IDs not to query from.
|
||||
* @type int[] $author__in An array of author IDs to query from.
|
||||
* @type int[] $author__not_in An array of author IDs not to query from.
|
||||
* @type bool $cache_results Whether to cache post information. Default true.
|
||||
* @type int|string $cat Category ID or comma-separated list of IDs (this or any children).
|
||||
* @type array $category__and An array of category IDs (AND in).
|
||||
* @type array $category__in An array of category IDs (OR in, no children).
|
||||
* @type array $category__not_in An array of category IDs (NOT in).
|
||||
* @type int[] $category__and An array of category IDs (AND in).
|
||||
* @type int[] $category__in An array of category IDs (OR in, no children).
|
||||
* @type int[] $category__not_in An array of category IDs (NOT in).
|
||||
* @type string $category_name Use category slug (not name, this or any children).
|
||||
* @type array|int $comment_count Filter results by comment count. Provide an integer to match
|
||||
* comment count exactly. Provide an array with integer 'value'
|
||||
|
|
@ -696,15 +696,15 @@ class WP_Query {
|
|||
* @type string $pagename Page slug.
|
||||
* @type string $perm Show posts if user has the appropriate capability.
|
||||
* @type string $ping_status Ping status.
|
||||
* @type array $post__in An array of post IDs to retrieve, sticky posts will be included.
|
||||
* @type array $post__not_in An array of post IDs not to retrieve. Note: a string of comma-
|
||||
* @type int[] $post__in An array of post IDs to retrieve, sticky posts will be included.
|
||||
* @type int[] $post__not_in An array of post IDs not to retrieve. Note: a string of comma-
|
||||
* separated IDs will NOT work.
|
||||
* @type string $post_mime_type The mime type of the post. Used for 'attachment' post_type.
|
||||
* @type array $post_name__in An array of post slugs that results must match.
|
||||
* @type int $post_parent Page ID to retrieve child pages for. Use 0 to only retrieve
|
||||
* top-level pages.
|
||||
* @type array $post_parent__in An array containing parent page IDs to query child pages from.
|
||||
* @type array $post_parent__not_in An array containing parent page IDs not to query child pages from.
|
||||
* @type int[] $post_parent__in An array containing parent page IDs to query child pages from.
|
||||
* @type int[] $post_parent__not_in An array containing parent page IDs not to query child pages from.
|
||||
* @type string|array $post_type A post type slug (string) or array of post type slugs.
|
||||
* Default 'any' if using 'tax_query'.
|
||||
* @type string|array $post_status A post status (string) or array of post statuses.
|
||||
|
|
@ -720,15 +720,15 @@ class WP_Query {
|
|||
* @type bool $sentence Whether to search by phrase. Default false.
|
||||
* @type bool $suppress_filters Whether to suppress filters. Default false.
|
||||
* @type string $tag Tag slug. Comma-separated (either), Plus-separated (all).
|
||||
* @type array $tag__and An array of tag IDs (AND in).
|
||||
* @type array $tag__in An array of tag IDs (OR in).
|
||||
* @type array $tag__not_in An array of tag IDs (NOT in).
|
||||
* @type int[] $tag__and An array of tag IDs (AND in).
|
||||
* @type int[] $tag__in An array of tag IDs (OR in).
|
||||
* @type int[] $tag__not_in An array of tag IDs (NOT in).
|
||||
* @type int $tag_id Tag id or comma-separated list of IDs.
|
||||
* @type array $tag_slug__and An array of tag slugs (AND in).
|
||||
* @type array $tag_slug__in An array of tag slugs (OR in). unless 'ignore_sticky_posts' is
|
||||
* true. Note: a string of comma-separated IDs will NOT work.
|
||||
* @type array $tax_query An associative array of WP_Tax_Query arguments.
|
||||
* See WP_Tax_Query->queries.
|
||||
* See WP_Tax_Query->__construct().
|
||||
* @type string $title Post title.
|
||||
* @type bool $update_post_meta_cache Whether to update the post meta cache. Default true.
|
||||
* @type bool $update_post_term_cache Whether to update the post term cache. Default true.
|
||||
|
|
|
|||
|
|
@ -114,8 +114,8 @@ class WP_Site_Query {
|
|||
* @param string|array $query {
|
||||
* Optional. Array or query string of site query parameters. Default empty.
|
||||
*
|
||||
* @type array $site__in Array of site IDs to include. Default empty.
|
||||
* @type array $site__not_in Array of site IDs to exclude. Default empty.
|
||||
* @type int[] $site__in Array of site IDs to include. Default empty.
|
||||
* @type int[] $site__not_in Array of site IDs to exclude. Default empty.
|
||||
* @type bool $count Whether to return a site count (true) or array of site objects.
|
||||
* Default false.
|
||||
* @type array $date_query Date query clauses to limit sites by. See WP_Date_Query.
|
||||
|
|
@ -135,8 +135,8 @@ class WP_Site_Query {
|
|||
* @type string $order How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'.
|
||||
* @type int $network_id Limit results to those affiliated with a given network ID. If 0,
|
||||
* include all networks. Default 0.
|
||||
* @type array $network__in Array of network IDs to include affiliated sites for. Default empty.
|
||||
* @type array $network__not_in Array of network IDs to exclude affiliated sites for. Default empty.
|
||||
* @type int[] $network__in Array of network IDs to include affiliated sites for. Default empty.
|
||||
* @type int[] $network__not_in Array of network IDs to exclude affiliated sites for. Default empty.
|
||||
* @type string $domain Limit results to those affiliated with a given domain. Default empty.
|
||||
* @type array $domain__in Array of domains to include affiliated sites for. Default empty.
|
||||
* @type array $domain__not_in Array of domains to exclude affiliated sites for. Default empty.
|
||||
|
|
|
|||
|
|
@ -94,7 +94,7 @@ class WP_Term_Query {
|
|||
*
|
||||
* @type string|array $taxonomy Taxonomy name, or array of taxonomies, to which results should
|
||||
* be limited.
|
||||
* @type int|array $object_ids Optional. Object ID, or array of object IDs. Results will be
|
||||
* @type int|int[] $object_ids Optional. Object ID, or array of object IDs. Results will be
|
||||
* limited to terms associated with these objects.
|
||||
* @type string $orderby Field(s) to order terms by. Accepts:
|
||||
* - term fields ('name', 'slug', 'term_group', 'term_id', 'id',
|
||||
|
|
@ -113,12 +113,12 @@ class WP_Term_Query {
|
|||
* 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.
|
||||
* @type int[]|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.
|
||||
* @type int[]|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
|
||||
* @type int[]|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
|
||||
|
|
@ -149,7 +149,7 @@ class WP_Term_Query {
|
|||
* Default empty.
|
||||
* @type string|array $slug Optional. Slug or array of slugs to return term(s) for.
|
||||
* Default empty.
|
||||
* @type int|array $term_taxonomy_id Optional. Term taxonomy ID, or array of term taxonomy IDs,
|
||||
* @type int|int[] $term_taxonomy_id Optional. Term taxonomy ID, or array of term taxonomy IDs,
|
||||
* to match when querying terms.
|
||||
* @type bool $hierarchical Whether to include terms that have non-empty descendants
|
||||
* (even if $hide_empty is set to true). Default true.
|
||||
|
|
|
|||
|
|
@ -154,8 +154,8 @@ class WP_User_Query {
|
|||
* '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN',
|
||||
* 'BETWEEN', 'NOT BETWEEN', 'EXISTS', 'NOT EXISTS', 'REGEXP',
|
||||
* 'NOT REGEXP', or 'RLIKE'. Default '='.
|
||||
* @type array $include An array of user IDs to include. Default empty array.
|
||||
* @type array $exclude An array of user IDs to exclude. Default empty array.
|
||||
* @type int[] $include An array of user IDs to include. Default empty array.
|
||||
* @type int[] $exclude An array of user IDs to exclude. Default empty array.
|
||||
* @type string $search Search keyword. Searches for possible string matches on columns.
|
||||
* When `$search_columns` is left empty, it tries to determine which
|
||||
* column to search in based on search string. Default empty.
|
||||
|
|
|
|||
|
|
@ -1666,7 +1666,7 @@ function get_edit_user_link( $user_id = null ) {
|
|||
* @since 1.5.0
|
||||
*
|
||||
* @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no
|
||||
* corresponding post exists.
|
||||
|
|
@ -1681,7 +1681,7 @@ function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxono
|
|||
* @since 1.5.0
|
||||
*
|
||||
* @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no
|
||||
* corresponding post exists.
|
||||
|
|
@ -1700,7 +1700,7 @@ function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy =
|
|||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
*
|
||||
* @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param bool $previous Optional. Whether to retrieve previous post. Default true
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no
|
||||
|
|
@ -1894,7 +1894,7 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
|
|||
*
|
||||
* @param string $title Optional. Link title format. Default '%title'.
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param bool $previous Optional. Whether to display link to previous or next post. Default true.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return string|void The adjacent post relational link URL.
|
||||
|
|
@ -1953,7 +1953,7 @@ function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $
|
|||
*
|
||||
* @param string $title Optional. Link title format. Default '%title'.
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
*/
|
||||
function adjacent_posts_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
|
||||
|
|
@ -1988,7 +1988,7 @@ function adjacent_posts_rel_link_wp_head() {
|
|||
*
|
||||
* @param string $title Optional. Link title format. Default '%title'.
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
*/
|
||||
function next_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
|
||||
|
|
@ -2004,7 +2004,7 @@ function next_post_rel_link( $title = '%title', $in_same_term = false, $excluded
|
|||
*
|
||||
* @param string $title Optional. Link title format. Default '%title'.
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default true.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default true.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
*/
|
||||
function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
|
||||
|
|
@ -2021,7 +2021,7 @@ function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded
|
|||
*
|
||||
* @param bool $in_same_term Optional. Whether returned post should be in a same taxonomy term.
|
||||
* Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
|
||||
* Default empty.
|
||||
* @param bool $start Optional. Whether to retrieve first or last post. Default true
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
|
|
@ -2085,7 +2085,7 @@ function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start
|
|||
* @param string $format Optional. Link anchor format. Default '« %link'.
|
||||
* @param string $link Optional. Link permalink format. Default '%title'.
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return string The link URL of the previous post in relation to the current post.
|
||||
*/
|
||||
|
|
@ -2103,7 +2103,7 @@ function get_previous_post_link( $format = '« %link', $link = '%title', $i
|
|||
* @param string $format Optional. Link anchor format. Default '« %link'.
|
||||
* @param string $link Optional. Link permalink format. Default '%title'.
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
*/
|
||||
function previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
|
||||
|
|
@ -2118,7 +2118,7 @@ function previous_post_link( $format = '« %link', $link = '%title', $in_sa
|
|||
* @param string $format Optional. Link anchor format. Default '« %link'.
|
||||
* @param string $link Optional. Link permalink format. Default '%title'.
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return string The link URL of the next post in relation to the current post.
|
||||
*/
|
||||
|
|
@ -2136,7 +2136,7 @@ function get_next_post_link( $format = '%link »', $link = '%title', $in_sa
|
|||
* @param string $format Optional. Link anchor format. Default '« %link'.
|
||||
* @param string $link Optional. Link permalink format. Default '%title'
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
*/
|
||||
function next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
|
||||
|
|
@ -2153,7 +2153,7 @@ function next_post_link( $format = '%link »', $link = '%title', $in_same_t
|
|||
* @param string $format Link anchor format.
|
||||
* @param string $link Link permalink format.
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded terms IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded terms IDs. Default empty.
|
||||
* @param bool $previous Optional. Whether to display link to previous or next post. Default true.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
* @return string The link URL of the previous or next post in relation to the current post.
|
||||
|
|
@ -2218,7 +2218,7 @@ function get_adjacent_post_link( $format, $link, $in_same_term = false, $exclude
|
|||
* @param string $format Link anchor format.
|
||||
* @param string $link Link permalink format.
|
||||
* @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
|
||||
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded category IDs. Default empty.
|
||||
* @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded category IDs. Default empty.
|
||||
* @param bool $previous Optional. Whether to display link to previous or next post. Default true.
|
||||
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
|
||||
*/
|
||||
|
|
@ -2567,7 +2567,7 @@ function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) {
|
|||
* @type string $prev_text Anchor text to display in the previous post link. Default '%title'.
|
||||
* @type string $next_text Anchor text to display in the next post link. Default '%title'.
|
||||
* @type bool $in_same_term Whether link should be in a same taxonomy term. Default false.
|
||||
* @type array|string $excluded_terms Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @type int[]|string $excluded_terms Array or comma-separated list of excluded term IDs. Default empty.
|
||||
* @type string $taxonomy Taxonomy, if `$in_same_term` is true. Default 'category'.
|
||||
* @type string $screen_reader_text Screen reader text for the nav element. Default 'Post navigation'.
|
||||
* @type string $aria_label ARIA label text for the nav element. Default 'Posts'.
|
||||
|
|
|
|||
|
|
@ -464,7 +464,7 @@ function get_admin_users_for_domain( $domain = '', $path = '' ) {
|
|||
* @param array $args {
|
||||
* Array of default arguments. Optional.
|
||||
*
|
||||
* @type int|array $network_id A network ID or array of network IDs. Set to null to retrieve sites
|
||||
* @type int|int[] $network_id A network ID or array of network IDs. Set to null to retrieve sites
|
||||
* from all networks. Defaults to current network ID.
|
||||
* @type int $public Retrieve public or non-public sites. Default null, for any.
|
||||
* @type int $archived Retrieve archived or non-archived sites. Default null, for any.
|
||||
|
|
|
|||
|
|
@ -413,8 +413,8 @@ function update_sitemeta_cache( $site_ids ) {
|
|||
* @param string|array $args {
|
||||
* Optional. Array or query string of site query parameters. Default empty.
|
||||
*
|
||||
* @type array $site__in Array of site IDs to include. Default empty.
|
||||
* @type array $site__not_in Array of site IDs to exclude. Default empty.
|
||||
* @type int[] $site__in Array of site IDs to include. Default empty.
|
||||
* @type int[] $site__not_in Array of site IDs to exclude. Default empty.
|
||||
* @type bool $count Whether to return a site count (true) or array of site objects.
|
||||
* Default false.
|
||||
* @type array $date_query Date query clauses to limit sites by. See WP_Date_Query.
|
||||
|
|
@ -434,8 +434,8 @@ function update_sitemeta_cache( $site_ids ) {
|
|||
* @type string $order How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'.
|
||||
* @type int $network_id Limit results to those affiliated with a given network ID. If 0,
|
||||
* include all networks. Default 0.
|
||||
* @type array $network__in Array of network IDs to include affiliated sites for. Default empty.
|
||||
* @type array $network__not_in Array of network IDs to exclude affiliated sites for. Default empty.
|
||||
* @type int[] $network__in Array of network IDs to include affiliated sites for. Default empty.
|
||||
* @type int[] $network__not_in Array of network IDs to exclude affiliated sites for. Default empty.
|
||||
* @type string $domain Limit results to those affiliated with a given domain. Default empty.
|
||||
* @type array $domain__in Array of domains to include affiliated sites for. Default empty.
|
||||
* @type array $domain__not_in Array of domains to exclude affiliated sites for. Default empty.
|
||||
|
|
|
|||
|
|
@ -2015,13 +2015,13 @@ function is_post_type_viewable( $post_type ) {
|
|||
* Optional. Arguments to retrieve posts. See WP_Query::parse_query() for all
|
||||
* available arguments.
|
||||
*
|
||||
* @type int $numberposts Total number of posts to retrieve. Is an alias of $posts_per_page
|
||||
* @type int $numberposts Total number of posts to retrieve. Is an alias of `$posts_per_page`
|
||||
* in WP_Query. Accepts -1 for all. Default 5.
|
||||
* @type int|string $category Category ID or comma-separated list of IDs (this or any children).
|
||||
* Is an alias of $cat in WP_Query. Default 0.
|
||||
* @type array $include An array of post IDs to retrieve, sticky posts will be included.
|
||||
* Is an alias of $post__in in WP_Query. Default empty array.
|
||||
* @type array $exclude An array of post IDs not to retrieve. Default empty array.
|
||||
* Is an alias of `$cat` in WP_Query. Default 0.
|
||||
* @type int[] $include An array of post IDs to retrieve, sticky posts will be included.
|
||||
* Is an alias of `$post__in` in WP_Query. Default empty array.
|
||||
* @type int[] $exclude An array of post IDs not to retrieve. Default empty array.
|
||||
* @type bool $suppress_filters Whether to suppress filters. Default true.
|
||||
* }
|
||||
* @return WP_Post[]|int[] Array of post objects or post IDs.
|
||||
|
|
@ -3650,7 +3650,7 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
|
|||
* @type int $menu_order The order the post should be displayed in. Default 0.
|
||||
* @type string $post_mime_type The mime type of the post. Default empty.
|
||||
* @type string $guid Global Unique ID for referencing the post. Default empty.
|
||||
* @type array $post_category Array of category IDs.
|
||||
* @type int[] $post_category Array of category IDs.
|
||||
* Defaults to value of the 'default_category' option.
|
||||
* @type array $tags_input Array of tag names, slugs, or IDs. Default empty.
|
||||
* @type array $tax_input Array of taxonomy terms keyed by their taxonomy name. Default empty.
|
||||
|
|
@ -4822,7 +4822,7 @@ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $a
|
|||
*
|
||||
* @param int $post_ID Optional. The Post ID. Does not default to the ID
|
||||
* of the global $post. Default 0.
|
||||
* @param array|int $post_categories Optional. List of category IDs, or the ID of a single category.
|
||||
* @param int[]|int $post_categories Optional. List of category IDs, or the ID of a single category.
|
||||
* Default empty array.
|
||||
* @param bool $append If true, don't delete existing categories, just add on.
|
||||
* If false, replace the categories with the new categories.
|
||||
|
|
@ -5484,8 +5484,8 @@ function get_page_uri( $page = 0 ) {
|
|||
* @type bool $hierarchical Whether to return pages hierarchically. If false in conjunction with
|
||||
* `$child_of` also being false, both arguments will be disregarded.
|
||||
* Default true.
|
||||
* @type array $exclude Array of page IDs to exclude. Default empty array.
|
||||
* @type array $include Array of page IDs to include. Cannot be used with `$child_of`,
|
||||
* @type int[] $exclude Array of page IDs to exclude. Default empty array.
|
||||
* @type int[] $include Array of page IDs to include. Cannot be used with `$child_of`,
|
||||
* `$parent`, `$exclude`, `$meta_key`, `$meta_value`, or `$hierarchical`.
|
||||
* Default empty array.
|
||||
* @type string $meta_key Only include pages with this meta key. Default empty.
|
||||
|
|
@ -5493,7 +5493,7 @@ function get_page_uri( $page = 0 ) {
|
|||
* Default empty.
|
||||
* @type string $authors A comma-separated list of author IDs. Default empty.
|
||||
* @type int $parent Page ID to return direct children of. Default -1, or no restriction.
|
||||
* @type string|array $exclude_tree Comma-separated string or array of page IDs to exclude.
|
||||
* @type string|int[] $exclude_tree Comma-separated string or array of page IDs to exclude.
|
||||
* Default empty array.
|
||||
* @type int $number The number of pages to return. Default 0, or all pages.
|
||||
* @type int $offset The number of pages to skip before returning. Requires `$number`.
|
||||
|
|
|
|||
|
|
@ -1254,9 +1254,9 @@ function setup_userdata( $for_user_id = 0 ) {
|
|||
* @type string $order Whether to order users in ascending or descending
|
||||
* order. Accepts 'ASC' (ascending) or 'DESC' (descending).
|
||||
* Default 'ASC'.
|
||||
* @type array|string $include Array or comma-separated list of user IDs to include.
|
||||
* @type int[]|string $include Array or comma-separated list of user IDs to include.
|
||||
* Default empty.
|
||||
* @type array|string $exclude Array or comma-separated list of user IDs to exclude.
|
||||
* @type int[]|string $exclude Array or comma-separated list of user IDs to exclude.
|
||||
* Default empty.
|
||||
* @type bool|int $multi Whether to skip the ID attribute on the 'select' element.
|
||||
* Accepts 1|true or 0|false. Default 0|false.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '5.7-alpha-49671';
|
||||
$wp_version = '5.7-alpha-49672';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
|
|||
Loading…
Reference in New Issue