wpdb{} │ WP 0.71 │ AllowDynamicProperties

Позволяет производить любые операции с базой данных WordPress: вставлять, обновлять, получать или удалять данные.

WordPress предоставляет возможность удобно манипулировать своей базой данных за счет php класса wpdb.

Обращаться к методам класса wpdb нужно обязательно через глобальную переменную $wpdb (это экземпляр класса wpdb). Также нужно помнить, что внутри обычных функций нужно обязательно глобализировать $wpdb, иначе она будет простой переменной внутри функции, делается это так:

global $wpdb;

C помощью методов $wpdb можно управлять произвольными таблицами в базе данных, не обязательно только теми, которые были созданы WordPress. Допустим, среди прочих таблиц WP, есть таблица newtable и нам нужно выбрать все поля id из нее. Реализовать это можно таким SQL запросом используя $wpdb:

$newtable = $wpdb->get_results( "SELECT id FROM newtable" );

Создание отдельного подключения к базе данных

Нужно понимать, что один объект класса wpdb{} работает с одной БД - с текущей базой данных WordPress. Если нужно работать параллельно с какой-либо другой БД, то нужно создать еще один объект класса wpdb с указанием новых параметров соединения, отличных от тех что указаны в wp-config.php. Делается это так:

global $wpdb2;

$wpdb2 = new wpdb( 'имя_юзера', 'пароль', 'название_БД', 'localhost' );

// если не удалось подключиться, и нужно оборвать PHP с сообщением об этой ошибке
if( ! empty($wpdb2->error) )
	wp_die( $wpdb2->error );

// Готово, теперь используем функции класса wpdb
$results = $wpdb2->get_results( "SELECT * FROM table" );

Для сложных соединений с несколькими БД (репликами), есть хороший плагин, который рекомендуют разработчики WP - hyperdb. Этот плагин расширяет возможности базового класса wpdb. Устанавливается он не как обычный плагин и требует определенных знаний работы с базами данных (в противном случае, толку от этого плагина не будет).

Возвращает

Экземпляр класса wpdb.

Использвоание

global $wpdb;

$result = $wpdb->query( "UPDATE ..." );

Примеры

global $wpdb;

$done = $wpdb->query( "UPDATE ..." );

// get data

$objects = $wpdb->get_results( "SELECT ..." );

$object = $wpdb->get_row( "SELECT ..." );

$values = $wpdb->get_col( "SELECT ..." );

$var = $wpdb->get_var( "SELECT ..." );

$var = $wpdb->get_var( "SELECT ..." );

// CRUD data

$done = $wpdb->insert( 'table', [ 'column' => 'foo', 'field' => 'bar' ] );

$done = $wpdb->update( 'table', [ 'column' => $_GET['val'] ], [ 'ID' => 1 ] );

$done = $wpdb->delete( 'table', [ 'ID' => 1 ] );

$done = $wpdb->replace( 'table_name', [ 'ID' => 1, 'column' => $_GET['val'] ] );

Добавить свой пример

query — произвольный запрос к Базе Данных WordPress

Выполняет любые запросы к базе данных WordPress.

Этот метод подразумевает выполнение всех запросов кроме SELECT. Для SELECT есть специальные методы: $wpdb->get_results, $wpdb->get_row, $wpdb->get_col, $wpdb->get_var.

// способ 1
esc_sql( $user_entered_data_string )

// способ 2
$wpdb->prepare(  'query' , value_parameter[, value_parameter ... ] )

Возвращает

int|true|false.

• true — для запросов CREATE, ALTER, TRUNCATE, DROP.
• Число — задействованных строк, для запросов: DELETE/UPDATE/SELECT.
• false — когда запрос вызвал ошибку.

Использование

global $wpdb;
$wpdb->query( $query );

$query(строка) (обязательный)

Database query.

Примеры

$wpdb->query( "DELETE FROM $wpdb->postmeta WHERE post_id = '13' AND meta_key = 'gargle'" );

$wpdb->query( "UPDATE $wpdb->posts SET post_parent = 7 WHERE ID = 15 AND post_status = 'static'" );

$wpdb->query("DELETE pm FROM $wpdb->postmeta pm LEFT JOIN wp_posts wp ON wp.ID = pm.post_id WHERE wp.ID IS NULL");

