From 1fbcdb22135c1325ae606b71347f1c1aa56451d6 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Thu, 23 Jul 2020 00:48:06 +0000 Subject: [PATCH] Docs: Various corrections to inline docblocks. See #49572 Built from https://develop.svn.wordpress.org/trunk@48573 git-svn-id: http://core.svn.wordpress.org/trunk@48335 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/taxonomy.php | 4 ++-- wp-admin/includes/template.php | 3 +-- wp-includes/blocks.php | 8 ++++---- wp-includes/class-wp-customize-manager.php | 2 +- wp-includes/class-wp-customize-setting.php | 16 ++++++++-------- wp-includes/class-wp-dependency.php | 2 +- wp-includes/functions.php | 4 ++-- wp-includes/general-template.php | 2 +- wp-includes/kses.php | 2 ++ wp-includes/pomo/po.php | 2 ++ wp-includes/post-template.php | 1 + wp-includes/script-loader.php | 3 ++- wp-includes/theme.php | 1 + wp-includes/version.php | 2 +- 14 files changed, 29 insertions(+), 23 deletions(-) diff --git a/wp-admin/includes/taxonomy.php b/wp-admin/includes/taxonomy.php index e711c9658b..7f7e60952c 100644 --- a/wp-admin/includes/taxonomy.php +++ b/wp-admin/includes/taxonomy.php @@ -300,8 +300,8 @@ function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) { * * @since 2.8.0 * - * @param int|string $tag_name - * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'. + * @param string $tag_name The term name. + * @param string $taxonomy Optional. The taxonomy within which to create the term. Default 'post_tag'. * @return array|WP_Error */ function wp_create_term( $tag_name, $taxonomy = 'post_tag' ) { diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index 0fcabcdd8e..b4b073f5a7 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -2221,12 +2221,11 @@ function get_post_states( $post ) { } /** - * Function to echo the attachment media states as HTML. + * Outputs the attachment media states as HTML. * * @since 3.2.0 * * @param WP_Post $post The attachment post to retrieve states for. - * @return string Media states string. */ function _media_states( $post ) { static $header_images; diff --git a/wp-includes/blocks.php b/wp-includes/blocks.php index 2eec688b75..a3fdd43888 100644 --- a/wp-includes/blocks.php +++ b/wp-includes/blocks.php @@ -359,7 +359,7 @@ function get_dynamic_block_names() { * * @since 5.3.1 * - * @param array $attributes Attributes object. + * @param array $block_attributes Attributes object. * @return string Serialized attributes. */ function serialize_block_attributes( $block_attributes ) { @@ -396,9 +396,9 @@ function strip_core_block_namespace( $block_name = null ) { * * @since 5.3.1 * - * @param string $block_name Block name. - * @param array $attributes Block attributes. - * @param string $content Block save content. + * @param string $block_name Block name. + * @param array $block_attributes Block attributes. + * @param string $block_content Block save content. * @return string Comment-delimited block content. */ function get_comment_delimited_block_content( $block_name = null, $block_attributes, $block_content ) { diff --git a/wp-includes/class-wp-customize-manager.php b/wp-includes/class-wp-customize-manager.php index 9832099f91..c5ee75143e 100644 --- a/wp-includes/class-wp-customize-manager.php +++ b/wp-includes/class-wp-customize-manager.php @@ -2292,7 +2292,7 @@ final class WP_Customize_Manager { * * @since 3.4.0 * - * @param $current_theme {@internal Parameter is not used} + * @param mixed $current_theme {@internal Parameter is not used} * @return string Theme name. */ public function current_theme( $current_theme ) { diff --git a/wp-includes/class-wp-customize-setting.php b/wp-includes/class-wp-customize-setting.php index 170e6746d9..2bfaea5382 100644 --- a/wp-includes/class-wp-customize-setting.php +++ b/wp-includes/class-wp-customize-setting.php @@ -846,8 +846,8 @@ class WP_Customize_Setting { * * @since 3.4.0 * - * @param $root - * @param $keys + * @param array $root + * @param array $keys * @param bool $create Default false. * @return array|void Keys are 'root', 'node', and 'key'. */ @@ -901,8 +901,8 @@ class WP_Customize_Setting { * * @since 3.4.0 * - * @param $root - * @param $keys + * @param array $root + * @param array $keys * @param mixed $value The value to update. * @return mixed */ @@ -927,8 +927,8 @@ class WP_Customize_Setting { * * @since 3.4.0 * - * @param $root - * @param $keys + * @param array $root + * @param array $keys * @param mixed $default A default value which is used as a fallback. Default null. * @return mixed The requested value or the default value. */ @@ -946,8 +946,8 @@ class WP_Customize_Setting { * * @since 3.4.0 * - * @param $root - * @param $keys + * @param array $root + * @param array $keys * @return bool True if value is set, false if not. */ final protected function multidimensional_isset( $root, $keys ) { diff --git a/wp-includes/class-wp-dependency.php b/wp-includes/class-wp-dependency.php index d941491976..ad4cd11caa 100644 --- a/wp-includes/class-wp-dependency.php +++ b/wp-includes/class-wp-dependency.php @@ -90,7 +90,7 @@ class _WP_Dependency { * @since 5.3.0 Formalized the existing `...$args` parameter by adding it * to the function signature. * - * @param ...$args Dependency information. + * @param mixed ...$args Dependency information. */ public function __construct( ...$args ) { list( $this->handle, $this->src, $this->deps, $this->ver, $this->args ) = $args; diff --git a/wp-includes/functions.php b/wp-includes/functions.php index 3c0937ed32..d8cc3a8bce 100644 --- a/wp-includes/functions.php +++ b/wp-includes/functions.php @@ -2597,8 +2597,8 @@ function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) * @access private * * @param string $filename The file name to check. - * $param array $files An array of existing files in the directory. - * $return bool True if the tested file name could match an existing file, false otherwise. + * @param array $files An array of existing files in the directory. + * @return bool True if the tested file name could match an existing file, false otherwise. */ function _wp_check_existing_file_names( $filename, $files ) { $fname = pathinfo( $filename, PATHINFO_FILENAME ); diff --git a/wp-includes/general-template.php b/wp-includes/general-template.php index 70392e8a63..839b103509 100644 --- a/wp-includes/general-template.php +++ b/wp-includes/general-template.php @@ -2162,7 +2162,7 @@ function calendar_week_mod( $num ) { * @global array $posts * * @param bool $initial Optional. Whether to use initial calendar names. Default true. - * @param bool $display Optional. Whether to display or return the calendar. Default true. + * @param bool $echo Optional. Whether to display the calendar output. Default true. * @return void|string Void if `$echo` argument is true, calendar HTML if `$echo` is false. */ function get_calendar( $initial = true, $echo = true ) { diff --git a/wp-includes/kses.php b/wp-includes/kses.php index 2c0e075ff4..1e7739df91 100644 --- a/wp-includes/kses.php +++ b/wp-includes/kses.php @@ -1034,6 +1034,7 @@ function wp_kses_uri_attributes() { * or a context name such as 'post'. * @global string[] $pass_allowed_protocols Array of allowed URL protocols. * + * @param array $matches preg_replace regexp matches * @return string */ function _wp_kses_split_callback( $match ) { @@ -1712,6 +1713,7 @@ function wp_kses_html_error( $string ) { * * @param string $string Content to check for bad protocols. * @param string[] $allowed_protocols Array of allowed URL protocols. + * @param int $count Depth of call recursion to this function. * @return string Sanitized content. */ function wp_kses_bad_protocol_once( $string, $allowed_protocols, $count = 1 ) { diff --git a/wp-includes/pomo/po.php b/wp-includes/pomo/po.php index f98ff01566..0b0c8cea7a 100644 --- a/wp-includes/pomo/po.php +++ b/wp-includes/pomo/po.php @@ -92,6 +92,8 @@ if ( ! class_exists( 'PO', false ) ) : * Text to include as a comment before the start of the PO contents * * Doesn't need to include # in the beginning of lines, these are added automatically + * + * @param string $text Text to include as a comment. */ function set_comment_before_headers( $text ) { $this->comments_before_headers = $text; diff --git a/wp-includes/post-template.php b/wp-includes/post-template.php index f4f2113c3d..d4af2fd43e 100644 --- a/wp-includes/post-template.php +++ b/wp-includes/post-template.php @@ -1544,6 +1544,7 @@ function walk_page_tree( $pages, $depth, $current_page, $r ) { * @uses Walker_PageDropdown to create HTML dropdown content. * @see Walker_PageDropdown::walk() for parameters and return description. * + * @param mixed ...$args Elements array, maximum hierarchical depth and optional additional arguments. * @return string */ function walk_page_dropdown_tree( ...$args ) { diff --git a/wp-includes/script-loader.php b/wp-includes/script-loader.php index 8cbe8d0b87..5725269a9c 100644 --- a/wp-includes/script-loader.php +++ b/wp-includes/script-loader.php @@ -39,7 +39,8 @@ require ABSPATH . WPINC . '/functions.wp-styles.php'; * * @since 5.0.0 * - * @param WP_Scripts $scripts WP_Scripts object. + * @param WP_Scripts $scripts WP_Scripts object. + * @param bool $force_uncompressed Whether to forcibly prevent gzip compression. Default false. */ function wp_register_tinymce_scripts( $scripts, $force_uncompressed = false ) { global $tinymce_version, $concatenate_scripts, $compress_scripts; diff --git a/wp-includes/theme.php b/wp-includes/theme.php index 1a66ae783e..6444692f43 100644 --- a/wp-includes/theme.php +++ b/wp-includes/theme.php @@ -2471,6 +2471,7 @@ function get_theme_starter_content() { * @since 5.3.0 The `html5` feature now also accepts 'script' and 'style'. * @since 5.3.0 Formalized the existing and already documented `...$args` parameter * by adding it to the function signature. + * @since 5.5.0 The `core-block-patterns` feature was added and is enabled by default. * * @global array $_wp_theme_features * diff --git a/wp-includes/version.php b/wp-includes/version.php index 8cf43c9d78..5d1c9879b8 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.5-beta3-48572'; +$wp_version = '5.5-beta3-48573'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.