From 5b10c67ef5b5703716571fe99ae6d8c4865971fb Mon Sep 17 00:00:00 2001 From: Mukesh Panchal Date: Sat, 29 Aug 2026 16:29:26 +0530 Subject: [PATCH] Docs: Align `@param` tag columns in upgrade, plugin, and theme docblocks. Co-Authored-By: Claude Opus 5 (1M context) Claude-Session: https://claude.ai/code/session_018AyprpqvcyKGrDdYmcnQnD --- src/wp-admin/includes/class-wp-automatic-updater.php | 10 +++++----- .../includes/class-wp-site-health-auto-updates.php | 6 +++--- src/wp-admin/includes/plugin-install.php | 6 +++--- src/wp-admin/includes/plugin.php | 2 +- src/wp-admin/includes/theme.php | 2 +- src/wp-admin/includes/upgrade.php | 12 ++++++------ src/wp-content/themes/twentyfourteen/functions.php | 2 +- src/wp-content/themes/twentytwelve/functions.php | 2 +- src/wp-includes/class-wp-theme.php | 2 +- src/wp-includes/theme.php | 2 +- 10 files changed, 23 insertions(+), 23 deletions(-) diff --git a/src/wp-admin/includes/class-wp-automatic-updater.php b/src/wp-admin/includes/class-wp-automatic-updater.php index cd9426c6ef88b..aa4db87effc2a 100644 --- a/src/wp-admin/includes/class-wp-automatic-updater.php +++ b/src/wp-admin/includes/class-wp-automatic-updater.php @@ -170,10 +170,10 @@ public function is_vcs_checkout( $context ) { * * @since 3.7.0 * - * @param bool $checkout Whether a VCS checkout was discovered at `$context` - * or ABSPATH, or anywhere higher. - * @param string $context The filesystem context (a path) against which - * filesystem status should be checked. + * @param bool $checkout Whether a VCS checkout was discovered at `$context` + * or ABSPATH, or anywhere higher. + * @param string $context The filesystem context (a path) against which + * filesystem status should be checked. */ return apply_filters( 'automatic_updates_is_vcs_checkout', $checkout, $context ); } @@ -1130,7 +1130,7 @@ protected function send_email( $type, $core_update, $result = null ) { * * @since 3.7.0 * - * @param array $email { + * @param array $email { * Array of email arguments that will be passed to wp_mail(). * * @type string $to The email recipient. An array of emails diff --git a/src/wp-admin/includes/class-wp-site-health-auto-updates.php b/src/wp-admin/includes/class-wp-site-health-auto-updates.php index 1904acd4e08c5..3c0c8b3844b22 100644 --- a/src/wp-admin/includes/class-wp-site-health-auto-updates.php +++ b/src/wp-admin/includes/class-wp-site-health-auto-updates.php @@ -63,9 +63,9 @@ static function ( $test ) { * @since 5.2.0 * @since 5.5.1 The `$value` parameter can accept an array. * - * @param string $constant The name of the constant to check. - * @param bool|string|array $value The value that the constant should be, if set, - * or an array of acceptable values. + * @param string $constant The name of the constant to check. + * @param bool|string|array $value The value that the constant should be, if set, + * or an array of acceptable values. * @return array|null The test results if there are any constants set incorrectly, * or null if the test passed. */ diff --git a/src/wp-admin/includes/plugin-install.php b/src/wp-admin/includes/plugin-install.php index dc232f1df7018..62e93a36eef5d 100644 --- a/src/wp-admin/includes/plugin-install.php +++ b/src/wp-admin/includes/plugin-install.php @@ -895,15 +895,15 @@ function install_plugin_information() { * @since 6.5.0 * * @param string $name Plugin name. - * @param array|object $data { + * @param array|object $data { * An array or object of plugin data. Can be retrieved from the API. * * @type string $slug The plugin slug. * @type string[] $requires_plugins An array of plugin dependency slugs. * @type string $version The plugin's version string. Used when getting the install status. * } - * @param bool $compatible_php The result of a PHP compatibility check. - * @param bool $compatible_wp The result of a WP compatibility check. + * @param bool $compatible_php The result of a PHP compatibility check. + * @param bool $compatible_wp The result of a WP compatibility check. * @return string The markup for the dependency row button. An empty string if the user does not have capabilities. */ function wp_get_plugin_action_button( $name, $data, $compatible_php, $compatible_wp ) { diff --git a/src/wp-admin/includes/plugin.php b/src/wp-admin/includes/plugin.php index 94d4a585a80f1..9969316ab8d58 100644 --- a/src/wp-admin/includes/plugin.php +++ b/src/wp-admin/includes/plugin.php @@ -1264,7 +1264,7 @@ function validate_plugin_requirements( $plugin ) { * @since 6.9.0 * * @param bool|WP_Error $met_requirements True if the plugin meets requirements, WP_Error if not. - * @param string $plugin Path to the plugin file relative to the plugins directory. + * @param string $plugin Path to the plugin file relative to the plugins directory. */ return apply_filters( 'validate_plugin_requirements', true, $plugin ); } diff --git a/src/wp-admin/includes/theme.php b/src/wp-admin/includes/theme.php index ef5793b7dd118..5ee488536ede2 100644 --- a/src/wp-admin/includes/theme.php +++ b/src/wp-admin/includes/theme.php @@ -157,7 +157,7 @@ function get_page_templates( $post = null, $post_type = 'page' ) { * @since 2.9.0 * @access private * - * @param string $fullpath Full path to the theme file + * @param string $fullpath Full path to the theme file * @param string $containingfolder Path of the theme parent folder * @return string */ diff --git a/src/wp-admin/includes/upgrade.php b/src/wp-admin/includes/upgrade.php index 37e15696d446a..244401cf24013 100644 --- a/src/wp-admin/includes/upgrade.php +++ b/src/wp-admin/includes/upgrade.php @@ -621,7 +621,7 @@ function wp_new_blog_notification( * * @since 5.6.0 * - * @param array $installed_email { + * @param array $installed_email { * Used to build wp_mail(). * * @type string $to The email address of the recipient. @@ -629,11 +629,11 @@ function wp_new_blog_notification( * @type string $message The content of the email. * @type string $headers Headers. * } - * @param WP_User $user The site administrator user object. - * @param string $blog_title The site title. - * @param string $blog_url The site URL. - * @param string $password The site administrator's password. Note that a placeholder message - * is usually passed instead of the user's actual password. + * @param WP_User $user The site administrator user object. + * @param string $blog_title The site title. + * @param string $blog_url The site URL. + * @param string $password The site administrator's password. Note that a placeholder message + * is usually passed instead of the user's actual password. */ $installed_email = apply_filters( 'wp_installed_email', $installed_email, $user, $blog_title, $blog_url, $password ); diff --git a/src/wp-content/themes/twentyfourteen/functions.php b/src/wp-content/themes/twentyfourteen/functions.php index 77e5935f11245..6771117ab3251 100644 --- a/src/wp-content/themes/twentyfourteen/functions.php +++ b/src/wp-content/themes/twentyfourteen/functions.php @@ -680,7 +680,7 @@ function twentyfourteen_post_classes( $classes ) { * @global int $page Page number of a single post. * * @param string $title Default title text for current view. - * @param string $sep Optional separator. + * @param string $sep Optional separator. * @return string The filtered title. */ function twentyfourteen_wp_title( $title, $sep ) { diff --git a/src/wp-content/themes/twentytwelve/functions.php b/src/wp-content/themes/twentytwelve/functions.php index 877da5a297efb..a6c3300bb45b2 100644 --- a/src/wp-content/themes/twentytwelve/functions.php +++ b/src/wp-content/themes/twentytwelve/functions.php @@ -309,7 +309,7 @@ function twentytwelve_mce_css( $mce_css ) { * @global int $page Page number of a single post. * * @param string $title Default title text for current view. - * @param string $sep Optional separator. + * @param string $sep Optional separator. * @return string Filtered title. */ function twentytwelve_wp_title( $title, $sep ) { diff --git a/src/wp-includes/class-wp-theme.php b/src/wp-includes/class-wp-theme.php index 6a18e7a534daa..a26c7bbd94523 100644 --- a/src/wp-includes/class-wp-theme.php +++ b/src/wp-includes/class-wp-theme.php @@ -246,7 +246,7 @@ final class WP_Theme implements ArrayAccess { * * @param string $theme_dir Directory of the theme within the theme_root. * @param string $theme_root Theme root. - * @param WP_Theme|null $_child If this theme is a parent theme, the child may be passed for validation purposes. + * @param WP_Theme|null $_child If this theme is a parent theme, the child may be passed for validation purposes. */ public function __construct( $theme_dir, $theme_root, $_child = null ) { global $wp_theme_directories; diff --git a/src/wp-includes/theme.php b/src/wp-includes/theme.php index 3262ebde134f2..9c18c71792ee8 100644 --- a/src/wp-includes/theme.php +++ b/src/wp-includes/theme.php @@ -1010,7 +1010,7 @@ function validate_theme_requirements( $stylesheet ) { * @since 6.9.0 * * @param bool|WP_Error $met_requirements True if the theme meets requirements, WP_Error if not. - * @param string $stylesheet Directory name for the theme. + * @param string $stylesheet Directory name for the theme. */ return apply_filters( 'validate_theme_requirements', true, $stylesheet ); }