add_option()

Q: add_option() は何度も実行しても問題ないですか？

いいえ、既にオプションが存在する場合、何も処理されません。同じキーで値を変更したい場合は update_option() を使用してください。

Q: オプションの値に配列やオブジェクトを保存できますか？

はい、可能です。ただし、取得する際には get_option() を使って適切に展開する必要があります。

Q: autoload の設定を変更できますか？

はい、update_option() では autoload の変更ができませんが、delete_option() で削除後に add_option() で新しい autoload の設定を適用できます。

Function

2025/4/15 Tuesday

add_option() は、WordPress のオプションデータをデータベースに保存するための関数です。主にプラグインやテーマの設定情報を保存する際に使用されます。

この関数は、指定したオプションがデータベースに存在しない場合のみ新しいオプションを追加します。そのため、既存のオプションの更新には update_option() を使用する必要があります。

例えば、カスタム設定を保存したり、サイトの動作を変更するためのオプションを登録する場合に便利です。

機能の説明

add_option() は、WordPress の wp_options テーブルに新しいオプションを追加するための関数です。オプションが既に存在する場合は何も処理を行いません。主にプラグインやテーマの初期設定を登録する際に使用されます。

プラグインの初期設定を登録
テーマのカスタム設定を保存
サイトのカスタマイズ用データを保持

シンプルなコード例

add_option('custom_setting', 'default_value');

'custom_setting'：オプションのキー（名前）
'default_value'：オプションの値（初期値）

このコードを実行すると、wp_options テーブルに custom_setting というオプションが default_value という値で追加されます。

使い方の説明

以下のように、オプションに複数のパラメータを設定することができます。

add_option('custom_setting', 'default_value', 'カスタム設定の説明', 'yes');

引数の説明

$option（必須）：オプション名（キー）
$value（必須）：オプションの値
$deprecated（省略可）：使用されなくなった引数（現在は無視される）
$autoload（省略可）：yes または no を指定し、自動読み込みするかどうかを設定

自動読み込み (autoload) について

'yes'（デフォルト）：WordPress のロード時に自動的に取得
'no'：必要なときに get_option() で取得

例：配列データを保存する場合

add_option() では、配列もオプションとして保存できます。

$settings = array(
    'color' => 'blue',
    'size'  => 'large',
);

add_option('theme_settings', $settings);

保存したオプションを取得するには、get_option() を使用します。

$theme_settings = get_option('theme_settings');
echo $theme_settings['color']; // blue

一緒に使うことが多い関連タグ

update_option()

既に存在するオプションの値を更新する場合に使用します。

update_option('custom_setting', 'new_value');

get_option()

保存されたオプションの値を取得する関数です。

$value = get_option('custom_setting');
echo $value; // new_value

delete_option()

登録したオプションを削除する関数です。

delete_option('custom_setting');

追加情報で取得したい場合

すべてのオプションを一覧表示

データベースの wp_options テーブルに保存されたすべてのオプションを取得するには、以下の SQL クエリを使用します。

SELECT * FROM wp_options;

または、PHP を使ってすべてのオプションを取得することも可能です。

global $wpdb;
$options = $wpdb->get_results("SELECT * FROM $wpdb->options");
foreach ($options as $option) {
    echo $option->option_name . ': ' . $option->option_value . '<br>';
}

想定されるトラブル

`add_option()` で値が保存されない

既に同じオプションが存在している場合、add_option() は動作しません。

解決方法

update_option() を使用して値を更新する。

update_option('custom_setting', 'updated_value');

Q＆A

`add_option()` は何度も実行しても問題ないですか？

いいえ、既にオプションが存在する場合、何も処理されません。同じキーで値を変更したい場合は update_option() を使用してください。

オプションの値に配列やオブジェクトを保存できますか？

はい、可能です。ただし、取得する際には get_option() を使って適切に展開する必要があります。

`autoload` の設定を変更できますか？

はい、update_option() では autoload の変更ができませんが、delete_option() で削除後に add_option() で新しい autoload の設定を適用できます。

まとめ

add_option() は、WordPress にカスタム設定を追加するための関数です。

同じオプションが既に存在する場合は動作しないため、更新する場合は update_option() を使用します。

オプションを削除するには delete_option() を利用します。設定情報の保存やプラグインの動作管理など、さまざまな用途に活用できます。