説明
mixed get_option( string $setting [ , mixed $default = false ] )
パラメータ$settingで指定されたオプションの値を取得する。
パラメータ
- $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には本関数が受け取った内容が格納される。$pre = apply_filters( "pre_option_{$option}", $pre, $option, $default );
[3.4.0]WordPressのインストール時以外で指定されたオプション値が見つからない場合、'default_option_'.$optionフィルターを呼び出す。パラメータ$defaultは本関数が受け取った内容が格納される。[4.4.0]$optionが追加され、本関数が受け取った同名の内容が格納される。
return apply_filters( 'default_option_' . $option, $default, $option );
[1.5.0]要求された値を返す直前に呼び出される（一部のオプションはフィルターを通らない）。フィルター名はオプション名の前に'option_'を付けたもので、パラメータ$valueには返す直前のオプション値（必要に応じてシリアライズ済）が格納される。[4.4.0]$optionが追加され、本関数が受け取った同名の内容が格納される。
return apply_filters( 'option_'.$option, $value, $option );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/option.php
最終更新 : 2018年05月27日 10:47
関連
お勧め
子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）
少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。投稿内容に応じてwpautopを制御する（2013年8月13日 更新）
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。
親子の固定ページで同じテンプレートを使う（2013年3月20日 更新）
固定ページのテンプレートファイルは「page.php」か、ページ名（スラッグ）または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。管理画面でツールバー（Admin bar）を非表示にする（2013年3月5日 更新）
WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。カスタムフィールド関連関数のおさらい（2012年6月22日 更新）
カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。