Changeset 34737

Timestamp:

10/01/2015 05:36:15 AM (9 years ago)

Author:

pento

Message:

WPDB: Allow null values in the CRUD functions.

Specifically, ::insert(), ::replace(), ::update(), and ::delete() can now set a column to NULL, or add the IS NULL condition to the WHERE clause.

This is based on ​[backpress 279].

Props pento, nbachiyski, sorich87.

Fixes #15158.

Location:

trunk

Files:

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

trunk/src/wp-includes/wp-db.php

@@ -1780 +1780 @@
      * @param array        $data   Data to insert (in column => value pairs).
      *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+     *                             Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
      * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
      *                             If string, that format will be used for all of the values in $data.
@@ -1804 +1805 @@
      * @param array        $data   Data to insert (in column => value pairs).
      *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+     *                             Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
      * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
      *                             If string, that format will be used for all of the values in $data.
@@ -1828 +1830 @@
      * @param array        $data   Data to insert (in column => value pairs).
      *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+     *                             Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
      * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
      *                             If string, that format will be used for all of the values in $data.
@@ -1849 +1852 @@
         $formats = $values = array();
         foreach ( $data as $value ) {
+            if ( is_null( $value['value'] ) ) {
+                $formats[] = 'NULL';
+                continue;
+            }
+
             $formats[] = $value['format'];
             $values[]  = $value['value'];
@@ -1876 +1884 @@
      * @param array        $data         Data to update (in column => value pairs).
      *                                   Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+     *                                   Sending a null value will cause the column to be set to NULL - the corresponding
+     *                                   format is ignored in this case.
      * @param array        $where        A named array of WHERE clauses (in column => value pairs).
      *                                   Multiple clauses will be joined with ANDs.
      *                                   Both $where columns and $where values should be "raw".
+     *                                   Sending a null value will create an IS NULL comparison - the corresponding format will be ignored in this case.
      * @param array|string $format       Optional. An array of formats to be mapped to each of the values in $data.
      *                                   If string, that format will be used for all of the values in $data.
@@ -1905 +1916 @@
         $fields = $conditions = $values = array();
         foreach ( $data as $field => $value ) {
+            if ( is_null( $value['value'] ) ) {
+                $fields[] = "`$field` = NULL";
+                continue;
+            }
+
             $fields[] = "`$field` = " . $value['format'];
             $values[] = $value['value'];
         }
         foreach ( $where as $field => $value ) {
+            if ( is_null( $value['value'] ) ) {
+                $conditions[] = "`$field` IS NULL";
+                continue;
+            }
+
             $conditions[] = "`$field` = " . $value['format'];
             $values[] = $value['value'];
@@ -1937 +1958 @@
      *                                   Multiple clauses will be joined with ANDs.
      *                                   Both $where columns and $where values should be "raw".
+     *                                   Sending a null value will create an IS NULL comparison - the corresponding format will be ignored in this case.
      * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where.
      *                                   If string, that format will be used for all of the items in $where.
@@ -1955 +1977 @@
         $conditions = $values = array();
         foreach ( $where as $field => $value ) {
+            if ( is_null( $value['value'] ) ) {
+                $conditions[] = "`$field` IS NULL";
+                continue;
+            }
+
             $conditions[] = "`$field` = " . $value['format'];
             $values[] = $value['value'];

trunk/tests/phpunit/tests/db.php

@@ -808 +808 @@
         return 'fake_col_charset';
     }
+
+    /**
+     * @ticket 15158
+     */
+    function test_null_insert() {
+        global $wpdb;
+
+        $key = 'null_insert_key';
+
+        $wpdb->insert(
+            $wpdb->postmeta,
+            array(
+                'meta_key' => $key,
+                'meta_value' => NULL
+            ),
+            array( '%s', '%s' )
+        );
+
+        $row = $wpdb->get_row( "SELECT * FROM $wpdb->postmeta WHERE meta_key='$key'" );
+
+        $this->assertNull( $row->meta_value );
+    }
+
+    /**
+     * @ticket 15158
+     */
+    function test_null_update_value() {
+        global $wpdb;
+
+        $key = 'null_update_value_key';
+        $value = 'null_update_value_key';
+
+        $wpdb->insert(
+            $wpdb->postmeta,
+            array(
+                'meta_key' => $key,
+                'meta_value' => $value
+            ),
+            array( '%s', '%s' )
+        );
+
+        $row = $wpdb->get_row( "SELECT * FROM $wpdb->postmeta WHERE meta_key='$key'" );
+
+        $this->assertSame( $value, $row->meta_value );
+
+        $wpdb->update(
+            $wpdb->postmeta,
+            array( 'meta_value' => NULL ),
+            array(
+                'meta_key' => $key,
+                'meta_value' => $value
+            ),
+            array( '%s' ),
+            array( '%s', '%s' )
+        );
+
+        $row = $wpdb->get_row( "SELECT * FROM $wpdb->postmeta WHERE meta_key='$key'" );
+
+        $this->assertNull( $row->meta_value );
+    }
+
+    /**
+     * @ticket 15158
+     */
+    function test_null_update_where() {
+        global $wpdb;
+
+        $key = 'null_update_where_key';
+        $value = 'null_update_where_key';
+
+        $wpdb->insert(
+            $wpdb->postmeta,
+            array(
+                'meta_key' => $key,
+                'meta_value' => NULL
+            ),
+            array( '%s', '%s' )
+        );
+
+        $row = $wpdb->get_row( "SELECT * FROM $wpdb->postmeta WHERE meta_key='$key'" );
+
+        $this->assertNull( $row->meta_value );
+
+        $wpdb->update(
+            $wpdb->postmeta,
+            array( 'meta_value' => $value ),
+            array(
+                'meta_key' => $key,
+                'meta_value' => NULL
+            ),
+            array( '%s' ),
+            array( '%s', '%s' )
+        );
+
+        $row = $wpdb->get_row( "SELECT * FROM $wpdb->postmeta WHERE meta_key='$key'" );
+
+        $this->assertSame( $value, $row->meta_value );
+    }
+
+    /**
+     * @ticket 15158
+     */
+    function test_null_delete() {
+        global $wpdb;
+
+        $key = 'null_update_where_key';
+        $value = 'null_update_where_key';
+
+        $wpdb->insert(
+            $wpdb->postmeta,
+            array(
+                'meta_key' => $key,
+                'meta_value' => NULL
+            ),
+            array( '%s', '%s' )
+        );
+
+        $row = $wpdb->get_row( "SELECT * FROM $wpdb->postmeta WHERE meta_key='$key'" );
+
+        $this->assertNull( $row->meta_value );
+
+        $wpdb->delete(
+            $wpdb->postmeta,
+            array(
+                'meta_key' => $key,
+                'meta_value' => NULL
+            ),
+            array( '%s', '%s' )
+        );
+
+        $row = $wpdb->get_row( "SELECT * FROM $wpdb->postmeta WHERE meta_key='$key'" );
+
+        $this->assertNull( $row );
+    }
 }
-