Changeset 62797 for trunk/tests/phpunit/tests/functions/wpParseList.php

Timestamp:

07/19/2026 04:53:46 PM (7 weeks ago)

Author:

westonruter

Message:

Code Quality: Improve typing for wp_parse_list() et al.

This adds precise @param and @return typing for the wp_parse_list(), wp_parse_id_list(), and wp_parse_slug_list() functions; native array return types are also added. It also adds casting and type guarding to guarantee the types of the values involved. Descriptions are updated to indicate that lists may not be returned, which may be unexpected given the function names; instead, sparse arrays or even associative arrays may be returned. Additionally, typically invalid ID values like zero may be in the array returned by wp_parse_id_list() and an empty string may be in the array returned by wp_parse_slug_list().

Tests are added to ensure existing behavior is preserved. This fixes 6 PHPStan errors at rule level 10.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12588.
Follow-up to r38832, r44546, r57737, r62647, r62771.

See #64898.

File:

• trunk/tests/phpunit/tests/functions/wpParseList.php (modified) (2 diffs)

trunk/tests/phpunit/tests/functions/wpParseList.php

@@ -14 +14 @@
          *
          * @dataProvider data_wp_parse_list
+         *
+         * @param mixed[]|string $input_list
+         * @param array<scalar> $expected
          */
-        public function test_wp_parse_list( $input_list, $expected ) {
-                $this->assertSameSets( $expected, wp_parse_list( $input_list ) );
+        public function test_wp_parse_list( $input_list, array $expected ): void {
+                $parsed_list = wp_parse_list( $input_list );
+                $this->assertThat(
+                        $parsed_list,
+                        $this->callback(
+                                static fn ( array $arr ) => array_all(
+                                        $arr,
+                                        static fn ( $v ) => is_scalar( $v )
+                                )
+                        ),
+                        'Array should contain only scalars.'
+                );
+                $this->assertSame( $expected, $parsed_list );
         }
 
@@ -22 +36 @@
          * Data provider.
          *
-         * @return array[]
+         * @return array<string, array{ input_list: mixed[]|string, expected: array<scalar> }>
          */
-        public function data_wp_parse_list() {
+        public function data_wp_parse_list(): array {
                 return array(
-                        'ids only'           => array(
+                        'ids only'            => array(
                                 'input_list' => '1,2,3,4',
                                 'expected'   => array( '1', '2', '3', '4' ),
                         ),
-                        'slugs only'         => array(
+                        'slugs only'          => array(
                                 'input_list' => 'apple,banana,carrot,dog',
                                 'expected'   => array( 'apple', 'banana', 'carrot', 'dog' ),
                         ),
-                        'ids and slugs'      => array(
+                        'ids and slugs'       => array(
                                 'input_list' => '1,2,apple,banana',
                                 'expected'   => array( '1', '2', 'apple', 'banana' ),
                         ),
-                        'space after comma'  => array(
+                        'space after comma'   => array(
                                 'input_list' => '1, 2,apple,banana',
                                 'expected'   => array( '1', '2', 'apple', 'banana' ),
                         ),
-                        'double comma'       => array(
+                        'double comma'        => array(
                                 'input_list' => '1,2,apple,,banana',
                                 'expected'   => array( '1', '2', 'apple', 'banana' ),
                         ),
-                        'leading comma'      => array(
+                        'leading comma'       => array(
                                 'input_list' => ',1,2,apple,banana',
                                 'expected'   => array( '1', '2', 'apple', 'banana' ),
                         ),
-                        'trailing comma'     => array(
+                        'trailing comma'      => array(
                                 'input_list' => '1,2,apple,banana,',
                                 'expected'   => array( '1', '2', 'apple', 'banana' ),
                         ),
-                        'space before comma' => array(
+                        'space before comma'  => array(
                                 'input_list' => '1,2 ,apple,banana',
                                 'expected'   => array( '1', '2', 'apple', 'banana' ),
                         ),
-                        'empty string'       => array(
+                        'empty string'        => array(
                                 'input_list' => '',
                                 'expected'   => array(),
                         ),
-                        'comma only'         => array(
+                        'comma only'          => array(
                                 'input_list' => ',',
                                 'expected'   => array(),
                         ),
-                        'double comma only'  => array(
+                        'double comma only'   => array(
                                 'input_list' => ',,',
                                 'expected'   => array(),
+                        ),
+                        'passed scalar array' => array(
+                                'input_list' => array( 'foo', true, false, 1, 3.14 ),
+                                'expected'   => array( 'foo', true, false, 1, 3.14 ),
+                        ),
+                        'passed mixed array'  => array(
+                                'input_list' => array( null, 'foo', array(), true, new stdClass(), false, 1, 3.14 ),
+                                'expected'   => array(
+                                        1 => 'foo',
+                                        3 => true,
+                                        5 => false,
+                                        6 => 1,
+                                        7 => 3.14,
+                                ),
+                        ),
+                        'passed assoc array'  => array(
+                                'input_list' => array(
+                                        'foo' => 1,
+                                        'bar' => true,
+                                        'baz' => 3.14,
+                                ),
+                                'expected'   => array(
+                                        'foo' => 1,
+                                        'bar' => true,
+                                        'baz' => 3.14,
+                                ),
                         ),
                 );