Introduce $wpdb->delete()

[scribu]

We already have update() and insert() methods, which are awesome, but no delete() method.

It seems like a no-brainer to me.

my suggestion

Yep, that's what I had in mind. The bigger task will be using it throughout the WP codebase.

It seems like a no-brainer to me.

+1.

Been going through all the code that contains sql DELETE queries and I ran across the below query. 18948.diff won't handle this type of delete.

/wp-admin/includes/upgrade.php#L295

"DELETE FROM $wpdb->usermeta WHERE user_id != %d AND meta_key = %s"

Any suggestions?

+10 Adding it as suggested in the patch wouldn't harm anyone. Porting it to different places in core can be done later with another (some other) tickets.

Updated wpdb->delete and the files I've updated the DELETE queries.

Replying to justindgivens:

Been going through all the code that contains sql DELETE queries and I ran across the below query. 18948.diff won't handle this type of delete.

Just skip it.

Replying to scribu:

Just skip it.

That's what I did. Going to look one more time through the core but I think I got most of the files updates.

$result = $wpdb->delete( "$wpdb->options" , array( "option_name" => $option) , array( '%s' ) );

should be

$result = $wpdb->delete( "$wpdb->options" , array( "option_name" => $option ) , array( '%s' ) );

---

function delete( $table, $where, $where_format = null, $limit = null) {

should be

function delete( $table, $where, $where_format = null, $limit = null ) { 

---

Also, this won't work:

$wpdb->delete( "$wpdb->options" , array( 'option_name' => "REGEXP '^rss_[0-9a-f]{32}(_ts)?$'" ) , array( '%s' ) );

REGEXP is a different operator, not a value.

---

$wpdb->delete( "$wpdb->usermeta" , array( "user_id" => $id , "meta_key" => "'{$level_key}'" ) , array( '%d' , '%s' ) );

can be

$wpdb->delete( "$wpdb->usermeta" , array( "user_id" => $id , "meta_key" => $level_key ) , array( '%d' , '%s' ) );

updated from scribu notes.

Made the changes in 18948.3.diff.

The quotes around the table name are not necessary:

$wpdb->delete( "$wpdb->usermeta",

should be

$wpdb->delete( $wpdb->usermeta,

This goes for all queries.

Also, this line is really hard to follow:

$form = ( $form = array_shift( $where_formats ) ) ? $form : $where_format[0];

Please split it up into an assignment and a normal if.

Replying to scribu:

Also, this line is really hard to follow:

$form = ( $form = array_shift( $where_formats ) ) ? $form : $where_format[0];

Please split it up into an assignment and a normal if.

How is that any different from the update() and _insert_replace_helper() functions?? wp-db.php

Just because existing code is bad doesn't mean new code also has to be bad.

Also, maybe this can be extracted into a helper method:

protected function get_form( &$where_formats, $where_format ) {

Although I think this will probably be handled better in a separate ticket. Let's just take care of the unnecessary quotes around table names.

18948.4.diff​ Updated with the quotes removed.

Related: #19019

Might need to be another ticket but the addition in this patch of:

@see wpdb:delete()

should be

@see wpdb::delete()

(the existing @see tags above it also wrong).

Several bits of whitespace inside ( ) and around ! also needed within the new method to follow code standards.

18948.5.diff​:

• refreshed against trunk
• fixed fatal error (!) in comment.php
• leave deprecated.php alone
• cleaned up wpdb::delete()

There should be no need to pass a $where_format for core fields, as these field types are already initialized in wp_set_wpdb_vars().

Was wondering about that. So, that means no queries made by Core ever need to pass the third parameter.

Will update the patch shortly.

18948.6.diff​ removes the redundant format parameters and replaces " with ' where appropriate.

In [20287]:

Introduce $wpdb->delete(). props justindgivens, scribu. fixes #18948.

[20287] appears to show the @since for the new method as 2.5.0, rather that 3.4.0 ?

Yeah, also this usage example in the docblock should be removed:

wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ), 1 )

In [20292]:

Correct @since and remove invalid code example in wpdb::delete() documentation. Props GaryJ, scribu. See #18948.