Make WordPress Core


Ignore:
Timestamp:
08/25/2022 03:34:24 PM (3 years ago)
Author:
SergeyBiryukov
Message:

Code Modernization: Explicitly declare all properties in various tests.

Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.

In each of the cases included in this commit, one or more individual tests set a property to allow a filter or action access to certain information.

This commit:

  • Explicitly declares these properties and documents in which tests they are being used.
  • Adds a reset to the default value of the property to a pre-existing tear_down() method or adds that method specifically for that purpose. This ensures that tests do not accidentally “taint” each other.

As these properties are being declared on test classes, they are marked as private. Even though the original dynamic property was public, this should not be considered a backward compatibility break as this only involves test classes.

Includes:

  • In the Tests_Post_Query class, there were two tests assigning a value to an undeclared $post_id property, but subsequently not using the property, so those assignments should have been to a local variable (if they should be assignments at all).
  • In the Test_User_Capabilities class, the property name had a leading _ underscore. This is an outdated PHP 4 practice to indicate a private property. As PHP 4 is no longer supported, the leading underscore is removed from the property name.
  • In the Tests_User_Capabilities class, an unused $_role_test_wp_roles_role property was declared somewhere in the middle of the class. That property is now removed in favor of $_role_test_wp_roles_init, which appears to be the intended name, previously misspelled.

Follow-up to [27294], [36277], [36750], [37712], [38571], [39082], [40290], [43049], [44628], [48328], [53557], [53558], [53850], [53851], [53852], [53853], [53854], [53856], [53916], [53935], [53936], [53937], [53938].

Props jrf.
See #56033.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/tests/comment/query.php

    r53863 r53942  
    1010    protected $comment_id;
    1111
     12    /**
     13     * Temporary storage for comment exclusions to allow a filter to access these.
     14     *
     15     * Used in the following tests:
     16     * - `test_comment_clauses_prepend_callback_should_be_respected_when_filling_descendants()`
     17     * - `test_comment_clauses_append_callback_should_be_respected_when_filling_descendants()`
     18     *
     19     * @var array
     20     */
     21    private $to_exclude;
     22
    1223    public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
    1324        self::$post_id = $factory->post->create();
     25    }
     26
     27    public function tear_down() {
     28        unset( $this->to_exclude );
     29        parent::tear_down();
    1430    }
    1531
     
    43024318        remove_filter( 'comments_clauses', array( $this, 'prepend_exclusions' ) );
    43034319
    4304         unset( $this->to_exclude );
    4305 
    43064320        $this->assertEqualSets( array( $top_level_0, $child1_of_0, $top_level_comments[0], $top_level_comments[2] ), wp_list_pluck( $q->comments, 'comment_ID' ) );
    43074321    }
     
    43604374        );
    43614375        remove_filter( 'comments_clauses', array( $this, 'append_exclusions' ) );
    4362 
    4363         unset( $this->to_exclude );
    43644376
    43654377        $this->assertEqualSets( array( $top_level_0, $child1_of_0, $top_level_comments[0], $top_level_comments[2] ), wp_list_pluck( $q->comments, 'comment_ID' ) );
Note: See TracChangeset for help on using the changeset viewer.