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を格納した配列
    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

関連

参考

Code Reference: get_option

お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧（2018年5月27日 更新）

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

wp_titleからwp_get_document_titleへ（2018年5月27日 更新）

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

検索ワード「-10,000円」を検索できるようにしたい（2018年5月27日 更新）

とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。

ダッシュボードのフィードボックスをカスタマイズ（2011年7月8日 更新）

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する（管理者権限）。