esc_sql() WP 2.8.0

Escapes data for use in a MySQL query. Protects against SQL injections. May accept an array of strings for processing.

Works based on addslashes(), but also accepts arrays.

Almost always this function can be replaced with $wpdb->prepare() and such replacement is recommended since it corrects some formatting errors in addition to the escaping. Using esc_sql() may be more convenient in those rare cases when you need to write additional code to use $wpdb->prepare().

No Hooks.

Return

String/Array. Escaped data

Usage

esc_sql( $data );

$data(string/array) (required)

Unescaped data

Examples

#1 Basic Example

$name   = esc_sql( $name );
$status = esc_sql( $status );

$wpdb->get_var( "SELECT something FROM table WHERE foo = '$name' and status = '$status'" );

The same using $wpdb->prepare():

$wpdb->get_var(
	$wpdb->prepare( "SELECT something FROM table WHERE foo = %s and status = %s", $name, $status )
);

Notes

esc_sql() until version 3.6 was an alias of the $wpdb->escape() method which then has been deprecated.

Notes

• Global. wpdb. $wpdb WordPress database abstraction object.

Changelog

Code of esc sql: wp-includes/formatting.php ^{WP 5.4.2}

<?php
function esc_sql( $data ) {
	global $wpdb;
	return $wpdb->_escape( $data );
}

Related Functions

From tag: esc_ (clean validate sanitize)

More from tag: query

More from category: SQL