delete_data

(CDBT 2.0.0)

delete_data指定したデータを削除します

Description

bool delete_data ( string $table_name, mixed $where_clause )
指定したデータを削除します。データの削除に成功した場合にはTRUEを返します。最終的なデリート処理はWordPressの$wpdb->delete()をラップしています。

Parameters

table_name
削除するデータが含まれるテーブル名。
where_clause
削除するデータの絞り込み条件。カラム名をキーとしたハッシュ形式の文字列で指定します。複数の条件を指定した場合はAND演算子で結合されます。バージョン2.0.7以降は連想配列での指定も可能になりました。

下記の絞り込み条件の記述は同一となります。
// 連想配列で指定
$where_clause = array(
  "column1" => "value1",
  "column2" => "value2"
);
// ハッシュ文字列で指定
$where_clause = "column1:value1,column2:value2";

Return

データの削除に成功した場合にTRUEが返ります。データ削除に失敗した場合や削除対象のデータが見つからなかった場合にはFALSEが返ります。

History

バージョン 内容
2.0.0 CDBT v1の同名メソッドをリファクタリング
2.0.7 where_clause引数に配列の指定を許可

Example

<?php
  global $cdbt;
  $table_name = "prefix_table";
  if ( $result = $cdbt->delete_data( $table_name, [ 'remove_flag' => true ] ) ) {
    print_r( $result );
  }
}

Reference

Related Methods

Related Codex