WordPressのテーマやプラグイン開発を行っている際、独自設定を保存しておきたい場合があります。
変更がないリソースデータなら定数で持たせておけばよいですが、ユーザーによって変更が行われる可能性がある場合は、データベースに保存しておきたいですよね。

そこで、WordPressに標準で存在しているwp_optionsに設定を追加し、呼び出して使う方法をご紹介します。

wp_optionsに設定を保存する時はadd_option()

wp_optionsに設定を追加するにはadd_option関数を利用します。

<?php
// 設定例
add_option("custom_option", "value");
?>

第一引数には設定値の名前を、第二引数には設定値を設定します。
この関数を実行すると、wp_optionsにデータが保存されます。

add_optionに配列データを代入して保存すると、配列データがシリアライズされて保存されます。

<?php
// 保存する配列データ
$array_data = array(
    "name" => "example",
    "email" => "info@example.com",
    "age" => 25
);

// 配列を保存した場合
add_option("custom_option", $array_data);
?>

wp_optionsに保存したデータを更新する場合はupdate_option()

add_option()で追加したデータを更新する場合はupdate_option()を使用します。
使い方はadd_option()と同じです。

<?php
// 保存する配列データ
$array_data = array(
    "name" => "example",
    "email" => "info@example.com",
    "age" => 25
);

// 配列を保存した場合
update_option("custom_option", $array_data);
?>

こちらは同名の設定が無ければ追加し、既に設定が存在している場合には更新をしてくれるため、add_option()など使用せず、最初からこちらを使うことができ、むしろその方がオススメです。

wp_optionsに保存した設定を呼び出す時はget_option()

設定したoptionデータを呼び出す時はget_option関数を利用します。

<?php
// wp_optionsから情報を取得する
$option_setting = get_option('option_name');

echo $option_setting;
?>

配列で保存した場合でも、同様の呼び方で、配列形式で変数を取得できます。

<?php
// wp_optionsから情報を取得する
$option_setting = get_option('option_name');

echo $option_setting["name"];
?>

すごい簡単ですね。

テーマやプラグインなどを開発する際、そのテーマやプラグイン専用のテーブルを作っても良いのですが、データの量が多くない場合やデータ形式がバラバラな時は、wp_optionsにデータを保存しておくのがオススメです。