Changeset 62957

Timestamp:

07/31/2026 02:15:27 PM (8 weeks ago)

Author:

wildworks

Message:

Tests: Correct @param tags in various test methods.

Some @param tags did not match their method signatures. This corrects the names and types, and removes the tags for parameters that no longer exist.

Two @dataProvider annotations also had no effect. The one on test_prepare_item() is removed, and test_get_items_search_type_post_subtype_invalid() now accepts $method and passes it to the request.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/12208

Props Soean, mukesh27, wildworks.
See #64894.

Location:

trunk/tests/phpunit/tests

Files:

• admin/includesFile.php (modified) (1 diff)
• dependencies/scripts.php (modified) (1 diff)
• filesystem/wpFilesystemDirect/delete.php (modified) (1 diff)
• filesystem/wpFilesystemDirect/isDir.php (modified) (1 diff)
• functions/allowedProtocols.php (modified) (1 diff)
• functions/doEnclose.php (modified) (1 diff)
• image/meta.php (modified) (1 diff)
• multisite/updateBlogDetails.php (modified) (1 diff)
• post.php (modified) (1 diff)
• privacy/wpPrivacyProcessPersonalDataExportPage.php (modified) (4 diffs)
• rest-api/rest-block-type-controller.php (modified) (1 diff)
• rest-api/rest-comments-controller.php (modified) (1 diff)
• rest-api/rest-search-controller.php (modified) (2 diffs)
• rest-api/wpRestBlockPatternCategoriesController.php (modified) (1 diff)
• rewrite.php (modified) (1 diff)

trunk/tests/phpunit/tests/admin/includesFile.php

@@ -400 +400 @@
          * @ticket 54738
          *
