プラグイン - Creating Tables with Plugins - 《WordPress開発者リソース》日本語

データベーステーブルの作成
関数の呼び出し
アップグレード関数の追加
リソース

データベーステーブルの作成

プラグインがデータベーステーブルを自動的に作成するための最初のステップは、プラグイン内にテーブルをWordPress MySQL/MariaDBデータベースに追加するPHP関数を作成することです。本記事の目的のために、この関数をjal_installと呼ぶことにします。

データベーステーブルプレフィックス

wp-config.phpファイル内で、WordPressサイトの所有者はデータベーステーブルのプレフィックスを定義できます。デフォルトでは、プレフィックスは「wp_」ですが、実際の値を確認し、それを使用してデータベーステーブル名を定義する必要があります。この値は、$wpdb-
>prefix変数にあります。（WordPress 2.0より古いバージョンの開発を行っている場合は、$table_prefixグローバル変数を使用する必要がありますが、これはバージョン2.1で非推奨です）。

したがって、(prefix)liveshoutboxというテーブルを作成したい場合、テーブル作成関数の最初の数行は次のようになります：

function jal_install () {
   global $wpdb;
   $table_name = $wpdb->prefix . "liveshoutbox";
}

テーブルの作成または更新

次のステップは、実際にデータベーステーブルを作成することです。SQLクエリを直接実行するのではなく、wp-admin/includes/upgrade.phpのdbDelta関数を使用します（このファイルはデフォルトで読み込まれないため、読み込む必要があります）。dbDelta関数は、現在のテーブル構造を調べ、希望するテーブル構造と比較し、必要に応じてテーブルを追加または変更しますので、更新に非常に便利です（dbDeltaの使用方法の詳細については、wp-admin/upgrade-schema.phpを参照してください）。ただし、dbDelta関数はかなり厳密です。例えば：

SQL文の各フィールドは独自の行に置く必要があります。
PRIMARY KEYとプライマリキーの定義の間には2つのスペースが必要です。
同義語INDEXではなく、KEYというキーワードを使用し、少なくとも1つのKEYを含める必要があります。
KEYの後には1つのスペース、その後にキー名、スペース、フィールド名を含む開き括弧、閉じ括弧が続く必要があります。
フィールド名の周りにアポストロフィやバックティックを使用してはいけません。
フィールドタイプはすべて小文字でなければなりません。
CREATE TABLEやUPDATEなどのSQLキーワードは大文字でなければなりません。
長さパラメータを受け入れるすべてのフィールドの長さを指定する必要があります。例えば、int(11)です。

これらの注意点を考慮して、次の行は実際にテーブルを作成または更新する関数の一部です。$sql変数に自分のテーブル構造を代入する必要があります：

global $wpdb;
$charset_collate = $wpdb->get_charset_collate();
$sql = "CREATE TABLE $table_name (
  id mediumint(9) NOT NULL AUTO_INCREMENT,
  time datetime DEFAULT '0000-00-00 00:00:00' NOT NULL,
  name tinytext NOT NULL,
  text text NOT NULL,
  url varchar(55) DEFAULT '' NOT NULL,
  PRIMARY KEY  (id)
) $charset_collate;";
require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
dbDelta( $sql );

注意： 上記では、テーブルのデフォルトの文字セットと照合順序を設定しました。これを行わないと、一部の文字がテーブルに保存される際に?に変換される可能性があります。この例では、$wpdb-
>get_charset_collate()を使用して文字セットと照合順序を取得します。この関数はWordPress 3.5で導入され、以前のバージョンをサポートする必要がある場合は、charset/collate文字列を自分で作成する必要があります（その関数のソースをコピーすることができます）。

初期データの追加

最後に、作成したテーブルにデータを追加したい場合があります。以下はその方法の例です：

$welcome_name = 'Mr. WordPress';
$welcome_text = 'Congratulations, you just completed the installation!';
$table_name = $wpdb->prefix . 'liveshoutbox';
$wpdb->insert(
    $table_name,
    array(
        'time' => current_time( 'mysql' ),
        'name' => $welcome_name,
        'text' => $welcome_text,
    )
);

注意： WPDBの使用については、wpdbクラスを参照してください。 この場合、$wpdb-
>insertを使用しているため、データは自動的にエスケープされます。$wpdb-
>queryのような別のメソッドを使用する必要がある場合は、セキュリティ上の問題を防ぐために、クエリをデータベースに渡す前に$wpdb-
>prepare関数を通して変数を実行することをお勧めします。たとえこの関数内で$welcome_nameと$welcome_textを定義し、それらにSQLの特殊文字が含まれていないことを知っていても。

