- Custom DataBase Tables
- CDBT Version 2.x
- メソッド・リファレンス
- duplicate_table
duplicate_table
(CDBT 2.0.0)
duplicate_table複製テーブルを作成します
Description
bool duplicate_table ( string $replicate_table, bool $duplicate_with_dataTRUE, string $origin_table )指定テーブルの複製テーブルを作成します。テーブル複製に成功した場合、
duplicate_table()はTRUEを返します。Parameters
- replicate_table
- 複製テーブルとして新たに作成するテーブル名。
- duplicate_with_data
- テーブルデータの複製を行うかどうかのフラグ。初期値はTRUEで、FALSEの場合はテーブル作成時にデータの複製を行わない。
- origin_table
- 複製元となるテーブル名。
Return
テーブルの複製に成功した場合にTRUEを、複製に失敗した場合にはFALSEを返します。
複製テーブルと同名のテーブルがすでに存在していた場合や、複製元のテーブルがない場合は複製に失敗します。
History
| バージョン | 内容 |
|---|---|
| 2.0.0 | 新規追加 |
Example
<?php
if ( ! is_admin() ) {
global $cdbt;
if ( $cdbt->duplicate_table( 'copy_table', true, 'origin_table' ) ) {
echo "The table duplication was successfully.";
} else {
echo "The table duplication was failed.";
}
}
Caution
このメソッド経由で複製されたテーブルはプラグインの管理外となります。複製テーブルを管理したい場合は、プラグインの管理画面よりテーブル作成を行って、既存テーブルを取り込むを実行してください。
Included Hooks
- cdbt_after_table_duplicatedテーブルの複製後にフックします