This page redirects to an external site: https://developer.wordpress.org/reference/classes/wpdb/
Languages: English • Italiano • 日本語 Русский • 中文(简体) • 中文(繁體) • (Add your language)
WordPress предоставляет класс функций для всех манипуляций с базами данных. Данный класс называется wpdb и основан на ezSQL свободном классе, написанном и поддерживаемом Justin Vincent.
Методы класса wpdb() не должны вызываться напрямую.
WordPress предоставляет глобальную переменную, $wpdb, которая является экземпляром уже настроенного класса для обращения с базами данных WordPress. Всегда используйте глобальную переменную $wpdb. (Не забудьте про глобализацию $wpdb когда используете её в каких либо пользовательских функциях.)
Объект $wpdb может использоваться для чтения данных из любой таблицы в базе данных WordPress (например пользовательские таблицы), а не только стандартных таблиц которые создаёт WordPress. Например для выборки(запроса SELECT) некоторой информации из пользовательской таблицы названной "mytable", вы можете сделать следующее:
$myrows = $wpdb->get_results( "SELECT id, name FROM mytable" );
Объект $wpdb может обращаться с любым количеством таблиц, но только одной базой данных - базой данных WordPress. В редких случаях, если вам понадобится подключится к другой базе данных, вам придётся создать экземпляр нового объекта из класса wpdb с соответствующими подробностями соединения для пользовательской базы данных. Для чрезвычайно сложных установок с множеством баз данных, рассмотрите возможность использования hyperdb.
Функция query позволяет вам выполнить любой SQL запрос к базе данных WordPress. Однако, лучше использовать более специфичные функции(смотрите ниже) для SELECT запросов.
<?php $wpdb->query('query'); ?>
Функция возвращает целое число, соответствующее количеству затронутых/выбранных строк. При ошибке MySQL функция возвращает FALSE. (Замечание: поскольку 0 и FALSE могут возвратится, убедитесь, что вы используете корректный оператор сравнения: equality(равенство) == против identicality(идентично) ===).
Замечание: Как и во всех функциях данного класса которые выполняют SQL запросы, вы должны экранировать весь SQL ввод(e.g., wpdb->escape($user_entered_data_string)). См. раздел Protect Queries Against SQL Injection Attacks ниже.
Удаление мета ключа 'gargle' и значения из Post 13. (Мы добавили метод 'prepare' чтобы быть уверенными, что мы не имеем дело с недопустимой операцией или символами):
$wpdb->query(
$wpdb->prepare(
"
DELETE FROM $wpdb->postmeta
WHERE post_id = %d
AND meta_key = %s
",
13, 'gargle'
)
);
Performed in WordPress by delete_post_meta().
Сделать страницу 7 родительской для страницы 15 Page.
$wpdb->query( " UPDATE $wpdb->posts SET post_parent = 7 WHERE ID = 15 AND post_status = 'static' " );
The get_var function returns a single variable from the database. Though only one variable is returned, the entire result of the query is cached for later use. Returns NULL if no result is found.
<?php $wpdb->get_var('query',column_offset,row_offset); ?>
null will return the specified variable from the cached results of the previous query.Retrieve and display the number of users.
<?php
$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->users" );
echo "<p>User count is {$user_count}</p>";
?>
Retrieve and display the sum of a Custom Field value.
<?php
// set the meta_key to the appropriate custom field meta key
$meta_key = 'miles';
$allmiles = $wpdb->get_var( $wpdb->prepare(
"
SELECT sum(meta_value)
FROM $wpdb->postmeta
WHERE meta_key = %s
",
$meta_key
) );
echo "<p>Total miles is {$allmiles}</p>";
?>
Чтобы извлечь целую строку из запроса, используйте get_row. Функция может возвращать строки как объект, ассоциативный массив или как численно индексированный массив. Если в запросе возвращается более чем одна строка, только указанная строка будет возвращена в функции, но все строки будут прокэшированны для дальнейшего использования. Возвращает ОБЪЕКТ содержащий NULL если результат не определён, учитывайте это когда используете возвращённую переменную в качестве аргумента, смотрите пример ниже.
<?php $wpdb->get_row('query', output_type, row_offset); ?>
Получение всей информации об Link 10.
$mylink = $wpdb->get_row("SELECT * FROM $wpdb->links WHERE link_id = 10");
Свойствами объекта $mylink являются имена столбцов полученные в результате SQL запроса (в данном примере все столбцы из таблицы $wpdb->links, но вы также можете запросить только определённые столбцы).
echo $mylink->link_id; // prints "10"
в противоположность этому, использование
$mylink = $wpdb->get_row("SELECT * FROM $wpdb->links WHERE link_id = 10", ARRAY_A);
выведет результат в качестве ассоциативного массива:
echo $mylink['link_id']; // prints "10"
или
$mylink = $wpdb->get_row("SELECT * FROM $wpdb->links WHERE link_id = 10", ARRAY_N);
численно индексированного массива:
echo $mylink[1]; // prints "10"
Если записи с ID 10 не существует в данной таблице, будет возвращено null. Следующее может быть ложным:
if ($mylink != null) {
// какие-либо действия с ссылкой
return true;
} else {
// ссылка не найдена
return false;
}
To SELECT a column, use get_col. This function outputs a one dimensional array. If more than one column is returned by the query, only the specified column will be returned by the function, but the entire result is cached for later use. Returns an empty array if no result is found.
<?php $wpdb->get_col('query',column_offset); ?>
null will return the specified column from the cached results of the previous query.For this example, assume the blog is devoted to information about automobiles. Each post describes a particular car (e.g. 1969 Ford Mustang), and three Custom Fields, manufacturer, model, and year, are assigned to each post. This example will display the post titles, filtered by a particular manufacturer (Ford), and sorted by model and year.
The get_col form of the wpdb Class is used to return an array of all the post ids meeting the criteria and sorted in the correct order. Then a foreach construct is used to iterate through that array of post ids, displaying the title of each post. Note that the SQL for this example was created by Andomar.
<?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
}
}
?>
This example lists all posts that contain a particular custom field, but sorted by the value of a second custom field.
<?php
// List all posts with custom field Color, sorted by the value of custom field Display_Order
// does not exclude any 'post_type'
// assumes each post has just one custom field for Color, and one for Display_Order
$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
}
}
?>
Generic, mulitple row results can be pulled from the database с помощью get_results. Функция возвращает весь результат запроса как массив, или NULL если результат отсутствует. Каждый элемент данного массива соответствует одной строке результата запроса и, подобно get_row, может быть ОБЪЕКТОМ, ассоциативным массивом, или целочисленным массивом.
<?php $wpdb->get_results('query', output_type); ?>
null функция вернёт данные из кэшированного результата предыдущего запроса.Поскольку эта функция использует функцию '$wpdb->query()' все переменные класса установлены правильно. The results count for a 'SELECT' query will be stored in $wpdb->num_rows.
Получение ID и Заголовков всех Черновиков Пользователя с ID 5 и Вывод Заголовков.
$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;
}
Получение всей информации о черновиках Пользователя с ID 5.
<?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="Permalink: <?php the_title(); ?>">
<?php the_title(); ?>
</a>
</h2>
<?php
}
else
{
?>
<h2>Not Found</h2>
<?php
}
}
?>
Вставка строки в таблицу.
<?php $wpdb->insert( $table, $data, $format ); ?>
Возможные значения 'format': %s как строка; %d как десятичное число; и %f как число с плавающей точкой.
После вставки, сгенерированный ID для столбца AUTO_INCREMENT может быть доступно с:
$wpdb->insert_id
Эта функция возвращает false если строка не может быть вставлена.
Вставка двух столбцов в строку, первое значение является строкой, а второе - числом:
$wpdb->insert( 'table', array( 'column1' => 'value1', 'column2' => 123 ), array( '%s', '%d' ) );
Обновление строки в таблице. Возвращает false при ошибке или номер обновлённой строки при успешном обновлении.
<?php $wpdb->update( $table, $data, $where, $format = null, $where_format = null ); ?>
Possible format values: %s as string; %d as decimal number and %f as float. If omitted, all values in $where will be treated as strings.
This function returns the number of rows updated, or false if there is an error.
Update a row, where the ID is 1, the value in the first column is a string and the value in the second column is a number:
$wpdb->update( 'table', array( 'column1' => 'value1', // string 'column2' => 'value2' // integer (number) ), array( 'ID' => 1 ), array( '%s', // value1 '%d' // value2 ), array( '%d' ) );
Attention: %d can't deal with comma values - if you're not using full numbers, use string/%s.
Для более полного обзора SQL экранирования в WordPress, смотрите database Data Validation. Эта статья Data Validation является must-read для каждого автора кода и плагинов для WordPress.
Все данные в SQL запросе должны быть экранированы прежде чем SQL запрос будет выполнен чтобы предотвратить атаки SQL injection. Это может быть удобно выполнено с помощью метода prepare, который поддерживает как sprintf()-подобный, так и vsprintf()-подобный синтаксис.
Обратите внимание: По состоянию на версию 3.5, wpdb::prepare() навязывает минимум 2 аргумента. [подробная информация]
<?php $sql = $wpdb->prepare( 'query' , value_parameter[, value_parameter ... ] ); ?>
%s и %d. Другие % символы могут вызвать ошибку обработки, если они не экранированы. Все символы % внутри строкового литерала SQL, включая LIKE шаблоны, должны быть продублированы(%%).Add Meta key => value pair "Harriet's Adages" => "WordPress' database interface is like Sunday Morning: Easy." to Post 10.
$metakey = "Harriet's Adages";
$metavalue = "WordPress' database interface is like Sunday Morning: Easy.";
$wpdb->query( $wpdb->prepare(
"
INSERT INTO $wpdb->postmeta
( post_id, meta_key, meta_value )
VALUES ( %d, %s, %s )
",
10,
$metakey,
$metavalue
) );
Performed in WordPress by add_meta().
The same query using vsprintf()-like syntax.
$metakey = "Harriet's Adages";
$metavalue = "WordPress' database interface is like Sunday Morning: Easy.";
$wpdb->query( $wpdb->prepare(
"
INSERT INTO $wpdb->postmeta
( post_id, meta_key, meta_value )
VALUES ( %d, %s, %s )
",
array(
10,
$metakey,
$metavalue
)
) );
Note that in this example we pack the values together in an array. This can be useful when we don't know the number of arguments we need to pass until runtime.
Notice that you do not have to worry about quoting strings. Instead of passing the variables directly into the SQL query, use a %s placeholder for strings and a %d placedolder for integers. You can pass as many values as you like, each as a new parameter in the prepare() method.
Attention: You can't pass integers/numbers that have comma values via %d. If you need comma values, use %s instead.
You can turn error echoing on and off with the show_errors and hide_errors, respectively.
<?php $wpdb->show_errors(); ?>
<?php $wpdb->hide_errors(); ?>
You can also print the error (if any) generated by the most recent query with print_error.
<?php $wpdb->print_error(); ?>
Note: If you are running WordPress Multisite, you must define the DIEONDBERROR constant for database errors to display like so:
<?php define( 'DIEONDBERROR', true ); ?>
You can retrieve information about the columns of the most recent query result with get_col_info. This can be useful when a function has returned an OBJECT whose properties you don't know. The function will output the desired information from the specified column, or an array with information on all columns from the query result if no column is specified.
<?php $wpdb->get_col_info('type', offset); ?>
You can clear the SQL result cache with flush.
<?php $wpdb->flush(); ?>
This clears $wpdb->last_result, $wpdb->last_query, and $wpdb->col_info.
If you are using Multi-Site, you also have access to the following:
The WordPress database tables are easily referenced in the wpdb class.
These tables are used only in multisite installations.