説明
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
最終更新 : 2024年07月18日 13:59
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。