Changeset 65161

Timestamp:

11/01/2026 05:58:25 AM (less than one hour ago)

Author:

westonruter

Message:

Taxonomy: Fix tag cloud handling of float font sizes.

The smallest and largest arguments of wp_generate_tag_cloud() were documented as integers, but they are only used in arithmetic, and the Tag Cloud block always passes them as floats so that its font size settings can be fractional. They are now documented as int|float.

Accepting floats exposed a bug. The aria-label on each tag is meant to be omitted when all tags share one font size, which was checked by comparing the font spread against the integer 0. With equal float sizes the spread is 0.0, which is not identical to 0, so the aria-label was output anyway, including for any Tag Cloud block whose smallest and largest sizes matched. The spread is now checked for being greater than zero; a negative spread was already clamped to 1.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/15306.
Follow-up to r40816.

Props huzaifaalmesbah, westonruter.
See #65817.

Location:

trunk

Files:

• src/wp-includes/category-template.php (modified) (2 diffs)
• tests/phpunit/tests/term/wpGenerateTagCloud.php (modified) (1 diff)

trunk/src/wp-includes/category-template.php

@@ -820 +820 @@
  *     Optional. Array or string of arguments for generating a tag cloud.
  *
- *     @type int      $smallest                   Smallest font size used to display tags. Paired
- *                                                with the value of `$unit`, to determine CSS text
- *                                                size unit. Default 8 (pt).
- *     @type int      $largest                    Largest font size used to display tags. Paired
- *                                                with the value of `$unit`, to determine CSS text
- *                                                size unit. Default 22 (pt).
- *     @type string   $unit                       CSS text size unit to use with the `$smallest`
- *                                                and `$largest` values. Accepts any valid CSS text
- *                                                size unit. Default 'pt'.
- *     @type int      $number                     The number of tags to return. Accepts any
- *                                                positive integer or zero to return all.
- *                                                Default 0.
- *     @type string   $format                     Format to display the tag cloud in. Accepts 'flat'
- *                                                (tags separated with spaces), 'list' (tags displayed
- *                                                in an unordered list), or 'array' (returns an array).
- *                                                Default 'flat'.
- *     @type string   $separator                  HTML or text to separate the tags. Default "\n" (newline).
- *     @type string   $orderby                    Value to order tags by. Accepts 'name' or 'count'.
- *                                                Default 'name'. The {@see 'tag_cloud_sort'} filter
- *                                                can also affect how tags are sorted.
- *     @type string   $order                      How to order the tags. Accepts 'ASC' (ascending),
- *                                                'DESC' (descending), or 'RAND' (random). Default 'ASC'.
- *     @type int|bool $filter                     Whether to enable filtering of the final output
- *                                                via {@see 'wp_generate_tag_cloud'}. Default 1.
- *     @type array    $topic_count_text           Nooped plural text from _n_noop() to supply to
- *                                                tag counts. Default null.
- *     @type callable $topic_count_text_callback  Callback used to generate nooped plural text for
- *                                                tag counts based on the count. Default null.
- *     @type callable $topic_count_scale_callback Callback used to determine the tag count scaling
- *                                                value. Default default_topic_count_scale().
- *     @type bool|int $show_count                 Whether to display the tag counts. Default 0. Accepts
- *                                                0, 1, or their bool equivalents.
+ *     @type int|float $smallest                   Smallest font size used to display tags. Paired
+ *                                                 with the value of `$unit`, to determine CSS text
+ *                                                 size unit. Default 8 (pt).
+ *     @type int|float $largest                    Largest font size used to display tags. Paired
+ *                                                 with the value of `$unit`, to determine CSS text
+ *                                                 size unit. Default 22 (pt).
+ *     @type string    $unit                       CSS text size unit to use with the `$smallest`
+ *                                                 and `$largest` values. Accepts any valid CSS text
+ *                                                 size unit. Default 'pt'.
+ *     @type int       $number                     The number of tags to return. Accepts any
+ *                                                 positive integer or zero to return all.
+ *                                                 Default 0.
+ *     @type string    $format                     Format to display the tag cloud in. Accepts 'flat'
+ *                                                 (tags separated with spaces), 'list' (tags displayed
+ *                                                 in an unordered list), or 'array' (returns an array).
+ *                                                 Default 'flat'.
+ *     @type string    $separator                  HTML or text to separate the tags. Default "\n" (newline).
+ *     @type string    $orderby                    Value to order tags by. Accepts 'name' or 'count'.
+ *                                                 Default 'name'. The {@see 'tag_cloud_sort'} filter
+ *                                                 can also affect how tags are sorted.
+ *     @type string    $order                      How to order the tags. Accepts 'ASC' (ascending),
+ *                                                 'DESC' (descending), or 'RAND' (random). Default 'ASC'.
+ *     @type int|bool  $filter                     Whether to enable filtering of the final output
+ *                                                 via {@see 'wp_generate_tag_cloud'}. Default 1.
+ *     @type array     $topic_count_text           Nooped plural text from _n_noop() to supply to
+ *                                                 tag counts. Default null.
+ *     @type callable  $topic_count_text_callback  Callback used to generate nooped plural text for
+ *                                                 tag counts based on the count. Default null.
+ *     @type callable  $topic_count_scale_callback Callback used to determine the tag count scaling
+ *                                                 value. Default default_topic_count_scale().
+ *     @type bool|int  $show_count                 Whether to display the tag counts. Default 0. Accepts
+ *                                                 0, 1, or their bool equivalents.
  * }
  * @return string|string[] Tag cloud as a string or an array, depending on 'format' argument.
