cdbt_crud_get_data_sql

(CDBT 2.0.0)

cdbt_crud_get_data_sqlget_data メソッドのSQLクエリをフィルターします

Description

string cdbt_crud_get_data_sql ( string $sql [, string $table_name, array $sql_clauses ] )
get_data()メソッドでデータ取得用に発行されたSQLクエリをフィルターします。このフィルターフックを利用することで、データ取得直前のSQLをカスタマイズできます。

Parameters

sql
データ取得用のSQLクエリ文字列を参照します。
table_name
データ取得先のテーブル名を参照できます。
sql_clauses
SQLクエリの各要素句参照用の配列です。

参照用配列の要素構成は下記のようになっています。
array (
  [0] => select_clause, // 取得するカラム名の文字列
  [1] => where_clause, // データ取得条件の文字列もしくは（UNIONで結合されるSELECT文の）配列
  [2] => order_clause, // ORDER BY句の文字列
  [3] => limit_clause // LIMIT値
)

History

バージョン 内容
2.0.0 新規追加

Example

<?php
function custom_filter_get_data_sql( $sql, $table_name, $sql_clauses ) {
  if ( 'specific_table' === $table_name ) {  
    // Do as you like.
  }
  return $sql;
}
add_filter( 'cdbt_crud_get_data_sql', 'custom_filter_get_data_sql', 10, 3 );

Hook Point

  • get_data()指定のテーブルから任意のデータを取得します

Reference

Related Methods

  • find_data()指定されたキーワードを含むデータを検索します

Related Hooks