get_option

パラメータ

• $setting
  オプションの名前。主なオプションの名前は次の通り。

  名前	適用
  siteurl	WordPressのアドレス（管理画面「設定」-「一般設定」）※
  home	サイトのアドレス（ブログのアドレス）（管理画面「設定」-「一般設定」）※
  blogname	ブログタイトル（管理画面「設定」-「一般設定」）
  blogdescription	キャッチフレーズ（管理画面「設定」-「一般設定」）
  admin_email	メールアドレス（管理画面「設定」-「一般設定」）
  posts_per_page	1ページ内の投稿数（管理画面「設定」-「表示設定」）
  posts_per_rss	RSS/Atomフィードで表示する最新の投稿数（管理画面「設定」-「表示設定」）
  comments_per_page	1ページ内のコメント数（管理画面「設定」-「ディスカッション設定」）
  date_format	日付フォーマット（管理画面「設定」-「一般設定」）
  time_format	時刻フォーマット（管理画面「設定」-「一般設定」）
  template	現在のテーマの名前
  post_count	投稿数
  show_on_front	フロントページの表示（管理画面「設定」-「表示設定」）
  page_on_front	フロントページの表示>フロントページ（管理画面「設定」-「表示設定」）
  page_for_posts	フロントページの表示>投稿ページ（管理画面「設定」-「表示設定」）
  gmt_offset	タイムゾーン>UTCとの時差（管理画面「設定」-「一般設定」）
  uploads_use_yearmonth_folders	アップロードフォルダの管理方法>アップロードしたファイルを年月ベースのフォルダに整理（管理画面「設定」-「メディア設定」）
  use_smilies	「整形」顔文字を画像に変換して表示（管理画面「設定」-「投稿設定」）
  embed_size_w	「埋め込みファイルの最大サイズ」の「幅」（管理画面「設定」-「メディア」）
  embed_size_h	「埋め込みファイルの最大サイズ」の「高さ」（管理画面「設定」-「メディア」）
  blog_charset	ブログの文字エンコード
  blacklist_keys	コメントブラックリスト（管理画面「設定」-「ディスカッション」）
  moderation_keys	コメントモデレーション（管理画面「設定」-「ディスカッション」）
  sticky_posts	「この投稿を先頭に固定表示」がチェックされている投稿情報のIDを格納した配列
  wp_page_for_privacy_policy	[4.9.6]セキュリティポリシーページの投稿ID

  • ※WordPress MUの場合、設定画面が異なる。
• $default
  デフォルトの値。

返り値

パラメータ$settingで指定されたオプションの値を返す。$settingで指定されたオプションが設定されていない場合は、パラメータ$defaultの値を返す。

注意

WordPressのバージョンによってオプションは異なる。

[4.9.0]"pre_option_{$option}"フィルターにパラメータ$defaultが追加された。

使用例

• 'siteurl'という名前のオプションの値を取得する。
  <?php $siteurl = get_option( 'siteurl' ); ?>

フィルター

[1.5.0]オプション名が空以外の場合、"pre_option_{$option}"フィルターを呼び出す。パラメータ$preは標準でfalseが格納され、このフィルターでfalse以外の値を返すとそれがオプションの値となる。[4.4.0]$optionが追加され、本関数が受け取った同名の内容が格納される。[4.9.0]パラメータ$defaultには本関数が受け取った内容が格納される。 [3.4.0]WordPressのインストール時以外で指定されたオプション値が見つからない場合、'default_option_'.$optionフィルターを呼び出す。パラメータ$defaultは本関数が受け取った内容が格納される。[4.4.0]$optionが追加され、本関数が受け取った同名の内容が格納される。 [1.5.0]要求された値を返す直前に呼び出される（一部のオプションはフィルターを通らない）。フィルター名はオプション名の前に'option_'を付けたもので、パラメータ$valueには返す直前のオプション値（必要に応じてシリアライズ済）が格納される。[4.4.0]$optionが追加され、本関数が受け取った同名の内容が格納される。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/functions.php
/wp-includes/option.php