Changeset 56356

Timestamp:

08/03/2023 07:50:20 PM (17 months ago)

Author:

hellofromTonya

Message:

Code Modernization: Use "declare" in WP_List_Table magic methods deprecation message

Changes "define" to "declare" in the deprecation message in WP_List_Table magic methods.

Why is "declare" better?
It aligns well to:

• the topic of and published information about dynamic properties.
• the act of explicitly listing the variable as a property on the class.

The goal of this message is guide developers to change their code. Changing the term to "declare" hopefully will aid in the understanding of what is being asked of developers when this deprecation is thrown.

Follow-up [56349].

Props hellofromTonya, antonvlasenko.
Fixes #58896.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-list-table.php (modified) (4 diffs)
• tests/phpunit/tests/admin/wpListTable.php (modified) (6 diffs)

trunk/src/wp-admin/includes/class-wp-list-table.php

@@ -188 +188 @@
 
         trigger_error(
-            "The property `{$name}` is not defined. Getting a dynamic (undefined) property is " .
-            'deprecated since version 6.4.0! Instead, define the property on the class.',
+            "The property `{$name}` is not declared. Getting a dynamic property is " .
+            'deprecated since version 6.4.0! Instead, declare the property on the class.',
             E_USER_DEPRECATED
         );
@@ -211 +211 @@
 
         trigger_error(
-            "The property `{$name}` is not defined. Setting a dynamic (undefined) property is " .
-            'deprecated since version 6.4.0! Instead, define the property on the class.',
+            "The property `{$name}` is not declared. Setting a dynamic property is " .
+            'deprecated since version 6.4.0! Instead, declare the property on the class.',
             E_USER_DEPRECATED
         );
@@ -232 +232 @@
 
         trigger_error(
-            "The property `{$name}` is not defined. Checking `isset()` on a dynamic (undefined) property " .
-            'is deprecated since version 6.4.0! Instead, define the property on the class.',
+            "The property `{$name}` is not declared. Checking `isset()` on a dynamic property " .
+            'is deprecated since version 6.4.0! Instead, declare the property on the class.',
             E_USER_DEPRECATED
         );
@@ -254 +254 @@
 
         trigger_error(
-            "A property `{$name}` is not defined. Unsetting a dynamic (undefined) property is " .
-            'deprecated since version 6.4.0! Instead, define the property on the class.',
+            "A property `{$name}` is not declared. Unsetting a dynamic property is " .
+            'deprecated since version 6.4.0! Instead, declare the property on the class.',
             E_USER_DEPRECATED
         );

trunk/tests/phpunit/tests/admin/wpListTable.php

@@ -372 +372 @@
      * @param mixed $expected       Expected value.
      */
-    public function test_should_get_compat_fields_defined_property( $property_name, $expected ) {
+    public function test_should_get_compat_fields( $property_name, $expected ) {
         $list_table = new WP_List_Table( array( 'plural' => '_wp_tests__get' ) );
 
@@ -390 +390 @@
         $this->expectDeprecation();
         $this->expectDeprecationMessage(
-            'The property `undefined_property` is not defined. Getting a dynamic (undefined) property is ' .
-            'deprecated since version 6.4.0! Instead, define the property on the class.'
-        );
-        $this->assertNull( $this->list_table->undefined_property, 'Getting a dynamic property should return null from WP_List_Table::__get()' );
+            'The property `undeclared_property` is not declared. Getting a dynamic property is ' .
+            'deprecated since version 6.4.0! Instead, declare the property on the class.'
+        );
+        $this->assertNull( $this->list_table->undeclared_property, 'Getting a dynamic property should return null from WP_List_Table::__get()' );
     }
 
@@ -419 +419 @@
         $this->expectDeprecation();
         $this->expectDeprecationMessage(
-            'The property `undefined_property` is not defined. Setting a dynamic (undefined) property is ' .
-            'deprecated since version 6.4.0! Instead, define the property on the class.'
-        );
-        $this->list_table->undefined_property = 'some value';
+            'The property `undeclared_property` is not declared. Setting a dynamic property is ' .
+            'deprecated since version 6.4.0! Instead, declare the property on the class.'
+        );
+        $this->list_table->undeclared_property = 'some value';
     }
 
@@ -434 +434 @@
      * @param mixed $expected       Expected value.
      */
-    public function test_should_isset_compat_fields_defined_property( $property_name, $expected ) {
+    public function test_should_isset_compat_fields( $property_name, $expected ) {
         $actual = isset( $this->list_table->$property_name );
         if ( is_null( $expected ) ) {
@@ -451 +451 @@
         $this->expectDeprecation();
         $this->expectDeprecationMessage(
-            'The property `undefined_property` is not defined. Checking `isset()` on a dynamic (undefined) property ' .
-            'is deprecated since version 6.4.0! Instead, define the property on the class.'
-        );
-        $this->assertFalse( isset( $this->list_table->undefined_property ), 'Checking a dyanmic property should return false from WP_List_Table::__isset()' );
+            'The property `undeclared_property` is not declared. Checking `isset()` on a dynamic property ' .
+            'is deprecated since version 6.4.0! Instead, declare the property on the class.'
+        );
+        $this->assertFalse( isset( $this->list_table->undeclared_property ), 'Checking a dynamic property should return false from WP_List_Table::__isset()' );
     }
 
@@ -478 +478 @@
         $this->expectDeprecation();
         $this->expectDeprecationMessage(
-            'A property `undefined_property` is not defined. Unsetting a dynamic (undefined) property is ' .
-            'deprecated since version 6.4.0! Instead, define the property on the class.'
-        );
-        unset( $this->list_table->undefined_property );
+            'A property `undeclared_property` is not declared. Unsetting a dynamic property is ' .
+            'deprecated since version 6.4.0! Instead, declare the property on the class.'
+        );
+        unset( $this->list_table->undeclared_property );
     }