get_option

(1.5.0以降)
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を格納した配列
    • ※WordPress MUの場合、設定画面が異なる。
  • $default
    デフォルトの値。

返り値

パラメータ$settingで指定されたオプションの値を返す。$settingで指定されたオプションが設定されていない場合は、パラメータ$defaultの値を返す。

注意

WordPressのバージョンによってオプションは異なる。

使用例

  • 'siteurl'という名前のオプションの値を取得する。
    <?php $siteurl = get_option( 'siteurl' ); ?>

フィルター

[1.5.0]オプション名が空以外の場合、'pre_option_'.$optionフィルターを呼び出す。パラメータ$preは標準でfalseが格納され、このフィルターでfalse以外の値を返すとそれがオプションの値となる。[4.4.0]$optionが追加され、本関数が受け取った同名の内容が格納される。
$pre = apply_filters( 'pre_option_' . $option, $pre, $option );
[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

関連

お勧めコンテンツ

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 登録)

WordPress 3.5で登場するであろうWP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 登録)

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 登録)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

ツイート引用が簡単になる仕組み(2012年6月8日 登録)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

投稿一覧に独自リンクを追加する(2013年4月25日 登録)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

最終更新日時 : 2017-03-23 12:02