説明
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 );
$pre = apply_filters( 'pre_option', $pre, $option, $default );
return apply_filters( 'default_option_' . $option, $default, $option );
return apply_filters( 'option_'.$option, $value, $option );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/option.php
最終更新 : 2022年11月07日 08:04
関連
お勧め
5.5で非推奨になる関数名について(2020年8月12日 更新)
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい(2013年11月27日 更新)
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)
query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?