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

最終更新 : 2018年05月27日 10:47

関連



お勧め

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

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

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

同じ名前のメタ情報をまとめて削除する(2014年3月21日 更新)

WordPressには、投稿情報、コメント情報、ユーザ情報のそれぞれを拡張できるメタ情報の仕組みが用意されている。投稿情報のメタ情報は「カスタムフィールド」として投稿画面に用意されているので投稿者自身が随時操作できるほか、テーマやプラグインからの操作も容易である。今回の中身はそんなメタ情報の一括削除の話だ。