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

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

「関数リファレンス/get option」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(日本語版向けに調整/未翻訳)
(残りを和訳。)
 
(3人の利用者による、間の6版が非表示)
1行目: 1行目:
{{NeedTrans}}
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
{{テンプレートタグガイド|PHP}}
+
[[データベース構造#Table:_wp_options|options データベーステーブル]]から名前を指定して[[オプション設定リファレンス|オプション]]の値を取得する安全な方法です。希望するオプションが存在しない場合、または対応する値がない場合は、<tt>FALSE</tt> が返されます。
  
== Description ==
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
A safe way of getting values for a named option from the options database table. If the desired option does not exist, or no value is associated with it, '''FALSE''' will be returned.
+
<?php get_option( $option, $default ); ?>
  
== Usage ==
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
<?php echo get_option( $show, $default ); ?>
+
{{Parameter|$option|文字列|取得するオプションの名前。小文字のみ。<!-- Underscores separate words, lowercase only. -->}}
  
== Parameters <span id="Parameters"></span>==
+
有効なオプションの短いリストを次に示しますが、もっと完全なリストが[[オプション設定リファレンス]]にあります。
  
{{Parameter|$show|string|Name of the option to retrieve. A list of valid default options can be found at the [[Option Reference]].}}
+
:* <tt>'admin_email'</tt> - ブログ管理者のメールアドレス。
 +
:* <tt>'blogname'</tt> -サイトのタイトル。一般設定でセット。
 +
:* <tt>'blogdescription'</tt> - キャッチフレーズ。一般設定でセット。
 +
:* <tt>'blog_charset'</tt> - サイトの言語。一般設定でセット。
 +
:* <tt>'date_format'</tt> -日付のフォーマット。一般設定でセット。
 +
:* <tt>'default_category'</tt> - 投稿用カテゴリーの初期設定。投稿設定でセット。
 +
:* <tt>'home'</tt> - WordPress アドレス (URL)。一般設定でセット。
 +
:* <tt>'siteurl'</tt> - サイトアドレス (URL)。一般設定でセット。<br />'''注意:''' <tt>get_bloginfo( 'siteurl' )</tt>(WordPress アドレス を返します)とは異なります。<tt>get_bloginfo( 'wpurl' )</tt> と同じです。
 +
:* <tt>'template'</tt> - 現在のテーマ名。外観 &gt; テーマ でセット。
 +
:* <tt>'start_of_week'</tt> - 週の始まり。一般設定でセット。
 +
:* <tt>'upload_path'</tt> - アップロードするファイルの保存場所。[[wp-config.php の編集#Moving_uploads_folder|wp-config.php]] でセット。
 +
:* <tt>'users_can_register'</tt> - だれでもユーザー登録ができるようにする。一般設定でセット。
 +
:* <tt>'posts_per_page'</tt> - 1ページに表示する最大投稿数。表示設定でセット。
 +
:* <tt>'posts_per_rss'</tt> - RSS/Atom フィードで表示する最新の投稿数。表示設定でセット。
  
{{Parameter|$default|mixed|The default value to return if no value is returned (ie. the option is not in the database).|optional|false}}
+
:インストールしたプラグインにより、もっと多くのオプションが利用可能な場合があります。
  
== Values <span id="Values"></span>==
+
{{Parameter|$default|mixed|値が返されない(データベースにオプションが存在しない)場合のデフォルト値。|オプション|<tt>false</tt>}}
More information: [[Option_Reference]]
+
  
== Examples <span id="Examples"></span>==
+
<div id="Return_Values">
 +
== 戻り値 ==
 +
</div>
  
=== Show Blog Title ===
+
; (mixed) : 指定されたオプションの現在の値。そのオプションが存在しなければ <tt>$default</tt> の値(指定されていた場合)または <tt>FALSE</tt>(デフォルト)を返します。
  
Displays your blog's title in a &lt;h1&gt; tag.
+
:詳細は [[Option_Reference|オプション設定リファレンス]] を参照してください。
  
<pre><h1><?php echo get_option('blogname'); ?></h1></pre>
+
<div id="Examples">
 +
== 用例 ==
 +
</div>
  
=== Show Character Set ===
+
<pre><?php
  
Displays the character set your blog is using (ex: UTF-8)
+
$no_exists_value = get_option( 'no_exists_value' );
 +
var_dump( $no_exists_value ); /* false を表示 */
  
<pre><p>Character set: <?php echo get_option('blog_charset'); ?> </p></pre>
+
$no_exists_value = get_option( 'no_exists_value', 'default_value' );
 +
var_dump( $no_exists_value ); /* 'default_value' を表示 */
  
===Retrieve Administrator E-mail===
+
?></pre>
  
Retrieve the e-mail of the blog administrator, storing it in a variable.
+
=== ブログタイトルを表示する ===
  
<?php $admin_email = get_option('admin_email'); ?>
+
&lt;h1&gt; タグ内にブログタイトルを表示します。
  
== 更新履歴 ==
+
<pre><h1><?php echo get_option( 'blogname' ); ?></h1></pre>
  
* since 1.5.0
+
=== 文字セットを表示する ===
  
== ソースコード ==
+
ブログで使用している文字セット(例えば UTF-8)を表示します。
  
<code>get_option()</code> は {{Source|wp-includes/functions.php}} にあります({{CurrentVersion}}: 最新安定版)。
+
<pre><p>文字セット: <?php echo get_option( 'blog_charset' ); ?> </p></pre>
  
{{原文|Function Reference/get_option|90974}}<!-- 13:15, 29 June 2010 Bono 版 -->
+
=== 管理者のメールアドレスを取得 ===
  
== 関連 ==
+
ブログ管理者のメールアドレスを取得し、変数に格納します。
 +
 
 +
<?php $admin_email = get_option( 'admin_email' ); ?>
 +
 
 +
 
 +
<div id="Notes">
 +
== 参考 ==
 +
</div>
 +
 
 +
* <tt>[[関数リファレンス/apply_filters | apply_filters()]]</tt> を使用します。
 +
** オプションを検査する前に <tt>[[プラグイン API/フィルターフック一覧/pre_option_$option | 'pre_option_$option']]</tt> /[[:en:Plugin_API/Filter_Reference/pre_option_$option|en]] を呼び出します。フィルターフックが <tt>false</tt> ではない値を返すと、オプションの取得を「飛ばして」その値を返します。特別なオプションを上書きすべきではありませんが、禁止されてはいません。
 +
** オプションを検査した後に <tt>[[プラグイン API/フィルターフック一覧/'option_$option' | 'option_$option']]</tt> /[[:en:Plugin_API/Filter_Reference/'option_$option'|en]] を呼び出します。オプションの値を渡します。
 +
** <tt>$default</tt> がセットされていてオプションの値が存在しないとき、その値を返す前に <tt>[[プラグイン API/フィルターフック一覧/default_option_$option | 'default_option_$option']]</tt> /[[:en:Plugin_API/Filter_Reference/default_option_$option|en]] を呼び出します。<tt>$default</tt> の値を渡します。
 +
* <tt>[[関数リファレンス/maybe_unserialize | maybe_unserialize()]]</tt> /[[:en:Function_Reference/maybe_unserialize|en]] を使って、値を返す前に非シリアル化します。
 +
 
 +
== 変更履歴 ==
 +
 
 +
* 新規導入: 1.5.0
 +
 
 +
== ソースファイル ==
 +
 
 +
<code>get_option()</code> は {{Trac|wp-includes/option.php}} にあります。
 +
 
 +
== 関連項目 ==
  
 
{{Option Tags}}
 
{{Option Tags}}
  
 
{{Tag Footer}}
 
{{Tag Footer}}
 +
 +
{{原文|Function Reference/get_option|152417}} <!-- 09:03, 26 June 2015 Vesuvium 版 -->
  
 
{{DEFAULTSORT:Get_option}}
 
{{DEFAULTSORT:Get_option}}
 
[[Category:関数]]
 
[[Category:関数]]
  
[[en:Function Reference/get_option]]
+
[[en:Function Reference/get option]]
[[ru:Справочник_по_функциям/get_option]]
+
[[es:Referencia de Funciones/get option]]
[[vi:Tham Khảo Các Hàm/get_option]]
+
[[it:Riferimento funzioni/get_option]]
 +
[[ru:Справочник_по_функциям/get option]]
 +
[[vi:Tham Khảo Các Hàm/get option]]
 +
[[zh-hans:get_option]]

2015年9月21日 (月) 22:31時点における最新版

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最新版との差分