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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(途中まで訳)
(残りを和訳しました。)
 
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
 +
<div id="Description">
 
== 説明 ==
 
== 説明 ==
 +
</div>
  
[[Transients_API|transient]]の値をデータベースに保存、更新します。
+
[[Transients_API|Transient]] の値をデータベースに保存または更新します。
  
値をシリアル化する必要は無く、値がセットされる前にシリアライズされます。
+
値をシリアル化する必要はありません。必要があれば、値がセットされる前にシリアライズされます。
<!--  If the value needs to be serialized, then it will be serialized before it is set. -->
+
  
 +
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 +
</div>
  
 
  <?php set_transient( $transient, $value, $expiration ); ?>
 
  <?php set_transient( $transient, $value, $expiration ); ?>
  
 +
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 +
</div>
  
{{Parameter|$transient|文字列|Transient名。 Expected to not be SQL-escaped. Should be  45 characters or less in length as WordPress will prefix your name with "_transient_" or "_transient_timeout_" in the options table (depending on whether it expires or not). 長いキー名はサイレント状態で失敗します。 [http://core.trac.wordpress.org/ticket/15058 Trac #15058]を参照。}}
+
{{Parameter|$transient|文字列|Transient の名前。SQL エスケープされていないものとして扱われる。長さ 45 文字以下にすること(有効期限が過ぎたかどうかに応じて、WordPress が名前に "_transient_" または "_transient_timeout_" を前置するため)。これより長い名前を指定すると、何も通知なく失敗する。[http://core.trac.wordpress.org/ticket/15058 Trac #15058] を参照。}}
{{Parameter|$value|mixed|Transientの値。SQLエスケープではないと予想。}}
+
{{Parameter|$value|mixed|Transient の値。SQL エスケープされていないものとして扱われる。}}
{{Parameter|$expiration|int|Time until expiration in seconds from now, or 0 for never expires. 例:一日の場合、有効期限の値は次のようになります。: ''(60 * 60 * 24)''.|オプション|''0''}}.
+
{{Parameter|$expiration|整数|現在から有効期限が切れるまでの秒数。0 は無期限。例えば 1 日なら ''(60 * 60 * 24)''|オプション|''0''}}
  
 +
<div id="Return_Values">
 
== 戻り値 ==
 
== 戻り値 ==
 +
</div>
  
; (真または偽) : 値がセットしない場合は falseを、値がセットする場合には true を返します。
+
; (真偽値) : 値がセットされなければ false、セットされれば true。
  
 +
<div id="Examples">
 
== 用例 ==
 
== 用例 ==
 +
</div>
 +
 +
<div id="Saving_the_.24special_query_results_object_for_12_hours">
 +
=== オブジェクト $special_query_results を 12 時間保存する ===
 +
</div>
  
=== 12時間 $special_query_results オブジェクトを保存する ===
 
 
<pre>
 
<pre>
 
<?php
 
<?php
31行目: 43行目:
 
</pre>
 
</pre>
  
== ==
+
<div id="Notes">
トランジェントが存在する場合、この関数は、トランジェントの有効期限を更新します。
+
== 参考 ==
 +
</div>
  
NB: transients that never expire are autoloaded, whereas transients with an expiration time are not autoloaded. Consider this when adding transients that may not be needed on every page, and thus do not need to be autoloaded, impacting page performance.
+
Transient が既にあれば、この関数はその有効期限を更新します。
  
WordPressは時間を秒単位で指定するためのいくつかの定数を提供します。代わりに整数を乗算する、次を参照 [[Transients_API#Using_Time_Constants]]。
+
'''注意:''' 無期限の Transient はオートロードされますが、有効期限を持つ Transient はオートロードされません。このことを、すべてのページで必要なわけではない(つまりオートロードが不要な)Transient を追加するときに検討してください。ページの性能に影響します。
  
トランジェントキー名がwp_optionsテーブル内のデータベースの設定において64文字に制限されています( option_name: varchar(64) ).
+
WordPress は時間を秒数で指定するための定数をいくつか提供します。整数を掛け算する代わりに、[[Transients_API#Using_Time_Constants|時間の定数を使う]] をご覧ください。
  
== 更新履歴 ==
+
Transient の名前(キー)は wp_options テーブルのデータベース設定( option_name: varchar(64) )により 64 文字に制限されていますが、自動的に文字列が前置されるので[[#Parameters|最長 45 文字にしてください]]。
 +
 
 +
<div id="Change_Log">
 +
== 変更履歴 ==
 +
</div>
  
 
新規導入: [[Version_2.8|2.8]]
 
新規導入: [[Version_2.8|2.8]]
  
 +
<div id="Source_File">
 
== ソースファイル ==
 
== ソースファイル ==
 +
</div>
  
<tt>set_transient()</tt> は {{Trac|wp-includes/option.php}}にあります。
+
<tt>set_transient()</tt> は {{Trac|wp-includes/option.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連項目 ==
 +
</div>
  
== 関連 ==
 
 
{{Transient Tags}}
 
{{Transient Tags}}
  
 
{{Tag Footer}}
 
{{Tag Footer}}
  
 +
{{原文|Function_Reference/set_transient|151824}} <!-- 00:26, 27 May 2015 Miccweb 版 -->
 +
 +
{{DEFAULTSORT:Set_transient}}
 +
[[Category:関数]]
  
{{原文|Function_Reference/set_transient|144221}}<!--  05:53, 13 June 2014‎ Nickciske  版 -->
+
[[en:Function_Reference/set_transient]]

2015年8月15日 (土) 11:47時点における最新版

この項目「関数リファレンス/set transient」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

Transient の値をデータベースに保存または更新します。

値をシリアル化する必要はありません。必要があれば、値がセットされる前にシリアライズされます。

使い方

<?php set_transient( $transient, $value, $expiration ); ?>

パラメータ

$transient
文字列) (必須) Transient の名前。SQL エスケープされていないものとして扱われる。長さ 45 文字以下にすること(有効期限が過ぎたかどうかに応じて、WordPress が名前に "_transient_" または "_transient_timeout_" を前置するため)。これより長い名前を指定すると、何も通知なく失敗する。Trac #15058 を参照。
初期値: なし
$value
mixed) (必須) Transient の値。SQL エスケープされていないものとして扱われる。
初期値: なし
$expiration
整数) (オプション) 現在から有効期限が切れるまでの秒数。0 は無期限。例えば 1 日なら (60 * 60 * 24)
初期値: 0

戻り値

(真偽値) 
値がセットされなければ false、セットされれば true。

用例

オブジェクト $special_query_results を 12 時間保存する

<?php
set_transient( 'special_query_results', $special_query_results, 12 * HOUR_IN_SECONDS );
?>

参考

Transient が既にあれば、この関数はその有効期限を更新します。

注意: 無期限の Transient はオートロードされますが、有効期限を持つ Transient はオートロードされません。このことを、すべてのページで必要なわけではない(つまりオートロードが不要な)Transient を追加するときに検討してください。ページの性能に影響します。

WordPress は時間を秒数で指定するための定数をいくつか提供します。整数を掛け算する代わりに、時間の定数を使う をご覧ください。

Transient の名前(キー)は wp_options テーブルのデータベース設定( option_name: varchar(64) )により 64 文字に制限されていますが、自動的に文字列が前置されるので最長 45 文字にしてください

変更履歴

新規導入: 2.8

ソースファイル

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

Transients API: set_transient(), get_transient(), delete_transient(), set_site_transient(), get_site_transient(), delete_site_transient(),


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


最新英語版: WordPress Codex » Function_Reference/set_transient最新版との差分