wpdb::delete( string $table, array $where, array|string $where_format = null )

Delete a row in the table

Description

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

Parameters

$table

(Required) Table name

$where

(Required) 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.

$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. A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $where will be treated as strings unless otherwise specified in wpdb::$field_types.

Default value: null

Return

(int|false) The number of rows updated, or false on error.

Source

File: wp-includes/wp-db.php

	public function delete( $table, $where, $where_format = null ) {
		if ( ! is_array( $where ) ) {
			return false;
		}

		$where = $this->process_fields( $table, $where, $where_format );
		if ( false === $where ) {
			return false;
		}

		$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'];
		}

		$conditions = implode( ' AND ', $conditions );

		$sql = "DELETE FROM `$table` WHERE $conditions";

		$this->check_current_query = false;
		return $this->query( $this->prepare( $sql, $values ) );
	}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/wp-db.php: wpdb::process_fields()	Processes arrays of field/value pairs and field formats.
wp-includes/wp-db.php: wpdb::query()	Perform a MySQL database query, using current database connection.
wp-includes/wp-db.php: wpdb::prepare()	Prepares a SQL query for safe execution. Uses sprintf()-like syntax.

Used By

Used By
Used By	Description
wp-includes/ms-functions.php: wp_delete_signup_on_user_delete()	Deletes am associated signup entry when a user is deleted from the database.
wp-includes/comment.php: wp_delete_comment()	Trashes or deletes a comment.
wp-includes/meta.php: delete_metadata_by_mid()	Delete meta data by meta ID
wp-includes/option.php: delete_network_option()	Removes a network option by name.
wp-includes/option.php: delete_option()	Removes option by name. Prevents removal of protected ClassicPress options.
wp-includes/post.php: wp_delete_attachment()	Trash or delete an attachment.
wp-includes/post.php: wp_delete_post()	Trash or delete a post or page.
wp-includes/ms-functions.php: wpmu_validate_user_signup()	Sanitize and validate data required for a user sign-up.
wp-includes/ms-functions.php: wpmu_validate_blog_signup()	Processes new site registrations.
wp-includes/taxonomy.php: wp_delete_term()	Removes a term from the database.
wp-includes/taxonomy.php: wp_insert_term()	Add a new term to the database.
wp-admin/includes/bookmark.php: wp_delete_link()	Deletes a specified link from the database.
wp-admin/includes/upgrade.php: wp_install_defaults()	Creates the initial content for a newly-installed site.
wp-admin/includes/user.php: wp_delete_user()	Remove user and optionally reassign posts and links to another user.
wp-admin/includes/ms.php: wpmu_delete_blog()	Delete a site.
wp-admin/includes/ms.php: wpmu_delete_user()	Delete a user from the network and remove from all sites.

Show 11 more used by Hide more used by

Changelog

Changelog
Version	Description
WP-3.4.0	Introduced.