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年9月26日 登録)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

囲み型ショートコードとwpautop(2014年10月22日 登録)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2011年5月2日 登録)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 登録)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

投稿ページでユニークなテンプレートを選択しよう(2016年12月19日 登録)

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

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