From f4cda1b62ffca52115e4b04d9d75047060d69e68 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Tue, 24 Nov 2020 21:27:05 +0000 Subject: [PATCH] Docs: Upgrade more parameters in docblocks to used typed array notation. See #51800, #41756 Built from https://develop.svn.wordpress.org/trunk@49693 git-svn-id: http://core.svn.wordpress.org/trunk@49416 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/setup-config.php | 2 +- wp-includes/cache.php | 4 +-- wp-includes/category-template.php | 22 ++++++------ wp-includes/class-wp-comment-query.php | 15 ++++---- wp-includes/class-wp-network-query.php | 8 ++--- wp-includes/class-wp-query.php | 6 ++-- wp-includes/class-wp-site-query.php | 12 +++---- wp-includes/class-wp-user-query.php | 14 ++++---- wp-includes/comment-template.php | 20 +++++------ wp-includes/functions.php | 4 +-- wp-includes/ms-site.php | 14 ++++---- wp-includes/post-formats.php | 2 +- wp-includes/post-template.php | 6 ++-- wp-includes/post-thumbnail-template.php | 4 +-- wp-includes/post.php | 34 +++++++++---------- .../endpoints/class-wp-rest-controller.php | 2 +- wp-includes/taxonomy.php | 4 +-- wp-includes/user.php | 4 +-- wp-includes/version.php | 2 +- 19 files changed, 90 insertions(+), 89 deletions(-) diff --git a/wp-admin/setup-config.php b/wp-admin/setup-config.php index 244f12ed4a..f89968ca28 100644 --- a/wp-admin/setup-config.php +++ b/wp-admin/setup-config.php @@ -92,7 +92,7 @@ $step = isset( $_GET['step'] ) ? (int) $_GET['step'] : -1; * @global string $wp_local_package Locale code of the package. * @global WP_Locale $wp_locale WordPress date and time locale object. * - * @param string|array $body_classes + * @param string|string[] $body_classes Class attribute values for the body tag. */ function setup_config_display_header( $body_classes = array() ) { $body_classes = (array) $body_classes; diff --git a/wp-includes/cache.php b/wp-includes/cache.php index d02a0fb78b..7fa44ca9db 100644 --- a/wp-includes/cache.php +++ b/wp-includes/cache.php @@ -247,7 +247,7 @@ function wp_cache_switch_to_blog( $blog_id ) { * @see WP_Object_Cache::add_global_groups() * @global WP_Object_Cache $wp_object_cache Object cache global instance. * - * @param string|array $groups A group or an array of groups to add. + * @param string|string[] $groups A group or an array of groups to add. */ function wp_cache_add_global_groups( $groups ) { global $wp_object_cache; @@ -260,7 +260,7 @@ function wp_cache_add_global_groups( $groups ) { * * @since 2.6.0 * - * @param string|array $groups A group or an array of groups to add. + * @param string|string[] $groups A group or an array of groups to add. */ function wp_cache_add_non_persistent_groups( $groups ) { // Default cache doesn't persist so nothing to do here. diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php index fd29709bbc..727093468c 100644 --- a/wp-includes/category-template.php +++ b/wp-includes/category-template.php @@ -696,8 +696,8 @@ function wp_list_categories( $args = '' ) { * associated with the taxonomy. * @type bool $echo Whether or not to echo the return value. Default true. * } - * @return void|string|array Void if 'echo' argument is true, or on failure. Otherwise, tag cloud - * as a string or an array, depending on 'format' argument. + * @return void|string|string[] Void if 'echo' argument is true, or on failure. Otherwise, tag cloud + * as a string or an array, depending on 'format' argument. */ function wp_tag_cloud( $args = '' ) { $defaults = array( @@ -757,8 +757,8 @@ function wp_tag_cloud( $args = '' ) { * * @since 2.3.0 * - * @param string|array $return Tag cloud as a string or an array, depending on 'format' argument. - * @param array $args An array of tag cloud arguments. + * @param string|string[] $return Tag cloud as a string or an array, depending on 'format' argument. + * @param array $args An array of tag cloud arguments. */ $return = apply_filters( 'wp_tag_cloud', $return, $args ); @@ -825,7 +825,7 @@ function default_topic_count_scale( $count ) { * @type bool|int $show_count Whether to display the tag counts. Default 0. Accepts * 0, 1, or their bool equivalents. * } - * @return string|array Tag cloud as a string or an array, depending on 'format' argument. + * @return string|string[] Tag cloud as a string or an array, depending on 'format' argument. */ function wp_generate_tag_cloud( $tags, $args = '' ) { $defaults = array( @@ -979,7 +979,7 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { * * @since 4.3.0 * - * @param array $tags_data An array of term data for term used to generate the tag cloud. + * @param array[] $tags_data An array of term data arrays for terms used to generate the tag cloud. */ $tags_data = apply_filters( 'wp_generate_tag_cloud_data', $tags_data ); @@ -1030,11 +1030,11 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { * * @see wp_generate_tag_cloud() * - * @param array|string $return String containing the generated HTML tag cloud output - * or an array of tag links if the 'format' argument - * equals 'array'. - * @param WP_Term[] $tags An array of terms used in the tag cloud. - * @param array $args An array of wp_generate_tag_cloud() arguments. + * @param string[]|string $return String containing the generated HTML tag cloud output + * or an array of tag links if the 'format' argument + * equals 'array'. + * @param WP_Term[] $tags An array of terms used in the tag cloud. + * @param array $args An array of wp_generate_tag_cloud() arguments. */ return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args ); } else { diff --git a/wp-includes/class-wp-comment-query.php b/wp-includes/class-wp-comment-query.php index 34232eaa14..03348e74e8 100644 --- a/wp-includes/class-wp-comment-query.php +++ b/wp-includes/class-wp-comment-query.php @@ -228,17 +228,18 @@ class WP_Comment_Query { * comment status. Default 'all'. * @type string|array $type Include comments of a given type, or array of types. * Accepts 'comment', 'pings' (includes 'pingback' and - * 'trackback'), or anycustom type string. Default empty. - * @type array $type__in Include comments from a given array of comment types. + * 'trackback'), or any custom type string. Default empty. + * @type string[] $type__in Include comments from a given array of comment types. * Default empty. - * @type array $type__not_in Exclude comments from a given array of comment types. + * @type string[] $type__not_in Exclude comments from a given array of comment types. * Default empty. * @type int $user_id Include comments for a specific user ID. Default empty. * @type bool|string $hierarchical Whether to include comment descendants in the results. - * 'threaded' returns a tree, with each comment's children - * stored in a `children` property on the `WP_Comment` - * object. 'flat' returns a flat array of found comments plus - * their children. Pass `false` to leave out descendants. + * - 'threaded' returns a tree, with each comment's children + * stored in a `children` property on the `WP_Comment` object. + * - 'flat' returns a flat array of found comments plus + * their children. + * - Boolean `false` leaves out descendants. * The parameter is ignored (forced to `false`) when * `$fields` is 'ids' or 'counts'. Accepts 'threaded', * 'flat', or false. Default: false. diff --git a/wp-includes/class-wp-network-query.php b/wp-includes/class-wp-network-query.php index 4b79e8c870..e08375cf70 100644 --- a/wp-includes/class-wp-network-query.php +++ b/wp-includes/class-wp-network-query.php @@ -104,11 +104,11 @@ class WP_Network_Query { * an empty array, or 'none' to disable `ORDER BY` clause. Default 'id'. * @type string $order How to order retrieved networks. Accepts 'ASC', 'DESC'. Default 'ASC'. * @type string $domain Limit results to those affiliated with a given domain. Default empty. - * @type array $domain__in Array of domains to include affiliated networks for. Default empty. - * @type array $domain__not_in Array of domains to exclude affiliated networks for. Default empty. + * @type string[] $domain__in Array of domains to include affiliated networks for. Default empty. + * @type string[] $domain__not_in Array of domains to exclude affiliated networks for. Default empty. * @type string $path Limit results to those affiliated with a given path. Default empty. - * @type array $path__in Array of paths to include affiliated networks for. Default empty. - * @type array $path__not_in Array of paths to exclude affiliated networks for. Default empty. + * @type string[] $path__in Array of paths to include affiliated networks for. Default empty. + * @type string[] $path__not_in Array of paths to exclude affiliated networks for. Default empty. * @type string $search Search term(s) to retrieve matching networks for. Default empty. * @type bool $update_network_cache Whether to prime the cache for found networks. Default true. * } diff --git a/wp-includes/class-wp-query.php b/wp-includes/class-wp-query.php index 6b91b7e308..02d3be96c1 100644 --- a/wp-includes/class-wp-query.php +++ b/wp-includes/class-wp-query.php @@ -700,7 +700,7 @@ class WP_Query { * @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 string[] $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 int[] $post_parent__in An array containing parent page IDs to query child pages from. @@ -724,8 +724,8 @@ class WP_Query { * @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 + * @type string[] $tag_slug__and An array of tag slugs (AND in). + * @type string[] $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->__construct(). diff --git a/wp-includes/class-wp-site-query.php b/wp-includes/class-wp-site-query.php index d7033f72f1..cd562cb245 100644 --- a/wp-includes/class-wp-site-query.php +++ b/wp-includes/class-wp-site-query.php @@ -138,19 +138,19 @@ class WP_Site_Query { * @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. + * @type string[] $domain__in Array of domains to include affiliated sites for. Default empty. + * @type string[] $domain__not_in Array of domains to exclude affiliated sites for. Default empty. * @type string $path Limit results to those affiliated with a given path. Default empty. - * @type array $path__in Array of paths to include affiliated sites for. Default empty. - * @type array $path__not_in Array of paths to exclude affiliated sites for. Default empty. + * @type string[] $path__in Array of paths to include affiliated sites for. Default empty. + * @type string[] $path__not_in Array of paths to exclude affiliated sites for. Default empty. * @type int $public Limit results to public sites. Accepts '1' or '0'. Default empty. * @type int $archived Limit results to archived sites. Accepts '1' or '0'. Default empty. * @type int $mature Limit results to mature sites. Accepts '1' or '0'. Default empty. * @type int $spam Limit results to spam sites. Accepts '1' or '0'. Default empty. * @type int $deleted Limit results to deleted sites. Accepts '1' or '0'. Default empty. * @type int $lang_id Limit results to a language ID. Default empty. - * @type array $lang__in Array of language IDs to include affiliated sites for. Default empty. - * @type array $lang__not_in Array of language IDs to exclude affiliated sites for. Default empty. + * @type string[] $lang__in Array of language IDs to include affiliated sites for. Default empty. + * @type string[] $lang__not_in Array of language IDs to exclude affiliated sites for. Default empty. * @type string $search Search term(s) to retrieve matching sites for. Default empty. * @type array $search_columns Array of column names to be searched. Accepts 'domain' and 'path'. * Default empty array. diff --git a/wp-includes/class-wp-user-query.php b/wp-includes/class-wp-user-query.php index daa5fa6d6b..ca2dd0ff33 100644 --- a/wp-includes/class-wp-user-query.php +++ b/wp-includes/class-wp-user-query.php @@ -144,9 +144,9 @@ class WP_User_Query { * @type string|array $role An array or a comma-separated list of role names that users must match * to be included in results. Note that this is an inclusive list: users * must match *each* role. Default empty. - * @type array $role__in An array of role names. Matched users must have at least one of these + * @type string[] $role__in An array of role names. Matched users must have at least one of these * roles. Default empty array. - * @type array $role__not_in An array of role names to exclude. Users matching one or more of these + * @type string[] $role__not_in An array of role names to exclude. Users matching one or more of these * roles will not be included in results. Default empty array. * @type string $meta_key User meta key. Default empty. * @type string $meta_value User meta value. Default empty. @@ -159,7 +159,7 @@ class WP_User_Query { * @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. - * @type array $search_columns Array of column names to be searched. Accepts 'ID', 'user_login', + * @type string[] $search_columns Array of column names to be searched. Accepts 'ID', 'user_login', * 'user_email', 'user_url', 'user_nicename', 'display_name'. * Default empty array. * @type string|array $orderby Field(s) to sort the retrieved users by. May be a single value, @@ -197,14 +197,14 @@ class WP_User_Query { * published posts in those post types. `true` is an alias for all * public post types. * @type string $nicename The user nicename. Default empty. - * @type array $nicename__in An array of nicenames to include. Users matching one of these + * @type string[] $nicename__in An array of nicenames to include. Users matching one of these * nicenames will be included in results. Default empty array. - * @type array $nicename__not_in An array of nicenames to exclude. Users matching one of these + * @type string[] $nicename__not_in An array of nicenames to exclude. Users matching one of these * nicenames will not be included in results. Default empty array. * @type string $login The user login. Default empty. - * @type array $login__in An array of logins to include. Users matching one of these + * @type string[] $login__in An array of logins to include. Users matching one of these * logins will be included in results. Default empty array. - * @type array $login__not_in An array of logins to exclude. Users matching one of these + * @type string[] $login__not_in An array of logins to exclude. Users matching one of these * logins will not be included in results. Default empty array. * } */ diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php index e6b246cf14..aa521e473c 100644 --- a/wp-includes/comment-template.php +++ b/wp-includes/comment-template.php @@ -422,12 +422,12 @@ function comment_author_url_link( $linktext = '', $before = '', $after = '', $co * @since 2.7.0 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. * - * @param string|array $class Optional. One or more classes to add to the class list. - * Default empty. - * @param int|WP_Comment $comment Comment ID or WP_Comment object. Default current comment. - * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. - * @param bool $echo Optional. Whether to echo or return the output. - * Default true. + * @param string|string[] $class Optional. One or more classes to add to the class list. + * Default empty. + * @param int|WP_Comment $comment Comment ID or WP_Comment object. Default current comment. + * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. + * @param bool $echo Optional. Whether to echo or return the output. + * Default true. * @return void|string Void if `$echo` argument is true, comment classes if `$echo` is false. */ function comment_class( $class = '', $comment = null, $post_id = null, $echo = true ) { @@ -451,9 +451,9 @@ function comment_class( $class = '', $comment = null, $post_id = null, $echo = t * @global int $comment_depth * @global int $comment_thread_alt * - * @param string|array $class Optional. One or more classes to add to the class list. Default empty. - * @param int|WP_Comment $comment_id Comment ID or WP_Comment object. Default current comment. - * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. + * @param string|string[] $class Optional. One or more classes to add to the class list. Default empty. + * @param int|WP_Comment $comment_id Comment ID or WP_Comment object. Default current comment. + * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. * @return string[] An array of classes. */ function get_comment_class( $class = '', $comment_id = null, $post_id = null ) { @@ -530,7 +530,7 @@ function get_comment_class( $class = '', $comment_id = null, $post_id = null ) { * @since 2.7.0 * * @param string[] $classes An array of comment classes. - * @param string $class A comma-separated list of additional classes added to the list. + * @param string[] $class An array of additional classes added to the list. * @param int $comment_id The comment ID. * @param WP_Comment $comment The comment object. * @param int|WP_Post $post_id The post ID or WP_Post object. diff --git a/wp-includes/functions.php b/wp-includes/functions.php index 04838ac1a5..3b0dfda4bf 100644 --- a/wp-includes/functions.php +++ b/wp-includes/functions.php @@ -1159,8 +1159,8 @@ function add_query_arg( ...$args ) { * * @since 1.5.0 * - * @param string|array $key Query key or keys to remove. - * @param bool|string $query Optional. When false uses the current URL. Default false. + * @param string|string[] $key Query key or keys to remove. + * @param false|string $query Optional. When false uses the current URL. Default false. * @return string New URL query string. */ function remove_query_arg( $key, $query = false ) { diff --git a/wp-includes/ms-site.php b/wp-includes/ms-site.php index 561fade40a..a50a3c83a3 100644 --- a/wp-includes/ms-site.php +++ b/wp-includes/ms-site.php @@ -437,21 +437,21 @@ function update_sitemeta_cache( $site_ids ) { * @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. + * @type string[] $domain__in Array of domains to include affiliated sites for. Default empty. + * @type string[] $domain__not_in Array of domains to exclude affiliated sites for. Default empty. * @type string $path Limit results to those affiliated with a given path. Default empty. - * @type array $path__in Array of paths to include affiliated sites for. Default empty. - * @type array $path__not_in Array of paths to exclude affiliated sites for. Default empty. + * @type string[] $path__in Array of paths to include affiliated sites for. Default empty. + * @type string[] $path__not_in Array of paths to exclude affiliated sites for. Default empty. * @type int $public Limit results to public sites. Accepts '1' or '0'. Default empty. * @type int $archived Limit results to archived sites. Accepts '1' or '0'. Default empty. * @type int $mature Limit results to mature sites. Accepts '1' or '0'. Default empty. * @type int $spam Limit results to spam sites. Accepts '1' or '0'. Default empty. * @type int $deleted Limit results to deleted sites. Accepts '1' or '0'. Default empty. * @type int $lang_id Limit results to a language ID. Default empty. - * @type array $lang__in Array of language IDs to include affiliated sites for. Default empty. - * @type array $lang__not_in Array of language IDs to exclude affiliated sites for. Default empty. + * @type string[] $lang__in Array of language IDs to include affiliated sites for. Default empty. + * @type string[] $lang__not_in Array of language IDs to exclude affiliated sites for. Default empty. * @type string $search Search term(s) to retrieve matching sites for. Default empty. - * @type array $search_columns Array of column names to be searched. Accepts 'domain' and 'path'. + * @type string[] $search_columns Array of column names to be searched. Accepts 'domain' and 'path'. * Default empty array. * @type bool $update_site_cache Whether to prime the cache for found sites. Default true. * } diff --git a/wp-includes/post-formats.php b/wp-includes/post-formats.php index c1214da315..11b6d63de6 100644 --- a/wp-includes/post-formats.php +++ b/wp-includes/post-formats.php @@ -41,7 +41,7 @@ function get_post_format( $post = null ) { * * @since 3.1.0 * - * @param string|array $format Optional. The format or formats to check. + * @param string|string[] $format Optional. The format or formats to check. * @param WP_Post|int|null $post Optional. The post to check. Defaults to the current post in the loop. * @return bool True if the post has any of the given formats (or any format, if no format specified), * false otherwise. diff --git a/wp-includes/post-template.php b/wp-includes/post-template.php index 0aff64d119..e74c9d4444 100644 --- a/wp-includes/post-template.php +++ b/wp-includes/post-template.php @@ -451,8 +451,8 @@ function has_excerpt( $post = 0 ) { * * @since 2.7.0 * - * @param string|array $class One or more classes to add to the class list. - * @param int|WP_Post $post_id Optional. Post ID or post object. Defaults to the global `$post`. + * @param string|string[] $class One or more classes to add to the class list. + * @param int|WP_Post $post_id Optional. Post ID or post object. Defaults to the global `$post`. */ function post_class( $class = '', $post_id = null ) { // Separates classes with a single space, collates classes for post DIV. @@ -1749,7 +1749,7 @@ function get_the_password_form( $post = 0 ) { * @since 4.2.0 The `$template` parameter was changed to also accept an array of page templates. * @since 4.7.0 Now works with any post type, not just pages. * - * @param string|array $template The specific template filename or array of templates to match. + * @param string|string[] $template The specific template filename or array of templates to match. * @return bool True on success, false on failure. */ function is_page_template( $template = '' ) { diff --git a/wp-includes/post-thumbnail-template.php b/wp-includes/post-thumbnail-template.php index 8e9d265d40..1605afa27b 100644 --- a/wp-includes/post-thumbnail-template.php +++ b/wp-includes/post-thumbnail-template.php @@ -215,7 +215,7 @@ function get_the_post_thumbnail( $post = null, $size = 'post-thumbnail', $attr = * @since 4.4.0 * * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. - * @param string|array $size Optional. Registered image size to retrieve the source for or a flat + * @param string|int[] $size Optional. Registered image size to retrieve the source for or a flat * array of height and width dimensions. Default 'post-thumbnail'. * @return string|false Post thumbnail URL or false if no URL is available. */ @@ -234,7 +234,7 @@ function get_the_post_thumbnail_url( $post = null, $size = 'post-thumbnail' ) { * * @since 4.4.0 * - * @param string|array $size Optional. Image size to use. Accepts any valid image size, + * @param string|int[] $size Optional. Image size to use. Accepts any valid image size, * or an array of width and height values in pixels (in that order). * Default 'post-thumbnail'. */ diff --git a/wp-includes/post.php b/wp-includes/post.php index 6bd65aecd8..05321e73a7 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -1307,7 +1307,7 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) * * @type string $label Name of the post type shown in the menu. Usually plural. * Default is value of $labels['name']. - * @type array $labels An array of labels for this post type. If not set, post + * @type string[] $labels An array of labels for this post type. If not set, post * labels are inherited for non-hierarchical types and page * labels for hierarchical ones. See get_post_type_labels() for a full * list of supported labels. @@ -1356,7 +1356,7 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) * May be passed as an array to allow for alternative plurals when using * this argument as a base to construct the capabilities, e.g. * array('story', 'stories'). Default 'post'. - * @type array $capabilities Array of capabilities for this post type. $capability_type is used + * @type string[] $capabilities Array of capabilities for this post type. $capability_type is used * as a base to construct capabilities by default. * See get_post_type_capabilities(). * @type bool $map_meta_cap Whether to use the internal default meta capability handling. @@ -1375,7 +1375,7 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) * @type callable $register_meta_box_cb Provide a callback function that sets up the meta boxes for the * edit form. Do remove_meta_box() and add_meta_box() calls in the * callback. Default null. - * @type array $taxonomies An array of taxonomy identifiers that will be registered for the + * @type string[] $taxonomies An array of taxonomy identifiers that will be registered for the * post type. Taxonomies can be registered later with register_taxonomy() * or register_taxonomy_for_object_type(). * Default empty array. @@ -2722,8 +2722,8 @@ function wp_count_posts( $type = 'post', $perm = '' ) { * * @global wpdb $wpdb WordPress database abstraction object. * - * @param string|array $mime_type Optional. Array or comma-separated list of - * MIME patterns. Default empty. + * @param string|string[] $mime_type Optional. Array or comma-separated list of + * MIME patterns. Default empty. * @return object An object containing the attachment counts by mime type. */ function wp_count_attachments( $mime_type = '' ) { @@ -2863,9 +2863,9 @@ function get_post_mime_types() { * * @since 2.5.0 * - * @param string|array $wildcard_mime_types Mime types, e.g. audio/mpeg or image (same as image/*) - * or flash (same as *flash*). - * @param string|array $real_mime_types Real post mime type values. + * @param string|string[] $wildcard_mime_types Mime types, e.g. audio/mpeg or image (same as image/*) + * or flash (same as *flash*). + * @param string|string[] $real_mime_types Real post mime type values. * @return array array(wildcard=>array(real types)). */ function wp_match_mime_types( $wildcard_mime_types, $real_mime_types ) { @@ -2915,10 +2915,10 @@ function wp_match_mime_types( $wildcard_mime_types, $real_mime_types ) { * * @since 2.5.0 * - * @param string|array $post_mime_types List of mime types or comma separated string - * of mime types. - * @param string $table_alias Optional. Specify a table alias, if needed. - * Default empty. + * @param string|string[] $post_mime_types List of mime types or comma separated string + * of mime types. + * @param string $table_alias Optional. Specify a table alias, if needed. + * Default empty. * @return string The SQL AND clause for mime searching. */ function wp_post_mime_type_where( $post_mime_types, $table_alias = '' ) { @@ -3520,11 +3520,11 @@ function wp_get_post_tags( $post_id = 0, $args = array() ) { * * @since 2.8.0 * - * @param int $post_id Optional. The Post ID. Does not default to the ID of the - * global $post. Default 0. - * @param string|array $taxonomy Optional. The taxonomy slug or array of slugs for which - * to retrieve terms. Default 'post_tag'. - * @param array $args { + * @param int $post_id Optional. The Post ID. Does not default to the ID of the + * global $post. Default 0. + * @param string|string[] $taxonomy Optional. The taxonomy slug or array of slugs for which + * to retrieve terms. Default 'post_tag'. + * @param array $args { * Optional. Term query parameters. See WP_Term_Query::__construct() for supported arguments. * * @type string $fields Term fields to retrieve. Default 'all'. diff --git a/wp-includes/rest-api/endpoints/class-wp-rest-controller.php b/wp-includes/rest-api/endpoints/class-wp-rest-controller.php index d0d77d7ec1..03763b4eb0 100644 --- a/wp-includes/rest-api/endpoints/class-wp-rest-controller.php +++ b/wp-includes/rest-api/endpoints/class-wp-rest-controller.php @@ -552,7 +552,7 @@ abstract class WP_REST_Controller { * @since 4.9.6 * * @param WP_REST_Request $request Full details about the request. - * @return array Fields to be included in the response. + * @return string[] Fields to be included in the response. */ public function get_fields_for_response( $request ) { $schema = $this->get_item_schema(); diff --git a/wp-includes/taxonomy.php b/wp-includes/taxonomy.php index 141353d1ee..e9d7ff1065 100644 --- a/wp-includes/taxonomy.php +++ b/wp-includes/taxonomy.php @@ -344,7 +344,7 @@ function is_taxonomy_hierarchical( $taxonomy ) { * @param array|string $args { * Optional. Array or query string of arguments for registering a taxonomy. * - * @type array $labels An array of labels for this taxonomy. By default, Tag labels are + * @type string[] $labels An array of labels for this taxonomy. By default, Tag labels are * used for non-hierarchical taxonomies, and Category labels are used * for hierarchical taxonomies. See accepted values in * get_taxonomy_labels(). Default empty array. @@ -382,7 +382,7 @@ function is_taxonomy_hierarchical( $taxonomy ) { * @type callable $meta_box_sanitize_cb Callback function for sanitizing taxonomy data saved from a meta * box. If no callback is defined, an appropriate one is determined * based on the value of `$meta_box_cb`. - * @type array $capabilities { + * @type string[] $capabilities { * Array of capabilities for this taxonomy. * * @type string $manage_terms Default 'manage_categories'. diff --git a/wp-includes/user.php b/wp-includes/user.php index b842e49921..8b78dc3343 100644 --- a/wp-includes/user.php +++ b/wp-includes/user.php @@ -1279,9 +1279,9 @@ function setup_userdata( $for_user_id = 0 ) { * @type string|array $role An array or a comma-separated list of role names that users must * match to be included in results. Note that this is an inclusive * list: users must match *each* role. Default empty. - * @type array $role__in An array of role names. Matched users must have at least one of + * @type string[] $role__in An array of role names. Matched users must have at least one of * these roles. Default empty array. - * @type array $role__not_in An array of role names to exclude. Users matching one or more of + * @type string[] $role__not_in An array of role names to exclude. Users matching one or more of * these roles will not be included in results. Default empty array. * } * @return string HTML dropdown list of users. diff --git a/wp-includes/version.php b/wp-includes/version.php index b25fe0706c..b50246ac00 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.7-alpha-49692'; +$wp_version = '5.7-alpha-49693'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.