get_table_list

(CDBT 2.0.0)

get_table_listデータベース内のテーブル一覧を取得します

Description

mixed get_table_list ( [ string $narrow_type"all" ] )
データベース内のテーブル一覧を取得します。取得できた場合、get_table_list()はテーブル名の配列を返します。

Parameters

narrow_type
取得するテーブル一覧を絞り込むためのキー名。キー名には以下の値が指定可能です。

絞り込みキー:

  • all ─ 絞り込みは行わず、すべてのテーブルを取得します。初期値です。
  • enable ─ プラグインで現在管理可能なテーブルのみを取得します。
  • unreserved ─ WordPressのシステムで組み込まれるコアテーブル以外のすべてのテーブルを取得します。
  • unmanageable ─ プラグインで管理対象になっていないテーブルを取得します。
enableキーで絞り込んだ取得テーブルにはWordPressコアテーブルは含まれません。

Return

テーブル一覧が取得できた場合にテーブル名の配列を返します。取得できなかった場合や、絞り込みに合致するテーブルがなかった場合はFALSEを返します。

History

バージョン 内容
2.0.0 CDBT v1の同名メソッドをリファクタリング

Example

例1 すべてのテーブルを取得する。

<?php
global $cdbt;
$all_tables = $cdbt->get_table_list();
print_r( $all_tables );

例2 現在プラグインで管理可能となっているテーブル一覧を取得する。

<?php
global $cdbt;
$enabled_tables = $cdbt->get_table_list( "enable" );
if ( $enabled_tables ) {
  print_r( $enabled_tables );
}

Reference

Related Methods