@@ -971 +971 @@
          *   Tag Cloud widget), regardless of the tags font size
          */
-        if ( $args['show_count'] || 0 !== $font_spread ) {
+        if ( $args['show_count'] || $font_spread > 0 ) {
                 $aria_label = true;
         }

trunk/tests/phpunit/tests/term/wpGenerateTagCloud.php

@@ -304 +304 @@
 
         /**
+         * Tests that the aria-label is only output when font sizes differ or counts are shown.
+         *
+         * @ticket 65817
+         *
+         * @covers ::wp_generate_tag_cloud
+         *
+         * @dataProvider data_aria_label_font_sizes
+         *
+         * @param int|float $smallest          Smallest font size.
+         * @param int|float $largest           Largest font size.
+         * @param int       $show_count        Whether to show tag counts.
+         * @param bool      $expect_aria_label Whether an aria-label is expected.
+         */
+        public function test_aria_label_font_sizes( $smallest, $largest, int $show_count, bool $expect_aria_label ) {
+                register_taxonomy( 'wptests_tax', 'post' );
+                $term_ids = self::factory()->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
+                $posts    = self::factory()->post->create_many( 2 );
+
+                wp_set_post_terms( $posts[0], $term_ids, 'wptests_tax' );
+                wp_set_post_terms( $posts[1], array( $term_ids[1] ), 'wptests_tax' );
+
+                $term_objects = $this->retrieve_terms(
+                        array(
+                                'include' => $term_ids,
+                        ),
+                        'wptests_tax'
+                );
+
+                $actual = wp_generate_tag_cloud(
+                        $term_objects,
+                        array(
+                                'format'     => 'array',
+                                'smallest'   => $smallest,
+                                'largest'    => $largest,
+                                'show_count' => $show_count,
+                        )
+                );
+
+                $this->assertCount( 2, $actual );
+
+                $expected_aria_labels = array(
+                        $term_objects[0]->name . ' (1 item)',
+                        $term_objects[1]->name . ' (2 items)',
+                );
+                foreach ( $actual as $i => $link ) {
+                        $processor = new WP_HTML_Tag_Processor( $link );
+                        $this->assertTrue( $processor->next_tag( 'A' ), 'Expected the tag cloud item to be a link.' );
+                        $this->assertSame(
+                                $expect_aria_label ? $expected_aria_labels[ $i ] : null,
+                                $processor->get_attribute( 'aria-label' ),
+                                'Expected the aria-label attribute to be ' . ( $expect_aria_label ? 'present' : 'absent' ) . '.'
+                        );
+                }
+        }
+
+        /**
+         * Data provider for {@see self::test_aria_label_font_sizes()}.
+         *
+         * @return array<non-falsy-string, array{ 0: int|float, 1: int|float, 2: int, 3: bool }>
+         */
+        public static function data_aria_label_font_sizes(): array {
+                return array(
+                        'equal int sizes'              => array( 12, 12, 0, false ),
+                        'equal float sizes'            => array( 1.2, 1.2, 0, false ),
+                        'equal integral float sizes'   => array( 12.0, 12.0, 0, false ),
+                        'different int sizes'          => array( 8, 22, 0, true ),
+                        'different float sizes'        => array( 0.8, 1.5, 0, true ),
+                        'equal float sizes with count' => array( 1.2, 1.2, 1, true ),
+                        'smallest larger than largest' => array( 22.5, 8.5, 0, true ),
+                );
+        }
+
+        /**
          * Helper method retrieve the created terms.
          *
          * @param array $get_terms_args Options passed to get_terms()
-         * @return array
+         * @return WP_Term[]
          */
         protected function retrieve_terms( $get_terms_args, $taxonomy = 'post_tag' ) {