通常のテーマ作成ではデータベースに対して手を加えることは通常しませんが、プラグイン開発をすると独自のテーブルを作成することもあります。

今回は、データベースにテーブルを追加してみます。通常はプラグインを有効化したときにデータベースに対してテーブル追加、無効化したときにテーブルの削除を行います。

と、いってもワードプレスのマニュアルにプラグインでデータベーステーブルを作るという素晴らしい記事があるので、こちらの記事を参考にしつつ、簡単なアクセスカウンターを作っていきます。

テーブル名

テーブル名は以下のようにします

pagecounter

ワードプレスのテーブルにはwp_というようなプレフィックスがついていますが以下のようにしてあげるとプレフィックスを取得できるようです

$table_name = $wpdb->prefix . "pagecounter";

どのようにしてテーブルを作成するのか

とあります。なのでデータベースを操作する際にはdbDelta関数を利用します。

ここまでの情報で以下のようなプラグインを定義しました。有効化したときにテーブルの作成、無効化したときにテーブルの削除を行います。

function __construct()
    {
        register_activation_hook( __FILE__, array($this, 'activation' ) );
        register_deactivation_hook( __FILE__, array($this,'deactivation') );
    }

    function activation()
    {
        // データベースオブジェクトを使用する
        global $wpdb;

        $charset_collate = $wpdb->get_charset_collate();
        $table_name = $wpdb->prefix . "pagecounter"; 

        $sql = "CREATE TABLE $table_name (
            id mediumint(9) NOT NULL AUTO_INCREMENT,
            date date NOT NULL,
            uri varchar(190) NOT NULL,
            count int(11) NOT NULL,
            KEY url (uri),
			KEY date (date),
            UNIQUE KEY id (date,uri),
            PRIMARY KEY (`id`)
          ) $charset_collate;";
          
          require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
          dbDelta( $sql );

    }

    function deactivation()
    {
        global $wpdb;
        $wpdb->query('DROP TABLE IF EXISTS ' . $wpdb->prefix . 'pagecounter');
    }

ユニークキーとプライマリキーの違い

プライマリキーは重複した値を入れることができない
ユニークキーは重複に対してルールを付けられる、どのカラムとどのカラムのセットが重複してはいけない。のように

今回の場合は、idが重複することは許されない、また同じdateとuriのセットで重複することは許されない。

カウント機能

次に前記事の内容を踏まえてアクセスカウンターを作ります。

カウント対象のレコードの存在チェックをして、インサートかアップデートか処理をわけます。

selectとinsertとupdateを利用するのですが、またドキュメントに参考となる記事があります。

まずはインサートだけする機能を作ります。

function __construct()
    {
        register_activation_hook( __FILE__, array($this, 'activation' ) );
        register_deactivation_hook( __FILE__, array($this,'deactivation') );
        add_action('wp',  array($this, 'countaccess'));
    }

    function countaccess()
    {
        global $wpdb;
        // 今日日付
        $today = date("Y-m-d");
        // パラメータ
        $data = array(
            'date' => $today,
            'uri' => "test1",
            'count' => 1,
        );
        // インサート実行
        $wpdb->insert($wpdb->prefix . 'pagecounter', $data);
        
    }

wpのフックが発火されるようなアクセスをすると、データベースにレコードがインサートされますが、現状では２回目のアクセスでユニークキーの制約でエラーになります。

しかしいとも簡単にインサートができることを確認しました。

次にアップデート機能を作ります。

ポイントはレコードが存在する場合はカウントをインクリメントしてアップデートするので、selectした結果で判定してupdateに回すという処理になっている点です。

function countaccess()
    {

        global $wpdb;
        // 今日日付
        $today = date("Y-m-d");

        // パラメータの作成
        $data = array("date" => date("Y-m-d"), "uri" => "none", "count" => 1);

        if (is_singular()) {
            $data['uri'] = 'post' . get_queried_object_id();
        }

        if (is_page()) {
            $data['uri'] = 'page' . get_queried_object_id();
        }

        if($data['uri'] === "none")
        {
            return;
        }

        // 既存レコードの取得
        $exist = $wpdb->get_row(
            "SELECT * FROM " . $wpdb->prefix . "pagecounter" . " WHERE date = '" . $data["date"] . "'" . " AND uri = '" . $data['uri'] . "';");
    
        if($exist !== null)
        {
            $data["count"] = $exist->count + 1;
            $wpdb->update(
                $wpdb->prefix . 'pagecounter', 
                $data, 
                array("id" => $exist->id));
        } else {
            $wpdb->insert($wpdb->prefix . 'pagecounter', $data);
        }

    }

1つの関数に複数の処理を押し込んでいますが、機能の実装はできました。

また、データベース操作はセキュリティの意識も持たないといけないのですが、その辺は公式ドキュメントに目を通しておきます。

WordPressでアクセスカウンタープラグインを自作してDB操作を学ぶ