プラグインの開発を行うことで、あらゆるテーマで利用できる機能を提供することができます。

プラグインについては、ソースで理解するWordPressの起動処理１にて読込個所を確認しています。

// Load active plugins.
foreach ( wp_get_active_and_valid_plugins() as $plugin ) {
	wp_register_plugin_realpath( $plugin );
	include_once $plugin;

	/**
	 * Fires once a single activated plugin has loaded.
	 *
	 * @since 5.1.0
	 *
	 * @param string $plugin Full path to the plugin's main file.
	 */
	do_action( 'plugin_loaded', $plugin );
}
unset( $plugin );

プラグインを作成する

プラグインの作成はwp-content\pluginsフォルダにて行います。

ハローワールドとかではあるあるな気がしますので、好きなアニメのリストを登録するようなプラグインを作成します。

プラグインを認識させる

AnimeList.phpを作ったら以下のように記載します。

<?php
/**
 * Plugin Name: AnimeList
 */
class AnimeList {

    function __construct()
    {
        register_activation_hook( __FILE__, array($this, 'init' ) );
    }

    function init()
    {
        wp_die("OK","プラグインが有効化になりました。");
    }
}

// インスタンス化してフックを登録しておきます。 
new AnimeList();

register_activation_hookはプラグインが有効化されたときに実行する関数を定義します。

クラスの関数を指定する際には配列にして$thisと関数名をいれてあげます。

プラグインを有効化するとwp_dieが実行されます。

管理画面にメニューを追加する

次に管理画面にメニューを追加します。管理画面に追加するにはadd_actionのadmin_menuに対してメニューページを追加する記載をした関数を指定します。

class AnimeList {

    function __construct()
    {
        register_activation_hook( __FILE__, array($this, 'init' ) );
        //追加
        add_action('admin_menu', array($this, 'anime_list_admin_page'));
    }

    function init()
    {
        // ここは削除
        //wp_die("OK","プラグインが有効化になりました。");
    }

    // admin_menuに登録される関数。
    function anime_list_admin_page(){
        add_menu_page('アニメリストの設定', 'アニメリスト設定', 'manage_options', 'anime_list', array($this,'add_anime_list_menu_page'), 'dashicons-admin-generic', 4);
    }

    //　メニューページに表示されるViewを定義。メニューページを表示する際に実行される関数
    function add_anime_list_menu_page()
    {
        ?>

        <div class="warp">
            <h2>アニメリスト設定</h2>
        </div>

        <?php
    }
}

add_menu_pageはメニューページを追加します。第５引数にメニューページを表示する際に実行される関数を指定します。

以下のようになっていればOKです。

値の保存

ワードプレスで値を保存したい場合はoptionを使うことが多いです。

まず順序としてはadmin_initにアクションを追加して、コールバック関数でregister_settingを実行します。ここで保存するkey情報を設定しておきます

フォームではsettings fields メソッドを利用してNonceなどのhidden項目を生成します。

get_option(“key”)とすることで値を取得できます。

<?php
/**
 * Plugin Name: AnimeList
 */
class AnimeList {

    function __construct()
    {
        register_activation_hook( __FILE__, array($this, 'init' ) );
        add_action('admin_menu', array($this, 'anime_list_admin_page'));
        // 追加
        add_action('admin_init',  array($this, 'register_animelist_setting'));
    }

    function init()
    {
        // ここは削除
        //wp_die("OK","プラグインが有効化になりました。");
        
    }

    // admin_menuに登録される関数。
    function anime_list_admin_page(){
        add_menu_page('アニメリストの設定', 'アニメリスト設定', 'manage_options', 'anime_list', array($this,'add_anime_list_menu_page'), 'dashicons-admin-generic', 4);
    }

    //　メニューページに表示されるViewを定義。メニューページを表示する際に実行される関数
    function add_anime_list_menu_page()
    {

        echo '<div class="warp">';
            echo '<h2>アニメリスト設定</h2>';
            echo '<form method="post" action="options.php">';
                // Nonceなどのhidden項目を生成します。
                settings_fields('my-plugin-settings-group');
               echo '<input type="text" name="animelist" id="animelist" value="' . esc_attr(get_option("animelist")) . '">';
                // 保存用のボタンを出力します。
                submit_button();
            echo '</form>';
        echo '</div>';

    }

    function register_animelist_setting()
    {
        register_setting('my-plugin-settings-group', 'animelist');
    }
}

new AnimeList();

上記のコードだけで値の保存等までを実行できます

DBにもレコードが登録されています。

settings_fields

settings_fieldsはhidden項目および、nonceの作成を行います

function settings_fields( $option_group ) {
	echo "<input type='hidden' name='option_page' value='" . esc_attr( $option_group ) . "' />";
	echo '<input type="hidden" name="action" value="update" />';
	wp_nonce_field( "$option_group-options" );
}

nonceはlaravelでいうところの@csrfみたいなものですね。

submit_button

定義としては以下のようになっています

function submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = null ) {
	echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );
}

ここで利用するget_submit_buttonというのがボタンの要素を作成して返却しています。

$name_attr = $name ? ' name="' . esc_attr( $name ) . '"' : '';
	$id_attr   = $id ? ' id="' . esc_attr( $id ) . '"' : '';

	$button  = '<input type="submit"' . $name_attr . $id_attr . ' class="' . esc_attr( $class );
	$button .= '" value="' . esc_attr( $text ) . '" ' . $attributes . ' />';

	if ( $wrap ) {
		$button = '<p class="submit">' . $button . '</p>';
	}

	return $button;

get_option

テーブルから取得する記載があります。

$row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );

get_optionの引数にはoption_nameを渡していますので感覚的にも処理が掴めると思います。

WordPressでプラグイン開発をする