get_option() の使い方|説明・引数・注意点

説明

get_option() は、オプションテーブル(wp_options)に保存された設定値を取得する関数です。

基本構文

get_option( string $option, mixed $default_value = false ): mixed

引数

  • $option:オプション名
  • $default_value:存在しなかったときに返す値

戻り値

保存されている値。存在しなければ $default_value。

使い方(サンプル)

echo esc_html( get_option( 'blogname' ) );

注意点

  • blogname(サイト名)や admin_email など、標準のオプションも取得できます。
  • 配列やオブジェクトは自動でシリアライズ・復元されます。
  • 値が空文字や 0 でも、存在していればその値が返ります。

実務での使いどころ

  • サイトの設定値(サイト名、投稿の表示件数など)を取得するとき。
  • プラグインやテーマの設定を、保存した値から取り出すとき。
  • 存在しないときの代わりの値を、第2引数で指定して取得するとき。

よくあるミスと対処

  • 保存されていないと false が返る。値が false・0・空文字のときと区別できず、判定を誤る。代わりの値は、第2引数で指定する。
  • 配列を保存したのに、取得した値を配列として扱う前に、確認していない。
  • 出力時に、エスケープしていない。

NG例

if ( ! get_option( 'my_count' ) ) {
	// 未設定のつもり(値が 0 のときも入る)
}

OK例

$count = (int) get_option( 'my_count', 0 );

使い分け早見表

関数 役割
get_option() オプションの値を取得する
update_option() 値を保存する(なければ作成)
get_site_option() ネットワーク全体のオプションを取得する(マルチサイト)

関連項目

update_option()、add_option()、delete_option()

公式リファレンス:get_option() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました