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

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

関数リファレンス/set transient

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

この項目「関数リファレンス/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最新版との差分