バージョンオプション

別の優れたアイデアは、データベーステーブル構造のバージョン番号を記録するオプションを追加することです。これにより、テーブルを更新する必要がある場合にその情報を後で使用できます：

add_option( "jal_db_version", "1.0" );

全体の関数

この関数は完成しました。一つの部分としてすべてを見てみましょう。バージョン番号は現在、グローバル変数に保存されています。

<?php
global $jal_db_version;
$jal_db_version = '1.0';
function jal_install() {
    global $wpdb;
    global $jal_db_version;
    $table_name = $wpdb->prefix . 'liveshoutbox';
    $charset_collate = $wpdb->get_charset_collate();
    $sql = "CREATE TABLE $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        time datetime DEFAULT '0000-00-00 00:00:00' NOT NULL,
        name tinytext NOT NULL,
        text text NOT NULL,
        url varchar(55) DEFAULT '' NOT NULL,
        PRIMARY KEY  (id)
    ) $charset_collate;";
    require_once ABSPATH . 'wp-admin/includes/upgrade.php';
    dbDelta( $sql );
    add_option( 'jal_db_version', $jal_db_version );
}
function jal_install_data() {
    global $wpdb;
    $welcome_name = 'Mr. WordPress';
    $welcome_text = 'Congratulations, you just completed the installation!';
    $table_name = $wpdb->prefix . 'liveshoutbox';
    $wpdb->insert(
        $table_name,
        array(
            'time' => current_time( 'mysql' ),
            'name' => $welcome_name,
            'text' => $welcome_text,
        )
    );
}

関数の呼び出し

初期化関数が定義されたので、WordPressがプラグインがWordPress管理者によってアクティブ化されたときにこの関数を呼び出すことを確認したいと思います。そのために、activate_アクションフックを使用します。プラグインファイルがwp-content/plugins/plugindir/pluginfile.phpの場合、プラグインの本体に次の行を追加します：

register_activation_hook( __FILE__, 'jal_install' );
register_activation_hook( __FILE__, 'jal_install_data' );

詳細については、Function_Reference/register_activation_hookを参照してください。

アップグレード関数の追加

プラグインのライフサイクルの中で、プラグインのデータベース構造をアップグレード版で変更する必要があることがわかるかもしれません。そのためには、新しいバージョンがインストールされたことを検出し、データベース構造をアップグレードするコードをプラグイン内に作成する必要があります。最も簡単な方法は、先ほど作成したjal_install関数にコードを追加することです。

したがって、上記の関数がプラグインのデータベースバージョン1.0を作成するために使用されたと仮定し、URLフィールドを広くするために（55文字ではなく100文字）バージョン1.1にアップグレードしているとします。必要な場合は、jal_install関数の最後に次の行を追加して、バージョンを確認し、必要に応じてアップグレードします：

<?php
global $wpdb;
$installed_ver = get_option( "jal_db_version" );
if ( $installed_ver != $jal_db_version ) {
    $table_name = $wpdb->prefix . 'liveshoutbox';
    $sql = "CREATE TABLE $table_name (
        id mediumint(9) NOT NULL AUTO_INCREMENT,
        time datetime DEFAULT '0000-00-00 00:00:00' NOT NULL,
        name tinytext NOT NULL,
        text text NOT NULL,
        url varchar(100) DEFAULT '' NOT NULL,
        PRIMARY KEY  (id)
    );";
    require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
    dbDelta( $sql );
    update_option( "jal_db_version", $jal_db_version );
}

また、ファイルの先頭でグローバル$jal_db_version変数を変更する必要があり、もちろん、上記で作成した初期化セクションを新しいテーブル構造を使用するように変更したいと思います。

3.1以降、register_activation_hook()で登録されたアクティベーション関数は、プラグインが更新されたときに呼び出されません。したがって、プラグインがアップグレードされた後に上記のコードを実行するには、別のフックでプラグインのデータベースバージョンを確認し、データベースバージョンが古い場合は関数を手動で呼び出す必要があります。次のように：

function myplugin_update_db_check() {
   global $jal_db_version;
   if ( get_site_option( 'jal_db_version' ) != $jal_db_version ) {
   jal_install();
   }
}
add_action( 'plugins_loaded', 'myplugin_update_db_check' );

リソース

プラグイン開発に関するさらなる情報は、Plugin Handbookをチェックしてください。これはプラグインリソースの包括的なリストです。また、wp-hackers mailing listからのこの投稿も役立つかもしれません：WordPress Hackers Mailing List: Answer to Plugin Requires Additional Tables。また、Post meta vs separate database tablesも参照してください。