Changeset 31278

Timestamp:

01/25/2015 07:50:31 AM (10 years ago)

Author:

nacin

Message:

Allow $autoload in add_option() to receive false.

props dllh.
fixes #31119.

Location:

trunk

Files:

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

trunk/src/wp-includes/option.php

@@ -347 +347 @@
  * @param mixed          $value       Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
  * @param string         $deprecated  Optional. Description. Not used anymore.
- * @param string|bool    $autoload    Optional. Default is enabled. Whether to load the option when WordPress starts up.
+ * @param string|bool    $autoload    Optional. Whether to load the option when WordPress starts up.
+ *                                    Default is enabled. Accepts 'no' to disable for legacy reasons.
  * @return bool False if option was not added and true if option was added.
  */
@@ -374 +375 @@
 
     $serialized_value = maybe_serialize( $value );
-    $autoload = ( 'no' === $autoload ) ? 'no' : 'yes';
+    $autoload = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes';
 
     /**

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

@@ -100 +100 @@
         delete_option( 'notoptions' );
     }
+
+    function data_option_autoloading() {
+        return array(
+            array( 'autoload_yes',    'yes',   'yes' ),
+            array( 'autoload_true',   true,    'yes' ),
+            array( 'autoload_string', 'foo',   'yes' ),
+            array( 'autoload_int',    123456,  'yes' ),
+            array( 'autoload_array',  array(), 'yes' ),
+            array( 'autoload_no',     'no',    'no'  ),
+            array( 'autoload_false',  false,   'no'  ),
+        );
+    }
+    /**
+     * Options should be autoloaded unless they were added with "no" or `false`.
+     *
+     * @ticket 31119
+     * @dataProvider data_option_autoloading
+     */
+    function test_option_autoloading( $name, $autoload_value, $expected ) {
+        global $wpdb;
+        $added = add_option( $name, 'Autoload test', '', $autoload_value );
+        $this->assertTrue( $added );
+
+        $actual = $wpdb->get_row( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s LIMIT 1", $name ) );
+        $this->assertEquals( $expected, $actual->autoload );
+    }
 }