Changeset 51818

Timestamp:

09/15/2021 10:18:36 PM (3 years ago)

Author:

hellofromTonya

Message:

Options, Meta APIs: Fix "passing null to non-nullable" deprecations to (get|add|update|delete)_option().

In all four of the get_option(), add_option(), update_option() and delete_option() functions, the $option parameter (i.e. the option name) is passed to the PHP native trim() function without prior input validation.

In PHP 8.1, this could lead to a trim(): Passing null to parameter #1 ($string) of type string is deprecated for each of these functions.

trim():

• expects a text string and is only useful when passed a text string as no other variable type can contain whitespace.
• will always return a string, which means that in practice for any non-string values passed, it would effectively function as a type cast to string.

This commit:

• Adds a check to verify the $option name is a scalar before processing it with trim().
• The "type cast" behavior is maintained.
• If the given $option name is not a scalar, such as null, the fix prevents the PHP 8.1 deprecation notice.
• Tests are added for valid but undesired option names to safeguard against regressions.

This issue is already covered by:

• the existing Tests_Option_Option::test_bad_option_names() test group.
• the new test_valid_but_undesired_option_names() tests.

Follow-up to [13858], [22633], [23510], [25002], [51817].

Props jrf, hellofromTonya, pbearne.
See #53635.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (4 diffs)
• tests/phpunit/tests/option/option.php (modified) (1 diff)

trunk/src/wp-includes/option.php

@@ -78 +78 @@
     global $wpdb;
 
-    $option = trim( $option );
+    if ( is_scalar( $option ) ) {
+        $option = trim( $option );
+    }
+
     if ( empty( $option ) ) {
         return false;
@@ -379 +382 @@
     global $wpdb;
 
-    $option = trim( $option );
+    if ( is_scalar( $option ) ) {
+        $option = trim( $option );
+    }
+
     if ( empty( $option ) ) {
         return false;
@@ -566 +572 @@
     }
 
-    $option = trim( $option );
+    if ( is_scalar( $option ) ) {
+        $option = trim( $option );
+    }
+
     if ( empty( $option ) ) {
         return false;
@@ -688 +697 @@
     global $wpdb;
 
-    $option = trim( $option );
+    if ( is_scalar( $option ) ) {
+        $option = trim( $option );
+    }
+
     if ( empty( $option ) ) {
         return false;

trunk/tests/phpunit/tests/option/option.php

@@ -150 +150 @@
 
     /**
+     * @ticket 53635
+     *
+     * @dataProvider data_valid_but_undesired_option_names
+     *
+     * @param mixed $option_name Option name.
+     */
+    public function test_get_option_valid_but_undesired_option_names( $option_name ) {
+        $this->assertFalse( get_option( $option_name ) );
+    }
+
+    /**
+     * @ticket 53635
+     *
+     * @dataProvider data_valid_but_undesired_option_names
+     *
+     * @param mixed $option_name Option name.
+     */
+    public function test_add_option_valid_but_undesired_option_names( $option_name ) {
+        $this->assertTrue( add_option( $option_name, '' ) );
+    }
+
+    /**
+     * @ticket 53635
+     *
+     * @dataProvider data_valid_but_undesired_option_names
+     *
+     * @param mixed $option_name Option name.
+     */
+    public function test_update_option_valid_but_undesired_option_names( $option_name ) {
+        $this->assertTrue( update_option( $option_name, '' ) );
+    }
+
+    /**
+     * @ticket 53635
+     *
+     * @dataProvider data_valid_but_undesired_option_names
+     *
+     * @param mixed $option_name Option name.
+     */
+    public function test_delete_option_valid_but_undesired_option_names( $option_name ) {
+        $this->assertFalse( delete_option( $option_name ) );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_valid_but_undesired_option_names() {
+        return array(
+            'string 123'   => array( '123' ),
+            'integer 123'  => array( 123 ),
+            'integer -123' => array( -123 ),
+            'float 12.3'   => array( 12.3 ),
+            'float -1.23'  => array( -1.23 ),
+            'boolean true' => array( true ),
+        );
+    }
+
+    /**
      * @ticket 23289
      */