Changeset 61589

Timestamp:

02/04/2026 09:05:25 AM (6 months ago)

Author:

SergeyBiryukov

Message:

Docs: Document some globals in WP_UnitTestCase_Base class methods.

Follow-up to [26005], [27183], [29251], [30276], [35136], [35258], [38678], [39626], [44633], [56212].

Props noruzzaman, mukesh27, SergeyBiryukov.
See #64224.

File:

• trunk/tests/phpunit/includes/abstract-testcase.php (modified) (12 diffs)

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -59 +59 @@
         /**
          * Runs the routine before setting up all tests.
+         *
+         * @global wpdb $wpdb WordPress database abstraction object.
          */
         public static function set_up_before_class() {
@@ -99 +101 @@
         /**
          * Runs the routine before each test is executed.
+         *
+         * @global WP_Rewrite $wp_rewrite WordPress rewrite rules object.
          */
         public function set_up() {
+                global $wp_rewrite;
+
                 set_time_limit( 0 );
 
@@ -112 +118 @@
                         $this->_backup_hooks();
                 }
-
-                global $wp_rewrite;
 
                 $this->clean_up_global_scope();
@@ -156 +160 @@
         /**
          * After a test method runs, resets any state in WordPress the test method might have changed.
+         *
+         * @global wpdb       $wpdb         WordPress database abstraction object.
+         * @global WP_Query   $wp_the_query WordPress Query object.
+         * @global WP_Query   $wp_query     WordPress Query object.
+         * @global WP         $wp           WordPress environment object.
          */
         public function tear_down() {
                 global $wpdb, $wp_the_query, $wp_query, $wp;
+
                 $wpdb->query( 'ROLLBACK' );
+
                 if ( is_multisite() ) {
                         while ( ms_is_switched() ) {
@@ -360 +371 @@
          * on a class variable so they can be restored on tear_down() using _restore_hooks().
          *
-         * @global array $wp_filter
-         * @global array $wp_actions
-         * @global array $wp_filters
-         * @global array $wp_current_filter
+         * @global array $wp_filter         Stores all of the filters and actions.
+         * @global array $wp_actions        Stores the number of times each action was triggered.
+         * @global array $wp_filters        Stores the number of times each filter was triggered.
+         * @global array $wp_current_filter Stores the list of current filters with the current one last.
          */
         protected function _backup_hooks() {
@@ -383 +394 @@
          * so that future tests aren't affected by hooks set during this last test.
          *
-         * @global array $wp_filter
-         * @global array $wp_actions
-         * @global array $wp_filters
-         * @global array $wp_current_filter
+         * @global array $wp_filter         Stores all of the filters and actions.
+         * @global array $wp_actions        Stores the number of times each action was triggered.
+         * @global array $wp_filters        Stores the number of times each filter was triggered.
+         * @global array $wp_current_filter Stores the list of current filters with the current one last.
          */
         protected function _restore_hooks() {
@@ -408 +419 @@
         /**
          * Flushes the WordPress object cache.
+         *
+         * @global WP_Object_Cache $wp_object_cache WordPress Object Cache object.
          */
         public static function flush_cache() {
@@ -453 +466 @@
          * @since 5.1.0
          *
-         * @global array $wp_meta_keys
+         * @global array $wp_meta_keys Global registry for meta keys.
          */
         public function unregister_all_meta_keys() {
                 global $wp_meta_keys;
+
                 if ( ! is_array( $wp_meta_keys ) ) {
                         return;
                 }
+
                 foreach ( $wp_meta_keys as $object_type => $type_keys ) {
                         foreach ( $type_keys as $object_subtype => $subtype_keys ) {
@@ -471 +486 @@
         /**
          * Starts a database transaction.
+         *
+         * @global wpdb $wpdb WordPress database abstraction object.
          */
         public function start_transaction() {
                 global $wpdb;
+
                 $wpdb->query( 'SET autocommit = 0;' );
                 $wpdb->query( 'START TRANSACTION;' );
+
                 add_filter( 'query', array( $this, '_create_temporary_tables' ) );
                 add_filter( 'query', array( $this, '_drop_temporary_tables' ) );
@@ -484 +503 @@
          *
          * @since 4.1.0
+         *
+         * @global wpdb $wpdb WordPress database abstraction object.
          */
         public static function commit_transaction() {
                 global $wpdb;
+
                 $wpdb->query( 'COMMIT;' );
         }
@@ -1133 +1155 @@
          * @since 5.3.0 Formalized the existing `...$prop` parameter by adding it
          *              to the function signature.
+         *
+         * @global WP_Query $wp_query WordPress Query object.
          *
          * @param string ...$prop Any number of WP_Query properties that are expected to be true for the current request.
@@ -1633 +1657 @@
          * @since 4.4.0
          *
-         * @global WP_Rewrite $wp_rewrite
+         * @global WP_Rewrite $wp_rewrite WordPress rewrite rules object.
          *
          * @param string $structure Optional. Permalink structure to set. Default empty.