• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get option

提供: WordPress Codex 日本語版
移動先: 案内検索

options データベーステーブルから名前を指定してオプションの値を取得する安全な方法です。希望するオプションが存在しない場合、または対応する値がない場合は、FALSE が返されます。

使い方

<?php get_option( $option, $default ); ?> 

パラメータ

$option
文字列) (必須) 取得するオプションの名前。小文字のみ。
初期値: なし

有効なオプションの短いリストを次に示しますが、もっと完全なリストがオプション設定リファレンスにあります。

  • 'admin_email' - ブログ管理者のメールアドレス。
  • 'blogname' -サイトのタイトル。一般設定でセット。
  • 'blogdescription' - キャッチフレーズ。一般設定でセット。
  • 'blog_charset' - サイトの言語。一般設定でセット。
  • 'date_format' -日付のフォーマット。一般設定でセット。
  • 'default_category' - 投稿用カテゴリーの初期設定。投稿設定でセット。
  • 'home' - WordPress アドレス (URL)。一般設定でセット。
  • 'siteurl' - サイトアドレス (URL)。一般設定でセット。
    注意: get_bloginfo( 'siteurl' )(WordPress アドレス を返します)とは異なります。get_bloginfo( 'wpurl' ) と同じです。
  • 'template' - 現在のテーマ名。外観 > テーマ でセット。
  • 'start_of_week' - 週の始まり。一般設定でセット。
  • 'upload_path' - アップロードするファイルの保存場所。wp-config.php でセット。
  • 'users_can_register' - だれでもユーザー登録ができるようにする。一般設定でセット。
  • 'posts_per_page' - 1ページに表示する最大投稿数。表示設定でセット。
  • 'posts_per_rss' - RSS/Atom フィードで表示する最新の投稿数。表示設定でセット。
インストールしたプラグインにより、もっと多くのオプションが利用可能な場合があります。
$default
mixed) (オプション) 値が返されない(データベースにオプションが存在しない)場合のデフォルト値。
初期値: false

戻り値

(mixed) 
指定されたオプションの現在の値。そのオプションが存在しなければ $default の値(指定されていた場合)または FALSE(デフォルト)を返します。
詳細は オプション設定リファレンス を参照してください。

用例

<?php

$no_exists_value = get_option( 'no_exists_value' );
var_dump( $no_exists_value ); /* false を表示 */

$no_exists_value = get_option( 'no_exists_value', 'default_value' );
var_dump( $no_exists_value ); /* 'default_value' を表示 */

?>

ブログタイトルを表示する

<h1> タグ内にブログタイトルを表示します。

<h1><?php echo get_option( 'blogname' ); ?></h1>

文字セットを表示する

ブログで使用している文字セット(例えば UTF-8)を表示します。

<p>文字セット: <?php echo get_option( 'blog_charset' ); ?> </p>

管理者のメールアドレスを取得

ブログ管理者のメールアドレスを取得し、変数に格納します。

<?php $admin_email = get_option( 'admin_email' ); ?>


参考

  • apply_filters() を使用します。
    • オプションを検査する前に 'pre_option_$option' /en を呼び出します。フィルターフックが false ではない値を返すと、オプションの取得を「飛ばして」その値を返します。特別なオプションを上書きすべきではありませんが、禁止されてはいません。
    • オプションを検査した後に 'option_$option' /en を呼び出します。オプションの値を渡します。
    • $default がセットされていてオプションの値が存在しないとき、その値を返す前に 'default_option_$option' /en を呼び出します。$default の値を渡します。
  • maybe_unserialize() /en を使って、値を返す前に非シリアル化します。

変更履歴

  • 新規導入: 1.5.0

ソースファイル

get_option()wp-includes/option.php にあります。

関連項目

Options API: add_option() /en, add_site_option() /en, delete_option() /en, delete_site_option() /en, form_option() /en, get_site_option() /en, get_site_url(), get_user_option() /en, get_option() /en, update_option() /en, update_site_option() /en, update_user_option() /en, wp_load_alloptions() /en



関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/get_option最新版との差分