-         * @param string $filter A callback containing a fake Content-Type header.
-         * @param string $ext The expected file extension to match.
+         * @param callable $filter    A callback containing a fake Content-Type header.
+         * @param string   $extension The expected file extension to match.
          */
         public function test_download_url_should_use_the_content_type_header_to_set_extension_of_a_file_if_extension_was_not_determined( $filter, $extension ) {

trunk/tests/phpunit/tests/dependencies/scripts.php

@@ -558 +558 @@
          * @dataProvider get_data_to_filter_eligible_strategies
          *
-         * @param callable $set_up     Set up.
-         * @param bool     $async_only Async only.
-         * @param bool     $expected   Expected return value.
+         * @param callable $set_up   Set up.
+         * @param string[] $expected Expected return value.
          */
         public function test_filter_eligible_strategies( $set_up, $expected ) {

trunk/tests/phpunit/tests/filesystem/wpFilesystemDirect/delete.php

@@ -70 +70 @@
          * @dataProvider data_should_delete_a_file
          *
-         * @param string $key The key for the file in `self::$filesystem_structure`.
+         * @param string $file The key for the file in `self::$file_structure`.
          */
         public function test_should_delete_a_file( $file ) {

trunk/tests/phpunit/tests/filesystem/wpFilesystemDirect/isDir.php

@@ -36 +36 @@
          *
          * @param string $path The path to check.
-         * @param string $type The type of resource. Accepts 'f' or 'd'.
-         *                     Used to invert $expected due to data provider setup.
          */
         public function test_should_determine_that_a_path_is_not_a_directory( $path ) {

trunk/tests/phpunit/tests/functions/allowedProtocols.php

@@ -28 +28 @@
          * @dataProvider data_example_urls
          *
-         * @param string The scheme.
-         * @param string Example URL.
+         * @param string $protocol The scheme.
+         * @param string $url      Example URL.
          */
         public function test_allowed_protocols( $protocol, $url ) {

trunk/tests/phpunit/tests/functions/doEnclose.php

@@ -222 +222 @@
          * @since 5.3.0
          *
-         * @param  array $post_links An array of enclosure links.
-         * @param  int   $post_id    Post ID.
+         * @param  array $enclosure_links An array of enclosure links.
+         * @param  int   $post_id         Post ID.
          * @return array An array of enclosure links.
          */

trunk/tests/phpunit/tests/image/meta.php

@@ -185 +185 @@
          * @ticket 52922
          *
-         * @param string Stream's URI.
-         * @param array  Expected metadata.
+         * @param string $file     Stream's URI.
+         * @param array  $expected Expected metadata.
          */
         public function test_stream( $file, $expected ) {

trunk/tests/phpunit/tests/multisite/updateBlogDetails.php

@@ -54 +54 @@
          * @param string $flag       The name of the flag being set or unset on a site.
          * @param string $flag_value '0' or '1'. The value of the flag being set.
-         * @param string $action     The hook expected to fire for the flag name and flag combination.
+         * @param string $hook       The hook expected to fire for the flag name and flag combination.
          *
          * @dataProvider data_flag_hooks

trunk/tests/phpunit/tests/post.php

@@ -669 +669 @@
          * @ticket 52007
          * @covers ::stick_post
-         *
-         * @param mixed $stick Value to pass to stick_post().
          */
         public function test_stick_post_removes_duplicate_post_ids_when_adding_new_value() {

trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php

@@ -359 +359 @@
          * @dataProvider data_send_as_email_options
          *
-         * @param bool Whether the final results of the export should be emailed to the user.
+         * @param bool $send_as_email Whether the final results of the export should be emailed to the user.
          */
         public function test_send_error_when_invalid_request_id( $send_as_email ) {
@@ -389 +389 @@
          * @dataProvider data_send_as_email_options
          *
-         * @param bool Whether the final results of the export should be emailed to the user.
+         * @param bool $send_as_email Whether the final results of the export should be emailed to the user.
          */
         public function test_send_error_when_invalid_request_action_name( $send_as_email ) {
@@ -421 +421 @@
          * @dataProvider data_send_as_email_options
          *
-         * @param bool Whether the final results of the export should be emailed to the user.
-         *
+         * @param bool $send_as_email Whether the final results of the export should be emailed to the user.
          */
         public function test_raw_data_post_meta( $send_as_email ) {
@@ -462 +461 @@
          * @dataProvider data_send_as_email_options
          *
-         * @param bool Whether the final results of the export should be emailed to the user.
+         * @param bool $send_as_email Whether the final results of the export should be emailed to the user.
          */
         public function test_add_post_meta_with_groups_data_only_available_when_export_file_generated( $send_as_email ) {

trunk/tests/phpunit/tests/rest-api/rest-block-type-controller.php

@@ -751 +751 @@
 
         /**
-         * @dataProvider data_readable_http_methods
          * @ticket 47620
          * @ticket 56481
-         *
-         * @param string $method HTTP method to use.
          */
         public function test_prepare_item() {

trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php

@@ -3647 +3647 @@
          * Create a test post with note.
          *
-         * @param int $user_id Post author's user ID.
+         * @param string $role User role to assign the post author.
          * @return int Post ID.
          */

trunk/tests/phpunit/tests/rest-api/rest-search-controller.php

@@ -361 +361 @@
          * @param string $method HTTP method to use.
          */
-        public function test_get_items_search_type_post_subtype_invalid() {
+        public function test_get_items_search_type_post_subtype_invalid( $method ) {
                 $response = $this->do_request_with_params(
                         array(
@@ -367 +367 @@
                                 'type'     => 'post',
                                 'subtype'  => 'invalid',
-                        )
+                        ),
+                        $method
                 );
 

trunk/tests/phpunit/tests/rest-api/wpRestBlockPatternCategoriesController.php

@@ -142 +142 @@
         /**
          * @ticket 56481
-         *
-         * @param string $path The path to test.
          */
         public function test_head_request_with_specified_fields_returns_success_response() {

trunk/tests/phpunit/tests/rewrite.php

@@ -168 +168 @@
          * @param string      $path        Path relative to the home URL. Blank string if no path is specified.
          * @param string|null $orig_scheme Scheme to give the home URL context.
-         * @param int|null    $blog_id     Site ID, or null for the current site.
+         * @param int|null    $_blog_id    Site ID, or null for the current site.
          * @return string                  The complete home URL including scheme and path.
          */