run_query
(CDBT 2.0.7)
run_query任意のSQLクエリを実行します
Description
mixed run_query ( string $query [, string $api"wpdb" ] )任意のSQLクエリを実行します。クエリの実行結果を返します。複雑なクエリ等を実行するのに適したメソッドです。バージョン2.0.7からはMySQLデータベースを操作するAPIを選択できるようになりました。
Parameters
- query
- 実行するSQLクエリの文字列。
- api
- SQLクエリを実行するMySQLのAPI名。省略時は初期値である
$wpdb->query()をラップします。他にmysqliもしくはPDOを指定できます。バージョン2.0.7から追加されました。
Return
SQLクエリの実行結果が返ります。apiを省略した場合や、wpdbを指定した場合にはラップされる$wpdb->query()の実行結果として影響のあった行数が数値として返ります。apiにmysqliかPDOを指定した場合には、クエリ実行結果が連想配列として返ります。
クエリ実行に失敗した場合や、該当する結果がなかった場合にはFALSEが返ります。
0とFALSEの両方がクエリ実行結果になりえるため、戻り値の判定には厳密な比較演算子
===を使ってください。History
| バージョン | 内容 |
|---|---|
| 2.0.0 | CDBT v1の同名メソッドをリファクタリング。PROTECTEDメソッドのため利用不可 |
| 2.0.7 | PUBLICメソッドに変更。api引数を追加 |
Example
<?php
global $cdbt;
$result = $cdbt->run_query( "SELECT 'Hello, dear MySQL user!' AS _message FROM DUAL", "PDO" );
if ( $result !== false ) {
print_r( $result );
}
Reference
Related Codex
