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.

git-svn-id: https://develop.svn.wordpress.org/trunk@61589 602fd350-edb4-49c9-b593-d223f7449a82

Author: SergeyBiryukov

tests/phpunit/includes/abstract-testcase.php

@@ -58,6 +58,8 @@ public static function get_called_class() {
 
 	/**
 	 * Runs the routine before setting up all tests.
+	 *
+	 * @global wpdb $wpdb WordPress database abstraction object.
 	 */
 	public static function set_up_before_class() {
 		global $wpdb;
@@ -98,8 +100,12 @@ public static function tear_down_after_class() {
 
 	/**
 	 * 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 );
 
 		$this->factory = static::factory();
@@ -112,8 +118,6 @@ public function set_up() {
 			$this->_backup_hooks();
 		}
 
-		global $wp_rewrite;
-
 		$this->clean_up_global_scope();
 
 		/*
@@ -155,10 +159,17 @@ public function wp_hash_password_options( array $options, string $algorithm ): a
 
 	/**
 	 * 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() ) {
 				restore_current_blog();
@@ -359,10 +370,10 @@ protected function reset__SERVER() {
 	 * Stores $wp_filter, $wp_actions, $wp_filters, and $wp_current_filter
 	 * 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() {
 		self::$hooks_saved['wp_filter'] = array();
@@ -382,10 +393,10 @@ protected function _backup_hooks() {
 	 * Restores the hook-related globals to their state at set_up()
 	 * 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() {
 		if ( isset( self::$hooks_saved['wp_filter'] ) ) {
@@ -407,6 +418,8 @@ protected function _restore_hooks() {
 
 	/**
 	 * Flushes the WordPress object cache.
+	 *
+	 * @global WP_Object_Cache $wp_object_cache WordPress Object Cache object.
 	 */
 	public static function flush_cache() {
 		global $wp_object_cache;
@@ -452,13 +465,15 @@ public static function flush_cache() {
 	 *
 	 * @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 ) {
 				foreach ( $subtype_keys as $key => $value ) {
@@ -470,11 +485,15 @@ public function unregister_all_meta_keys() {
 
 	/**
 	 * 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' ) );
 	}
@@ -483,9 +502,12 @@ public function start_transaction() {
 	 * Commits the queries in a transaction.
 	 *
 	 * @since 4.1.0
+	 *
+	 * @global wpdb $wpdb WordPress database abstraction object.
 	 */
 	public static function commit_transaction() {
 		global $wpdb;
+
 		$wpdb->query( 'COMMIT;' );
 	}
 
@@ -1133,6 +1155,8 @@ public function normalizeDirectorySeparatorsInPath( $path ) {
 	 * @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.
 	 */
 	public function assertQueryTrue( ...$prop ) {
@@ -1632,7 +1656,7 @@ public static function delete_user( $user_id ) {
 	 *
 	 * @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.
 	 */