WordPressプラグイン開発！スニペットから始めるカンタン開発・処理のフック～アンインストール時の処理まで

設定メニュー画面を作成する

プラグインによっては、ユーザーに何か設定をしてもらって、その設定値によって処理を変えたい、ということがあるかと思います。

まずは、ユーザーに値を設定してもらう「画面」を作成しましょう。
こういう画面です。

画面を作るソースがこちら。

function __construct() {
    add_action( 'admin_menu', array( $this , 'add_menu' ) );
}

/*****
admin_menuにフックした処理。設定画面へのリンクをメニューに追加する
Process that hooked to "admin_menu". Add a link to the setting view to the menu.
*****/
function add_menu(){
    $page = add_management_page( $this->lang['plugin_name'], $this->lang['plugin_name'], 'manage_options', self::MENU_SLUG, array($this,'show_menu') );

    // 設定画面でのみ読み込むCSSファイル
    // css file that read only at setting view.
    add_action( 'admin_print_styles-' . $page, array( $this , 'enque_setting_style' ) );
}

/*****
設定画面のみ有効にするCSSファイルを読み込み
css file that read only at setting view.
*****/
function enque_setting_style(){
    wp_enqueue_style( self::SETTINGSTYLE_SLUG , plugins_url(self::SETTINGSTYLE_PATH , __FILE__));
}

/*****
設定画面のHTMLを作成、表示する関数
*****/
function show_menu(){
    ?>
        <!-- 設定画面のHTMLを書く -->
        <h2><?php echo $this->lang['plugin_name'] . " " . $this->lang['setting_page']; ?></h2>
    <?php
}

管理画面左側のメニューに、設定画面へのリンクを作成するには、
「admin_menu」アクションフックを使います。

そこで呼び出されたコールバック関数の中で
add_management_page()を使えば、「ツール」メニューの中に、自前のリンクを作ることができます。

そして、add_management_page()からコールバックされる関数の中で、設定画面のHTMLを出力する処理を書けば完成です。

公式サイトで詳細を知りたい方は、こちら。
管理メニュー追加に関する公式Wiki

設定画面から、オプションをDBに保存する

で、設定画面でユーザーに入力してもらったデータをDBに保存して、その値をいろいろと使いまわす、ということをやりたい。

WordPressに保存する設定値をオプションと呼びますが、そのオプションをDBに保存する処理はこんな感じ。

private static $option_grp = 'prefix_my_option_grp';
private static $option_param = [
    //お好みのキー => DBに保存されるオプション名
    //any key name => Option name stored in DB
    'hoge' => 'prefix_my_option_name_hoge',
    'moge' => 'prefix_my_option_name_moge'
];

function __construct() {
    add_action( 'admin_init', array( $this , 'setting_init' ) );
}

/*****
admin_initにフックする処理
Process that hooked to "admin_init".
*****/
function setting_init(){
    foreach( self::$option_param as $key => $val ){
        register_setting( self::$option_grp, $val );
    }
}

function show_menu(){
    ?>
        <h2><?php echo $this->lang['plugin_name'] . " " . $this->lang['setting_page']; ?></h2>
        <form method="post" action="options.php">
            <?php settings_fields( self::$option_grp ); ?>
            <?php do_settings_sections( self::$option_grp ); ?>
            <hr>

            <!-- ここに好きなform部品を追加する -->
            <!-- Please add any form parts here -->
            <input type="text" name="<?php echo self::$option_param['hoge']; ?>" value="<?php echo esc_attr(get_option( self::$option_param['hoge'] , "" )); ?>">

            <?php submit_button(); ?>
        </form>
    <?php
}

まず、admin_initにフックしたsetting_init()内で、register_settingを実行します。

これは、各オプションの名前と、オプションのグループ名を決めておいて、それをWordPressに「覚えといてね！」という処理です。

$option_paramを連想配列にしているので、’hoge’というのは、ただの配列のキーです。大事なのはその中身。’prefix_my_option_name_hoge’というオプション名がWordPressに記憶しておいてもらえます。

で、設定画面のHTMLを書く中で、

<form method="post" action="options.php">
<?php settings_fields( self::$option_grp ); ?>
<?php do_settings_sections( self::$option_grp ); ?>
</form>

とすることで、さっきの$option_grp名で記憶したオプションを使うよ！という宣言をします。

そして、form部品として

<input type="text" name="<?php echo self::$option_param['hoge']; ?>" value="<?php echo esc_attr(get_option( self::$option_param['hoge'] , "" )); ?>">

のように、inputのname属性にオプション名を付けておくと、そこに入力された値が、「オプション名 = 値」の形でDBに書き込まれるようになります。

最後に

<?php submit_button(); ?>

を付けておくと、「設定を保存」ボタンが設置できます。

DBに記録されたオプションは、get_option()関数でオプション名を指定して取得できます。

サイトの拡張性を飛躍的に高める WordPressプラグイン開発のバイブル

posted with カエレバ

宮内 隆行,西川 伸一,岡本 渉,三好 隆之 SBクリエイティブ 2014-08-07

Amazon

楽天市場

7net

アンインストール時の削除処理

残念なことではありますが、このプラグインは使わない！もうアンインストールする！とユーザーに判断されてしまうこともあります。

先ほどのオプション、なにもしないとDBに残ったままになってしまいます。
オプション名にプレフィックスを付けるなどして唯一っぽい名前にしておけば、残っていたところで悪さをすることはないと思いますが、それでもやっぱりデータ容量を食ったりして、なんとなく気持ち悪い。

なので、アンインストール時にちゃんと削除処理をしておきましょう。

function __construct() {
    if(function_exists('register_uninstall_hook')) {
        register_uninstall_hook (__FILE__, array(get_class($this),'do_uninstall') );
    }
}

/*****
アンインストール時にoption値をDBから削除する関数
*****/
static function do_uninstall(){
    foreach( self::$option_param as $key => $val ){
        unregister_setting( self::$option_grp, $val );
        delete_option($val);
    }
}

register_uninstall_hook()で、アンインストール時の処理をフックできます。

ちなみに、クラス内にアンインストール処理を書く場合、フックする関数はstaticじゃないと動作しないようです。
もしくは、クラス内ではなくグローバルな関数として定義するか。

さりげなくオプショングループ名とオプション（$option_grp、$option_param）をstatic宣言していたのも、static関数の中で使いたかったからです。

いずれにせよ、これでアンインストール時の処理もできました。
めでたしめでたし。

まとめ

ということで、スニペットを使ってWordPressプラグインの処理の枠組みを書いてみました。

あとは、お好みのフックを使って、お好みの処理を書いていくだけです。
自分なりに便利なプラグインを作ってみてください！

それではまたー。

参考サイト：WordPressCodex「プラグインの作成」

エンジニアのためのWordPress開発入門 (Engineer’s Library)

posted with カエレバ

野島 祐慈,菱川 拓郎,杉田 知至,細谷 崇,枢木 くっくる 技術評論社 2017-01-26

Amazon

楽天市場

7net

よくわかるPHPの教科書 【PHP7対応版】 (教科書シリーズ)

posted with カエレバ

たにぐち まこと マイナビ出版 2018-04-26

Amazon

楽天市場

7net