- Custom DataBase Tables
- CDBT Version 2.x
- メソッド・リファレンス
- drop_table
drop_table
(CDBT 2.0.0)
drop_table指定のテーブルを削除します
Description
bool drop_table ( string $table_name )指定のテーブルを削除します。削除に成功した場合、
drop_table()はTRUEを返します。警告:
drop_table()で削除されたテーブルは復旧できません。削除処理の事前確認もないため、このメソッドを使用してのテーブル削除時は十分にご注意ください。Parameters
- table_name
- 削除するテーブル名。
Return
テーブルの削除に成功した場合にTRUEを、削除できなかった場合にFALSEを返します。
History
| バージョン | 内容 |
|---|---|
| 2.0.0 | CDBT v1の同名メソッドをリファクタリング |
Example
<?php
global $cdbt;
$table_name = "prefix_table";
if ( $cdbt->drop_table( $table_name ) ) {
echo "The table of $table_name was complete removed.";
} else {
echo "The $table_name deletion was failed.";
}
Included Hooks
- cdbt_after_table_droppedテーブルの削除後にフックします
Reference
Related Methods
- truncate_table()テーブルに含まれる全データを削除します
- delete_data()指定したデータを削除します