From 8ec2910fd49a519238530860bdc30b4560e2276f Mon Sep 17 00:00:00 2001 From: njonesfermoy2011-rgb <288228952+njonesfermoy2011-rgb@users.noreply.github.com> Date: Thu, 10 Sep 2026 11:51:46 +0100 Subject: [PATCH] Docs: Use the `bool` and `int` short forms in docblocks. The PHP inline documentation standards state, in the `@param`, `@return` and `@global` sections: "For boolean and integer types, use `bool` and `int`, respectively." Six docblocks in core code still used the long forms. Bundled third-party libraries are left untouched. Parameter columns are realigned where the shorter type changes the width of the type column. Documentation only, no behaviour change. Co-Authored-By: Claude Opus 5 --- src/wp-includes/class-wp-theme-json.php | 12 ++++++------ src/wp-includes/global-styles-and-settings.php | 2 +- .../html-api/class-wp-html-tag-processor.php | 2 +- src/wp-includes/media.php | 2 +- .../class-wp-rest-global-styles-controller.php | 2 +- .../endpoints/class-wp-rest-templates-controller.php | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/wp-includes/class-wp-theme-json.php b/src/wp-includes/class-wp-theme-json.php index 1252ca6736fd6..e91d547eb58f1 100644 --- a/src/wp-includes/class-wp-theme-json.php +++ b/src/wp-includes/class-wp-theme-json.php @@ -3009,12 +3009,12 @@ protected static function flatten_tree( $tree, $prefix = '', $token = '--' ) { * @since 6.6.0 Pass current theme JSON settings to wp_get_typography_font_size_value(), and process background properties. * @since 6.7.0 `ref` resolution of background properties, and assigning custom default values. * - * @param array $styles Styles to process. - * @param array $settings Theme settings. - * @param array $properties Properties metadata. - * @param array $theme_json Theme JSON array. - * @param string $selector The style block selector. - * @param boolean $use_root_padding Whether to add custom properties at root level. + * @param array $styles Styles to process. + * @param array $settings Theme settings. + * @param array $properties Properties metadata. + * @param array $theme_json Theme JSON array. + * @param string $selector The style block selector. + * @param bool $use_root_padding Whether to add custom properties at root level. * @return array Returns the modified $declarations. */ protected static function compute_style_properties( $styles, $settings = array(), $properties = null, $theme_json = null, $selector = null, $use_root_padding = null ) { diff --git a/src/wp-includes/global-styles-and-settings.php b/src/wp-includes/global-styles-and-settings.php index 0534d8b0dee58..c4a3284dadb91 100644 --- a/src/wp-includes/global-styles-and-settings.php +++ b/src/wp-includes/global-styles-and-settings.php @@ -497,7 +497,7 @@ function wp_get_theme_data_template_parts() { * * @param WP_Block_Type $block_type The block's type. * @param string|array $target The desired selector's target, `root` or array path. - * @param boolean $fallback Whether to fall back to broader selector. + * @param bool $fallback Whether to fall back to broader selector. * @return string|null CSS selector or `null` if no selector available. */ function wp_get_block_css_selector( $block_type, $target = 'root', $fallback = false ) { diff --git a/src/wp-includes/html-api/class-wp-html-tag-processor.php b/src/wp-includes/html-api/class-wp-html-tag-processor.php index b59baaf5a81cb..cd5814f0a4ad3 100644 --- a/src/wp-includes/html-api/class-wp-html-tag-processor.php +++ b/src/wp-includes/html-api/class-wp-html-tag-processor.php @@ -2789,7 +2789,7 @@ private static function sort_start_ascending( WP_HTML_Text_Replacement $a, WP_HT * @ignore * * @param string $comparable_name The attribute name in its comparable form. - * @return string|boolean|null Value of enqueued update if present, otherwise false. + * @return string|bool|null Value of enqueued update if present, otherwise false. */ private function get_enqueued_attribute_value( string $comparable_name ) { if ( self::STATE_MATCHED_TAG !== $this->parser_state ) { diff --git a/src/wp-includes/media.php b/src/wp-includes/media.php index be0b2fbf098cc..1e0b86655e82a 100644 --- a/src/wp-includes/media.php +++ b/src/wp-includes/media.php @@ -2120,7 +2120,7 @@ function wp_img_tag_add_auto_sizes( string $image ): string { * * @since 6.7.1 * - * @param boolean $enabled Whether auto-sizes for lazy loaded images is enabled. + * @param bool $enabled Whether auto-sizes for lazy loaded images is enabled. */ if ( ! apply_filters( 'wp_img_tag_add_auto_sizes', true ) ) { return $image; diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php index ed8195cbb91b7..83466acad0948 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php @@ -386,7 +386,7 @@ public function prepare_item_for_response( $post, $request ) { * @since 5.9.0 * @since 6.3.0 Adds revisions count and rest URL href to version-history. * - * @param integer $id ID. + * @param int $id ID. * @return array Links for the given post. */ protected function prepare_links( $id ) { diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php index 0941ee4ea53e3..190eea6b203bb 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php @@ -967,7 +967,7 @@ private static function get_wp_templates_author_text_field( $template_object ) { * * @since 5.8.0 * - * @param integer $id ID. + * @param int $id ID. * @return array Links for the given post. */ protected function prepare_links( $id ) {