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

関連

お勧めコンテンツ

親子の固定ページで同じテンプレートを使う(2013年3月20日 登録)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

LevelとCapability(2011年4月14日 登録)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

Somewhere search box:プラグイン作ってみました(2012年12月24日 登録)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加しました。

公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない(2015年3月15日 登録)

数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。

適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす(2011年10月18日 登録)

/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。

最終更新日時 : 2015-12-17 17:25