- Custom DataBase Tables
- CDBT Version 2.x
- アクションフック一覧
- cdbt_after_data_deletion
cdbt_after_data_deletion
(CDBT 2.0.0)
cdbt_after_data_deletionデータ削除処理後にフックします
Description
cdbt_after_data_deletion ( bool $result [, string $table_name, array $where_data ] )delete_data()メソッドでのデータ削除処理後にフックします。このアクションフックを利用することで、特定テーブルへのデータ削除処理の後に独自の処理を追加できます。例えば、特定テーブルへのデータ削除後に外部キーで連携しているテーブルのデータも同時に削除するようなカスタマイズができるようになります。
Parameters
- result
- データ削除処理の結果を参照できます。データ削除成功時にTRUE、削除に失敗した場合はFALSEとなります。
- table_name
- データを削除したテーブル名を参照できます。
- where_data
- 削除したデータの絞り込み条件の配列を参照できます。バージョン2.0.6まではハッシュ形式の文字列でしたが、バージョン2.0.7以降はカラム名をキーとした連想配列に変更されました。
History
| バージョン | 内容 |
|---|---|
| 2.0.0 | 新規追加 |
| 2.0.7 | where_dataの値を配列に変更 |
Example
<?php
function custom_action_after_deletion( $result, $table_name, $where_data ) {
if ( $result && "prefix_table" === $table_name ) {
// Do as you like.
}
}
add_action( "cdbt_after_data_deletion", "custom_action_after_deletion", 10, 3 );
Hook Point
- delete_data()指定したデータを削除します
Reference
Related Hooks
- cdbt_after_table_truncatedテーブルの全データ削除後にフックします
- cdbt_after_table_droppedテーブルの削除後にフックします