get_option

説明

mixed get_option( string $setting [ , mixed $default = false ] )
パラメータ$settingで指定されたオプションの値を取得する。

パラメータ

  • $setting
    オプションの名前。主なオプションの名前は次の通り。
    名前適用
    siteurlWordPressのアドレス(管理画面「設定」-「一般設定」)※
    homeサイトのアドレス(ブログのアドレス)(管理画面「設定」-「一般設定」)※
    blognameブログタイトル(管理画面「設定」-「一般設定」)
    blogdescriptionキャッチフレーズ(管理画面「設定」-「一般設定」)
    admin_emailメールアドレス(管理画面「設定」-「一般設定」)
    posts_per_page1ページ内の投稿数(管理画面「設定」-「表示設定」)
    posts_per_rssRSS/Atomフィードで表示する最新の投稿数(管理画面「設定」-「表示設定」)
    comments_per_page1ページ内のコメント数(管理画面「設定」-「ディスカッション設定」)
    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/functions.php
/wp-includes/option.php

最終更新 : 2019年11月14日 10:50

関連



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。