関数の概要
add_option()は、WordPressで新しいオプション（設定値）をデータベースに追加するための関数です。既に存在するオプションの場合は何も行わず、新しいオプションのみ追加します。この関数は、テーマやプラグインで初期設定を保存する際に便利です。
パラメータの説明
add_option()関数は3つのパラメータを受け取ります。
$option(string, 必須): 追加するオプション名。WordPressデータベース内で保存されるオプションのキー。$value(mixed, オプション): 追加するオプションの値。デフォルトは空の文字列です。$deprecated(string, オプション): 旧バージョンのWordPressで使用されていたが、現在は使用されていないパラメータ。デフォルトは空の文字列です。$autoload(string|bool, オプション): ‘yes’の場合、オプションはすべてのページロード時に自動的に読み込まれます。デフォルトは’yes’です。
使用例
以下は、add_option()関数を使用してカスタムオプションを追加する例です。
<?php
// カスタムオプション 'my_custom_option' に値 'my_custom_value' を追加する
$option_name = 'my_custom_option';
$option_value = 'my_custom_value';
if (add_option($option_name, $option_value)) {
echo '<p>Option added successfully.</p>';
} else {
echo '<p>Option already exists or could not be added.</p>';
}
?>オートロードを無効にしてオプションを追加する例
<?php
// カスタムオプション 'my_custom_option' に値 'my_custom_value' を追加し、オートロードを無効にする
$option_name = 'my_custom_option';
$option_value = 'my_custom_value';
$autoload = 'no';
if (add_option($option_name, $option_value, '', $autoload)) {
echo '<p>Option added successfully with autoload disabled.</p>';
} else {
echo '<p>Option already exists or could not be added.</p>';
}
?>関連する関数
get_option(): 特定のオプション値を取得します。update_option(): 既存のオプションの値を更新します。delete_option(): オプションを削除します。get_theme_mod(): テーマカスタマイザーの設定値を取得します。set_theme_mod(): テーマカスタマイザーの設定値を更新します。
使用上の注意
add_option()関数は、指定されたオプションが既に存在する場合は何も行わないため、追加する前にオプションが存在しないことを確認する必要はありません。- オプション名は一意である必要があり、他のプラグインやテーマと衝突しないように名前を工夫することが重要です。
- オートロードを無効にする場合、オプションは必要なときに手動で読み込む必要があります。これは、サイトのパフォーマンスを最適化するのに役立ちます。