$wpdb->query( "
	UPDATE $wpdb->postmeta
	SET meta_key = REPLACE(meta_key, 'knowledge-base-type', 'knowledge-base-list')
	WHERE `meta_key` LIKE '%knowledge-base-type%'
" );

get_var — получение определенной ячейки таблицы

Получает значение одной ячейки из результата запроса. По умолчанию берется первая ячейка — это первая колонка и первая строка.

Если результат запроса содержит больше одной колонки и/или больше одной строки, то будет возвращено значение указанной ячейки (указывается во 2 и 3 параметрах). Так, чтобы получить значение второй ячейки из второй строки результата запроса, нужно указать второй и третий параметры: $column_offset = 1, $row_offset = 1.

Возвращает

Строку|null. Значение ячейки таблицы базы данных в виде строки.

• значение ячейки — если запрос получает значение одной ячейки (колонки в строке).
• значение первой ячейки первой колонки — если запрос получает одну строку и несколько колонок.
• значение первой ячейки первой строки и колонки — если запрос получает несколько строк и колонок.
• NULL — когда результата нет.

Использование

$wpdb->get_var( 'query', $column_offset, $row_offset );

query(строка/null)

Запрос который нужно выполнить. Можно установить этот параметр в значение null, тогда функция вернет результат последнего запроса, который был выполнен классом (сохранился в переменной).

column_offset(число)

Нужная колонка (отступ по колонкам). по умолчанию 0 - первая колонка.

row_offset(число)

Нужная строка (отступ по строкам). по умолчанию 0 - первая строка.

Примеры

$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->users;" );
echo '<p>Количество пользователей равно: ' . $user_count . '</p>';

// определяем произвольный ключ, который нужно посчитать
$meta_key = 'miles';
$allmiles = $wpdb->get_var($wpdb->prepare(
	"SELECT sum(meta_value) FROM $wpdb->postmeta WHERE meta_key = %s", $meta_key
));
echo '<p>Общее количество произвольных полей miles: '.$allmiles . '</p>';

# Общее Количество авторов блога
function get_totalauthors() {
	global $wpdb;
	$totalauthors = intval( $wpdb->get_var(
		"
		SELECT COUNT(ID) FROM $wpdb->users
		LEFT JOIN $wpdb->usermeta ON $wpdb->usermeta.user_id = $wpdb->users.ID
		WHERE $wpdb->users.user_activation_key = '' AND $wpdb->usermeta.meta_key = '{$wpdb->prefix}user_level' AND (meta_value+0.00) > 1
		"
	) );

	return $totalauthors;
}

# Общее Количество постов
function get_totalposts(){
	global $wpdb;
	$totalposts = intval( $wpdb->get_var(
		"SELECT COUNT(ID) FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish'"
	) );

	return $totalposts;
}

# Общее Количество страниц
function get_totalpages() {
	global $wpdb;
	$totalpages = intval( $wpdb->get_var(
		"SELECT COUNT(ID) FROM $wpdb->posts WHERE post_type = 'page' AND post_status = 'publish'"
	));

	return $totalpages;
}

# Общее Количество комментариев
function get_totalcomments() {
	global $wpdb;
	$totalcomments = intval( $wpdb->get_var(
		"SELECT COUNT(comment_ID) FROM $wpdb->comments WHERE comment_approved = '1'"
	));

	return $totalcomments;
}

# Общее Количество комментаторов
function get_totalcommentposters() {
	global $wpdb;
	$totalcommentposters = intval($wpdb->get_var(
		"SELECT COUNT(DISTINCT comment_author) FROM $wpdb->comments WHERE comment_approved = '1' AND comment_type = ''"
	));

	return $totalcommentposters;
}

# Общее Количество ссылок
function get_totallinks() {
	global $wpdb;
	$totallinks = intval( $wpdb->get_var("SELECT COUNT(link_id) FROM $wpdb->links") );

	return $totallinks;
}

get_row — выбор строки таблицы

Получает первую строку из результата SQL запроса. Возвращает строку в виде объекта.

Используйте параметр $row_offset, чтобы получить вторую, третью, ..., n-ю строку из запроса.

Возвращает

Массив|Объект|null|null.

• object - при $output_type = OBJECT (по умолчанию).
• array - при $output_type = ARRAY_A или ARRAY_N.
• null - когда не удалось получить данные (запрашиваемых данных нет в бд).

Использование

$wpdb->get_row( $query, $output_type, $row_offset );

$query(строка)

Запрос который нужно выполнить.

$output_type(константа)

Одна из трех констант. Может быть:

• OBJECT - результат будет возвращен в виде объекта (по умолчанию).
• ARRAY_A - результат будет возвращен в виде ассоциативного массива.
• ARRAY_N - результат будет возвращен в виде пронумерованного массива.
  По умолчанию OBJECT

$row_offset(число)

Номер возвращаемой строки результата запроса.
По умолчанию 0 (первая строка)

Примеры

$mylink = $wpdb->get_row( "SELECT * FROM $wpdb->links WHERE link_id = 10" );

// Теперь, свойства (переменные) $mylink - это названия
//колонок из таблицы $wpdb->links со значениями полей таблицы:
echo $mylink->link_id; // выведет на экран "10"

$mylink = $wpdb->get_row( "SELECT * FROM $wpdb->links WHERE link_id = 10", ARRAY_A );

// результатом будет ассоциативный массив
echo $mylink['link_id']; // выведет на экран "10"

$mylink = $wpdb->get_row( "SELECT * FROM $wpdb->links WHERE link_id = 10", ARRAY_N );

// результатом будет пронумерованный массив
echo $mylink[1]; // выведет на экран"10"

get_col — выбор столбца таблицы

Делает запрос и получает данные одной колонки таблицы базы данных в виде массива.

Если запрос вернул больше чем одну колонку (столбец), то функция вернет только данные первого столбца. Можно указать отступ в параметре $column_offset, чтобы получить данные не первого столбца, а например второго: $column_offset = 1.

Если указать $query = null, то функция вернет указанную колонку из предыдущего запроса. Используя это свойство можно получить данные других колонок из уже сделанного запроса.

Возвращает

Массив. Индексный массив с данными запроса. Пустой массив, когда не удалось получить данные.

Использование

global $wpdb;
$wpdb->get_col( $query, $x );

$query(строка/null)

Запрос который нужно выполнить. Можно установить этот параметр в значение null, тогда функция вернет результат последнего запроса.
По умолчанию: NULL (предыдущий запрос)

$x(число)

Индекс колонки данные которой нужно вернуть.
По умолчанию: 0 (первая колонка)

Примеры

// укажем в запросе одно поле
$revision_ids = $wpdb->get_col( "SELECT ID FROM $wpdb->posts WHERE post_type = 'revision'" );

// укажем в запросе все поля
$revision_ids = $wpdb->get_col( "SELECT * FROM $wpdb->posts WHERE post_type = 'revision'" );

/*
В обоих случаях вернется одинаковый массив.
Когда указываются все поля, get_col получает только первое - это ID

Array(
	[0] => 106
	[1] => 101
	[2] => 102
	[3] => 103
	...
)
*/

// сначала сделаем запрос
$wpdb->query( "SELECT * FROM $wpdb->posts WHERE post_type = 'revision' LIMIT 10" );

// теперь получим данные этого запроса
$revision_ids = $wpdb->get_col( null );
$revision_names = $wpdb->get_col( null, 5 ); // 5 - post_title

/*
Array
(
	[0] => 9949
	[1] => 9957
	[2] => 10125
	[3] => 10154
	[4] => 10221
	[5] => 10235
	[6] => 10319
	[7] => 10496
	[8] => 10532
	[9] => 10568
)
Array
(
	[0] => wp_tempnam
	[1] => Шаблоны страницы для типов записей в WP 4.7
	[2] => Политика конфиденциальности
	[3] => walker_nav_menu_start_el
	[4] => Вывод пагинации
	[5] => enter_title_here
	[6] => Smart Custom Fields - простой плагин метаполей
	[7] => register_post_type
	[8] => О сайте
	[9] => REST API в WordPress
)
*/

$wpdb->query( "SELECT * FROM $wpdb->posts WHERE post_type = 'revision'" );

$ids = wp_list_pluck( $wpdb->last_result, 'ID' );

<?php
$meta_key1 = 'model';
$meta_key2 = 'year';
$meta_key3 = 'manufacturer';
$meta_key3_value = 'Ford';

$postids = $wpdb->get_col($wpdb->prepare("
SELECT      key3.post_id
FROM        $wpdb->postmeta key3
INNER JOIN  $wpdb->postmeta key1
			on key1.post_id = key3.post_id
			and key1.meta_key = %s
INNER JOIN  $wpdb->postmeta key2
			on key2.post_id = key3.post_id
			and key2.meta_key = %s
WHERE       key3.meta_key = %s
			and key3.meta_value = %s
ORDER BY    key1.meta_value, key2.meta_value",$meta_key1, $meta_key2, $meta_key3, $meta_key3_value));

if ($postids) {
  echo 'List of ' . $meta_key3_value . '(s), sorted by ' . $meta_key1 . ', ' . $meta_key2;
  foreach( $postids as $id ){
	$post = get_post(intval($id));
	setup_postdata($post);
	?>
	<p><a href="<?php the_permalink() ?>" rel="bookmark" title="Permanent Link to <?php the_title_attribute(); ?>"><?php the_title(); ?></a></p>
	<?php
  }
}

$meta_key1 = 'Color';
$meta_key2 = 'Display_Order';

$postids = $wpdb->get_col($wpdb->prepare("
SELECT      key1.post_id
FROM        $wpdb->postmeta key1
INNER JOIN  $wpdb->postmeta key2
			on key2.post_id = key1.post_id
			and key2.meta_key = %s
WHERE       key1.meta_key = %s
ORDER BY    key2.meta_value+(0) ASC",
		 $meta_key2,$meta_key1));

if ($postids) {
  echo 'List of '. $meta_key1  . ' posts, sorted by ' . $meta_key2 ;
  foreach ($postids as $id) {
	$post=get_post(intval($id));
	setup_postdata($post);?>
	<p><a href="<?php the_permalink() ?>" rel="bookmark" title="Permanent Link to <?php the_title_attribute(); ?>"><?php the_title(); ?></a></p>
	<?php
  }
}

get_results — выбор нескольких строк таблицы

Получает все данные указанного запроса (все строки и колонки). Результат возвращается в виде массива. Каждый элемент массива это объект с данными отдельной строки таблицы.

Возвращает

Массив|Объект|null. Результат запроса к базе данных. Вернет:

• Массив объектов — когда $output = OBJECT или OBJECT_K.
• Массив массивов — когда $output = ARRAY_A или ARRAY_N.
• array() — когда строк по запросу не найдено или ошибка запроса.
• NULL — когда запрос пустая строка или передан неправильный тип вывода ($output_type).

Использование

global $wpdb;
$wpdb->get_results( $query, $output );

$query(строка)

Запрос который нужно выполнить.

Можно установить этот параметр в значение null, тогда функция вернет результат последнего запроса, который был произведен.

По умолчанию: null

$output(константа/строка)

Флаг указывающий в каком виде нужно вернуть данные. Возможны 4 варианта:

• OBJECT — вернет массив объектов с числовыми ключами - элементы массива будут объекты строк таблицы — [ 0 => object ].
• OBJECT_K — похож на предыдущий, только в индексах главного массива будут значения первой колонки результата запроса — [ 'field' => object ].
  Обратите внимание, если в индекс будут попадать одинаковые значения, то данные будут затираться.
• ARRAY_N — вернет индексный массив, каждый элемент которого будет так же индексным массивом — [ 0 => [...] ].
• ARRAY_A — вернет индексный массив, каждый элемент которого будет ассоциативным массивом, в котором ключом будет название колонки — [ 'field' => [...] ].

По умолчанию: OBJECT

Примеры

$fivesdrafts = $wpdb->get_results( "SELECT ID, post_title FROM $wpdb->posts WHERE post_status = 'draft' AND post_author = 5" );

foreach ( $fivesdrafts as $fivesdraft ) {
	echo $fivesdraft->post_title;
}

/**
* Возвращает результаты рейтинга (отзывов в WooCommerce) сгрупированный по оценкам
*
* @param int $post_id идентификатор поста
*
* @return array массив объектов, где каждый объект - сгрупированные данные по одной из оценок
*/
function get_cnt_rating_reviews_one_product( $post_id ){
	global $wpdb;

	return $wpdb->get_results( $wpdb->prepare(
		"
		SELECT COUNT(meta.meta_id) as num, meta.meta_value
		FROM $wpdb->comments as comments
		INNER JOIN $wpdb->commentmeta as meta ON comments.comment_ID = meta.comment_id
		WHERE comments.comment_post_ID = %d AND meta_key = 'rating'
		GROUP BY meta.meta_value;
		",
		$post_id
	) );

}

// использование
get_cnt_rating_reviews_one_product( 4350 );

global $wpdb;
$result = $wpdb->get_results( "SELECT * FROM invalid query" );

if ( $wpdb->last_error ) {
  echo 'wpdb error: ' . $wpdb->last_error;
}

<?php
$fivesdrafts = $wpdb->get_results( "SELECT * FROM $wpdb->posts WHERE post_status = 'draft' AND post_author = 5");
if( $fivesdrafts ) :
	foreach( $fivesdrafts as $post ){
		setup_postdata($post);
		?>
			<h2><a href="<?php the_permalink(); ?>" rel="bookmark"
				title="Permanent Link to <?php the_title(); ?>"><?php the_title(); ?></a></h2>
		<?php
	}
else :
?>
	<h2> Не найдено</h2>
<?php endif; ?>

insert — вставка новой записи (строки) в таблицу

Вставляет строку (указанные данные) в указанную таблицу.

После добавления данных созданное значение AUTO_INCREMENT можно получить в переменной: $wpdb->insert_id.

Возвращает

int|false.

• число — число вставленных строк.
• false — если данные не были вставлены в таблицу.

Использование

global $wpdb;
$wpdb->insert( $table, $data, $format );

$table(строка) (обязательный)

Название таблицы в которую будем вставлять данные.

$data(массив)

Данные которые нужно вставить. Каждый элемент массива выглядит так: [ 'колонка таблицы' => 'значение' ].

Если указать в значении NULL, то в значение будет установлено NULL, указанный формат при этом игнорируется.

Передаваемые данные НЕ должны быть очищены: esc_sql().

$format(массив/строка)

Массив форматов данных которые будут ассоциированы с указанными значениями в параметре $data. Если указана строка, то она (формат) будет ассоциирован со всеми данными. При указании формата, WordPress переводит переданные данные в указанный формат перед тем, как сохранить данные. Возможные форматы:

• %s - строка
• %d - целое число
• %f - дробное число

Если не указать, то для всех значений $data будет указан формат строка, если иное не указано в свойстве wpdb::$field_types.
По умолчанию: null

Примеры

// вставка строки с указанием значений для двух полей (значения для остальных полей будут дефолтные)
$wpdb->insert( 'table', [ 'column' => 'foo', 'field' => 'bar' ] );

// с указанием типов данных
$wpdb->insert( 'table', [ 'column' => 'foo', 'field' => 1337 ], [ '%s', '%d' ] );

global $wpdb;

$table = $wpdb->prefix . 'my_table_name';
$data = [ 'column1' => 'data one', 'column2' => 123 ];

$wpdb->insert( $table, $data );

$my_id = $wpdb->insert_id;

update — обновление записи (строки) в таблице

Обновляет указанные данные в указанной строке таблицы.

Возвращает

int|false.

• число - сколько строк было обработано
• 0 - запрос был выполнен корректно, но ни одна строка не была обработана. Если в БД уже есть данные и вы пытаетесь обновить, указав точно такие же данные, то wpdb::update() вернет 0.
• false - запрос провалился или ошибка запроса.

Использование

global $wpdb;
$wpdb->update( $table, $data, $where, $format, $where_format );

$table(строка) (обязательный)

Название таблицы, данные в которой нужно обновить.

$data(массив) (обязательный)

Данные, которые нужно обновить в формате [ 'название колонки' => 'новое значение' ].

Если в значении указать NULL, то в значение будет установлено в NULL, соответствующий формат при этом игнорируется.

$where(массив) (обязательный)

Ассоциированный массив с условием выборки строк таблицы данные в которых нужно обновить (SQL WHERE). Формат массива: [ 'название колонки' => 'чему равно' ]. Если указать несколько элементов в массиве, то указанные условия будут объедены через AND - т.е. должны будут совпасть все условия, а НЕ какое-либо одно. Если в значении указать NULL то в запросе получим сравнение IS NULL, соответствующий формат при этом игнорируется.

$format(массив/строка)

Массив форматов данных которые будут ассоциированы с указанными значениями в параметре $data. Если указана строка, то она (формат) будет ассоциирован со всеми данными. При указании формата, WordPress переводит переданные данные в указанный формат перед созданием запроса. Возможные форматы:

• %s - строка
• %d - целое число
• %f - дробное число

Если не указать, то для всех значений $data будет указан формат строка, если иное не указано в свойстве wpdb::$field_types.
По умолчанию: null

$where_format(массив/строка)

Тоже самое что и $format, только для $where данных.
По умолчанию: null

Примеры

$wpdb->update( 'table',
	[ 'column1' => 'value1', 'column2' => $_GET['val'] ],
	[ 'ID' => 1 ]
);

$wpdb->update( 'table',
	[ 'column1' => 'value1', 'column2' => $_GET['val'] ],
	[ 'ID' => 1 ],
	[ '%s', '%d' ],
	[ '%d' ]
);

$wpdb->update( 'table', [ 'column' => 'foo', 'field' => 'bar' ], [ 'ID' => 1 ] );
$wpdb->update( 'table', [ 'column' => 'foo', 'field' => 1337 ], [ 'ID' => 1 ], [ '%s', '%d' ], [ '%d' ] );

replace — замена строки

Обновляет или создает строку в таблице.

Если строка с указанным ключом PRIMARY KEY уже есть все остальные указанные поля будут обновлены у строки. Если такой строки в таблице еще нет, то функция вставит (insert) новую строку.

После вставки, ID созданный для колонки AUTO_INCREMENT можно получить в свойстве $wpdb->insert_id.

Возвращает

int|false. Число (кол-во обработанных строк), 0 или false.

• число - сколько строк было обработано (удалено или вставлено). Если была замена (обновление), то для каждой обновленной строки вернется +2 (удаление и вставка). Если была просто вставка, то для каждой вставленной строки вернется +1.
• 0 - запрос был выполнен корректно, но ни одна строка не была обработана.
• false - запрос провалился - ошибка запроса. Или когда невозможно заменить или создать новую строку в таблице.

Вернет количество затронутых строк - это сумма вставленных и удаленных строк. Если вернулось 1 при замене одной строки - это значит что одна строка была вставлена и ни одна не была удалена. Если число больше 1 - это значит, что одна или больше строк были удалены перед вставкой новой строки.

Использование

global $wpdb;
$wpdb->replace( $table, $data, $format );

$table(строка) (обязательный)

Название таблицы, в которой нужно заменить данные.

$data(массив) (обязательный)

Данные, которые нужно заменить/вставить в формате [ 'название колонки' => 'новое значение' ].

Если в значении указать NULL, то в значение будет установлено в NULL, соответствующий формат при этом игнорируется.

$format(массив/строка)

Массив форматов данных которые будут ассоциированы с указанными значениями в параметре $data. Если указана строка, то она (формат) будет ассоциирован со всеми данными. При указании формата, WordPress переводит переданные данные в указанный формат перед созданием запроса. Возможные форматы:

• %s - строка
• %d - целое число
• %f - дробное число

Если не указать, то для всех значений $data будет указан формат строка, если иное не указано в свойстве wpdb::$field_types.
По умолчанию: null

Примеры

$wpdb->replace( 'table_name', [
	'ID'      => 1,
	'column1' => 'value1',
	'column2' => 123
] );

$wpdb->replace( 
	'table_name', 
	[ 'column' => 'foo', 'field' => 1337 ], 
	[ '%s', '%d' ] 
);

delete — удаление строки из таблицы

Удаляет строки из таблицы по условию указанному в параметре $where.

Возвращает

int|false. Число удаленных строк или 0, если ничего не удалено. false возвращается при ошибке запроса.

Использование

global $wpdb;
$wpdb->delete( $table, $where, $where_format );

$table(строка) (обязательный)

Название таблицы.

$where(массив) (обязательный)

Массив условий, по которым будут выбираться строки для удаления в формате [ 'название колонки' => 'чему равно' ]. Несколько условий будут объеденные через AND. Если в значении указать NULL то в запросе получим сравнение IS NULL, соответствующий формат при этом игнорируется.

$where_format(массив/строка)

Массив форматов данных которые будут ассоциированы с указанными значениями в параметре $where. Если указана строка, то она (формат) будет ассоциирован со всеми данными. При указании формата, WordPress переводит переданные данные в указанный формат перед созданием запроса. Возможные форматы:

• %s - строка
• %d - целое число
• %f - дробное число

Если не указать, то для всех значений $data будет указан формат строка, если иное не указано в свойстве wpdb::$field_types.
По умолчанию: null

Примеры

// Удалим строку с полем ID=1 из таблицы table
$wpdb->delete( 'table', [ 'ID' => 1 ] );

// Укажем формат значения $where
$wpdb->delete( 'table', [ 'ID'=>'1' ], [ '%d' ] ); // 1 будет обработано как число (%d).

prepare — защита запроса от SQL инъекций

Позволяет писать SQL запрос с очисткой передаваемых в него параметров.

В строке запроса вместо передаваемого параметра нужно использовать плейсхолдер:

• %d (integer)
• %f (float)
• %s (string)

Также для каждого из плейсхолдеров указывается PHP переменная, которая заменит плейсхолдер. При замене переменная будет очищена. Синтаксис похожий на sprintf().

$sql = "SELECT * FROM table WHERE id = '$var'";

SELECT * FROM table WHERE id = '2' AND id = (DROP TABLE table2)

$sql = $wpdb->prepare( "SELECT * FROM table WHERE id = %s", $var );

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

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

Возвращает

Строку|null. Sanitized query string, if there is a query to prepare.

Использование

global $wpdb;
$wpdb->prepare( $query, ...$args );

$query(строка) (обязательный)

Строка запроса. В нем можно использовать заменители:

• %d - число
• %s - строка
• %f - дробное число (число с плавающей точкой, с версии 3.3).

...$args(строка/число/массив)

Переменные, которые будут использованы для замены плейсхолдеров %s %d %f в строке запроса.

Эти переменные можно указать через запятую (как дополнительные параметры функции) или в массиве:

• $wpdb->prepare( 'query', $param1, $param2 )
• $wpdb->prepare( 'query', [ $param1, $param2 ] ).

Примеры

$wpdb->prepare(
	"SELECT * FROM `table` WHERE `column` = %s AND `field` = %d OR `other_field` LIKE %s",
	[ 'foo', 1337, '%bar' ]
);

$wpdb->prepare(
	"SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo'
);

$metakey   = "'крах' БД";
$metavalue = "WordPress может 'сломать' Базу Данных если не экранировать запрос.";

$wpdb->query(
	$wpdb->prepare(
		"INSERT INTO $wpdb->postmeta ( post_id, meta_key, meta_value ) VALUES ( %d, %s, %s )",
		10,
		$metakey,
		$metavalue
  )
);

$metakey = "'крах' БД";
$metavalue = "WordPress может 'сломать' Базу Данных если не экранировать запрос.";

$wpdb->query(
	$wpdb->prepare(
		"INSERT INTO $wpdb->postmeta ( post_id, meta_key, meta_value ) VALUES ( %d, %s, %s )",
		array(
			10,
			$metakey,
			$metavalue
		)
  )
);

esc_like — очистка LIKE строки

Подготавливает строку для использования в LIKE части SQL запроса. Обрабатывает спецсимволы % и _.

Пример:

$wild = '%';
$find = 'only 43% of planets';
$like = $wild . $wpdb->esc_like( $find ) . $wild;
$sql  = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE %s", $like );

Пример цепочки вызовов:

$sql = esc_sql( $wpdb->esc_like( $input ) );

Возвращает

Строку. Текст для LIKE части запроса. Результат не очищен для SQL запроса, поэтому используйте wpdb::prepare() или wpdb::_real_escape() для добавления результата в запрос.

Использование

global $wpdb;
$wpdb->esc_like( $text );

$text(строка) (обязательный)

Необработанный текст, спец-символы в котором нужно экранировать для LIKE строки. Строка не должна иметь дополнительных или удаленных слэшей.

Примеры

$wild = '%';
$find = 'only 43% of planets';
$like = $wild . $wpdb->esc_like( $find ) . $wild;
$sql  = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE %s", $like );

echo $sql; // SELECT * FROM wp_posts WHERE post_content LIKE '{d710cab}only 43\{d710cab} of planets{d710cab}'

$esc_like = $wpdb->esc_like( 'only 43% of planets' );
echo $esc_like;                                        // only 43\% of planets
echo esc_sql( $esc_like );                             // only 43\{f5fa52} of planets

global $wpdb;
$link = $wpdb->esc_like( $link ); // подготовим строку для LIKE аргумента
$link = esc_sql( $link );         // очистим переменную
$link = '%' . $link . '%';        // создадим полную переменную поиска LIKE

// найдем комментарии в тексте или ссылке автора, есть указанная ссылка
$spammy = $wpdb->query("SELECT comment_approved FROM $wpdb->comments
	WHERE (comment_content LIKE '$link' OR comment_author_url LIKE '$link')
		AND comment_approved = 'spam'
	LIMIT 1;"
);

global $wpdb;

$link = '%' . $wpdb->esc_like( $link ) . '%';

$comment = $wpdb->get_row( $wpdb->prepare(
	"SELECT * FROM $wpdb->comments WHERE comment_author_url LIKE %s LIMIT 1", $link
 ) );

show/hide/print_error — показать или спрятать ошибки SQL

Есть возможность управлять ошибками, включать или выключать показ ошибок для последнего запроса:

$wpdb->show_errors(); // включит показ ошибок
$wpdb->hide_errors(); // выключит показ ошибок
$wpdb->print_error(); // включит показ ошибок на экран

get_col_info — получить информацию о колонке

Получает массив с информацией о колонках последнего запроса.

Если в запросе колонки не определены, то функция вернет информацию о всех колонках таблицы. Это может пригодится, когда был возвращен объект, о данных которого мы ничего не знаем.

Работает на основе кэша, поэтому сначала нужно сделать запрос используя get_results(), get_col(), get_var() и т.д. а потом вызвать эту функцию - она вернет данные колонок последнего запроса.

Возвращает

Разное. Данные колонок.

Использование

global $wpdb;
$wpdb->get_col_info( $info_type, $col_offset );

$info_type(строка)

Указывает какую информацию нам нужно получить. Список возможных значений:

• name - название колонки.
• table - название таблицы к которой принадлежит колонка.
• max_length - максимальная длинна данных колонки.
• not_null - 1 если ячейка колонки не может принимать значение NULL.
• primary_key - 1 если колонка является первичным ключом.
• unique_key - 1 если ячейки колонки должны быть всегда уникальны.
• multiple_key - 1 если ячейки колонки могут быть не уникальны.
• numeric - 1 если колонка содержит числовые данные.
• blob - 1 если колонка содержит данные типа BLOB (двоичные данные).
• type - тип колонки.
• unsigned - 1 если колонка имеет тип данных UNSIGNED.
• zerofill - 1 если колонка имеет тип данных ZEROFILL.

По умолчанию: name

$col_offset(число)

Указатель, информацию о какой колонке нужно получить:

• -1 — будет получена информация о всех колонках в виде массива. По умолчанию.
• 0, 1, 2, ... — будет возвращена информация об указанной колонке, где 0 - первая колонка, 1 - вторая и т.д.

По умолчанию: -1

Примеры

global $wpdb;

$results = $wpdb->get_results( "SELECT * FROM $wpdb->postmeta" );

$cols_data = $wpdb->get_col_info( 'name' );
/*
Array
(
	[0] => meta_id
	[1] => post_id
	[2] => meta_key
	[3] => meta_value
)
*/

$cols_data = $wpdb->get_col_info( 'max_length' );
/*
Array
(
	[0] => 6
	[1] => 5
	[2] => 45
	[3] => 20205
)
*/

$cols_data = $wpdb->get_col_info( 'type' );
/*
Array
(
	[0] => 8
	[1] => 8
	[2] => 253
	[3] => 252
)
*/

$cols_data = $wpdb->get_col_info( 'primary_key' );
/*
Notice: Undefined property: stdClass::$primary_key in /wpexample.com/public_html/wp-includes/wp-db.php on line 3435
Notice: Undefined property: stdClass::$primary_key in /wpexample.com/public_html/wp-includes/wp-db.php on line 3435
Notice: Undefined property: stdClass::$primary_key in /wpexample.com/public_html/wp-includes/wp-db.php on line 3435
Notice: Undefined property: stdClass::$primary_key in /wpexample.com/public_html/wp-includes/wp-db.php on line 3435

Array
(
	[0] =>
	[1] =>
	[2] =>
	[3] =>
)
*/

echo $wpdb->get_col_info( 'name', 0 );       //> meta_id
echo $wpdb->get_col_info( 'name', 1 );       //> post_id
echo $wpdb->get_col_info( 'max_length', 0 ); //> 6
echo $wpdb->get_col_info( 'max_length', 1 ); //> 5

flush — сброс кэша

Можно сбросить последние сохраненные данные в свойствах класса:

$wpdb->flush();

Эта команда очистит следующие свойства (переменные): $wpdb->last_result, $wpdb->last_query и $wpdb->col_info.

Свойства (переменные) класса

$show_errors

Показывать ошибки или нет, когда возвращается результат.
По умолчанию: true (да)

$suppress_errors

Подавлять ли ошибки в процессе построения запроса.

$last_error

Последняя ошибка из любого запроса.

$num_queries

Количество запросов, которые выполняются.

$num_rows

Количество строк, возвращенных последним запросом.

$rows_affected

Сохраняет число задействованных строк из последнего запроса. Заполняется при следующих sql командах: create, alter, truncate, drop, insert, delete, update, replace - в остальных случаях заполняется свойство $num_rows.

$insert_id

Идентификатор (ID) сгенерированный последним запросом, для SQL параметра AUTO_INCREMENT

$last_query

Последний запрос, который был выполнен классом.

$last_result

Результат последнего запроса.

$func_call

Текстовое описание последнего вызова query/get_row/get_var

$queries

Можно сохранить все запросы которые были сделаны к БД и их время выполнения, для этого нужно определить константу SAVEQUERIES как TRUE (например в config.php). По умолчанию она выключена (false). После того как эта константа включена в эту переменную будут собираться все запросы в виде массива данных.

$col_info

Информация о колонках последнего запроса.

$prefix

Префикс таблиц БД определенный для WordPress. Может пригодиться для мульти-сайтов.

$base_prefix

Префикс базовой таблицы WordPress. В мультисайте для сайтов сети префик отличается. Тут хранится префикс таблиц основного сайта сети.

$ready

Логический. Готов ли класс к выполнению запросов.

$blogid

Идентификатор текущего блога.

$siteid

ID сайта.

$tables

Список названий таблиц, которые используются (копируются) для каждого подсайта сети сайтов. Название таблиц будет отличаться префиксом текущего блога. Названия без префикса по умолчанию:

var $tables = array(
	'posts',
	'comments',
	'links',
	'options',
	'postmeta',
	'terms',
	'term_taxonomy',
	'term_relationships',
	'termmeta',
	'commentmeta',
);

$global_tables

Глобальные таблицы. Не повторяются для подсайтов.

array( 'users', 'usermeta' );

$ms_global_tables

Глобальные таблицы в режиме MU.

var $ms_global_tables = array(
	'blogs',
	'blogmeta',
	'signups',
	'site',
	'sitemeta',
	'sitecategories',
	'registration_log',
);

$collate

Режим сопоставления (сравнивания) данных в колонках базы данных.

$dbh

PHP объект базы mysqli.

Таблицы Базы Данных WordPress

Записи — подробнее здесь

$wpdb->posts

Таблица куда записываются посты, постоянные страницы, произвольные типы записей, вложения и т.п.

$wpdb->postmeta

Дополняет таблицу $wpdb->posts. Хранит дополнительные данные записей (постов) их еще называют метаполя.

Пользователи

$wpdb->users

Таблица с данными о зарегистрированных пользователях.

$wpdb->usermeta

Дополнительная информация о пользователях, такая как Имя, Ник, права и прочее.
Мета поля для таблицы $wpdb->users.

Комментарии

$wpdb->comments

Таблица с записями комментариев.

$wpdb->commentmeta

Мета поля для таблицы $wpdb->comments.

Таксономии — подробнее

$wpdb->terms

Таблица содержащая в себе базовую информацию каждом элементе таксономии.

$wpdb->termmeta

Таблица содержащая в себе дополнительные поля для таблицы $wpdb->terms.

$wpdb->term_taxonomy

Таблица с информацией о таксономиях, их описание.

$wpdb->term_relationships

Таблица связывающая таксономии с контентом (постами, записями и т.п.)

Остальные таблицы

$wpdb->links

Таблица с записями ссылок.

$wpdb->options

Таблица опций (настроек).

Таблицы Multisite сборки

$wpdb->blogs

Все сайты подсети.

$wpdb->blog_versions

Содержит текущую версию базы данных каждого сайта. Данные обновляются при обновлении БД для каждого сайта сети.

$wpdb->registration_log

Содержит данные администраторов сайтов, которые создаются при создании сайтов.

$wpdb->signups

Содержит пользователей, которые были зарегистрированы через базовую регистрацию WordPress со страницы: Администрация > Супер Админ > Настройки.

$wpdb->site

Содержит, адреса основных сайтов.

$wpdb->sitemeta

Данные сайтов: различные опции, включая администратора сайта.

$wpdb->users

Список пользователей всех сайтов сети. Это общая таблица пользователей для всей сети. Это привычная таблица, только в мультисайт версии добавляются еще 2 поля: spam и delete.

$wpdb->usermeta

Содержит мета-данные пользователей. Настройки пользователя для разных сайтов сети.

Базовые таблицы каждого сайта сети

Таблицы сайта сети: wp_posts, wp_options и т.д.. Для каждого сайта сети создаются одинаковые таблицы, но с разным префиксом, например: wp_options, wp_1_options, wp_2_options...

Все методы класса

1. public __construct( $dbuser, $dbpassword, $dbname, $dbhost )
2. public __get( $name )
3. public __isset( $name )
4. public __set( $name, $value )
5. public __unset( $name )
6. private _do_query( $query )
7. public _escape( $data )
8. public _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' )
9. public _real_escape( $string )
10. public _weak_escape( $string )
11. public add_placeholder_escape( $query )
12. public bail( $message, $error_code = '500' )
13. protected check_ascii( $string )
14. public check_connection( $allow_bail = true )
15. public check_database_version()
16. protected check_safe_collation( $query )
17. public close()
18. public db_connect( $allow_bail = true )
19. public db_server_info()
20. public db_version()
21. public delete( $table, $where, $where_format = null )
22. public determine_charset( $charset, $collate )
23. public esc_like( $text )
24. public escape( $data )
25. public escape_by_ref( &$string )
26. public flush()
27. public get_blog_prefix( $blog_id = null )
28. public get_caller()
29. public get_charset_collate()
30. public get_col( $query = null, $x = 0 )
31. public get_col_charset( $table, $column )
32. public get_col_info( $info_type = 'name', $col_offset = -1 )
33. public get_col_length( $table, $column )
34. public get_results( $query = null, $output = OBJECT )
35. public get_row( $query = null, $output = OBJECT, $y = 0 )
36. protected get_table_charset( $table )
37. protected get_table_from_query( $query )
38. public get_var( $query = null, $x = 0, $y = 0 )
39. public has_cap( $db_cap )
40. public hide_errors()
41. public init_charset()
42. public insert( $table, $data, $format = null )
43. protected load_col_info()
44. public log_query( $query, $query_time, $query_callstack, $query_start, $query_data )
45. public parse_db_host( $host )
46. public placeholder_escape()
47. public prepare( $query, ...$args )
48. public print_error( $str = '' )
49. protected process_field_charsets( $data, $table )
50. protected process_field_formats( $data, $format )
51. protected process_field_lengths( $data, $table )
52. protected process_fields( $table, $data, $format )
53. public query( $query )
54. public remove_placeholder_escape( $query )
55. public replace( $table, $data, $format = null )
56. public select( $db, $dbh = null )
57. public set_blog_id( $blog_id, $network_id = 0 )
58. public set_charset( $dbh, $charset = null, $collate = null )
59. public set_prefix( $prefix, $set_table_names = true )
60. public set_sql_mode( $modes = array() )
61. public show_errors( $show = true )
62. protected strip_invalid_text( $data )
63. public strip_invalid_text_for_column( $table, $column, $value )
64. protected strip_invalid_text_from_query( $query )
65. public supports_collation()
66. public suppress_errors( $suppress = true )
67. public tables( $scope = 'all', $prefix = true, $blog_id = 0 )
68. public timer_start()
69. public timer_stop()
70. public update( $table, $data, $where, $format = null, $where_format = null )

—