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

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

関数リファレンス/get transient

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

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

Transient の値を取得します。

Transient が存在しないか値を持たないときは false を返します。

使い方

<?php get_transient( $transient ); ?>

パラメータ

$transient
文字列) (必須) Transient のユニークな名前。SQL エスケープされていないものとして扱われる。45 文字以内注意: site_ の Transient の場合は 40 文字以内。
初期値: なし

戻り値

(mixed) 
Transient の値。存在しないか、値を持たないか、それとも有効期限が切れている場合、get_transient()false を返します。このチェックにはふつうの等価演算子ではなく、厳密な等価演算子(===)を使うべきです。なぜなら、整数値 0(または "empty" な他のデータ)を保存したい場合もあるからです。false がこのような意味を持つため、Transient に単一の真偽値を保存するのは避けるべきです。配列に格納するか、整数に変換しましょう。

用例

get_transient と set_transient および WP_Query の使用例

<?php
// Transient データのコピーを取得
if ( false === ( $special_query_results = get_transient( 'special_query_results' ) ) ) {
  // 無ければ、データを再生成して Transient へ保存
  $special_query_results = new WP_Query( 'cat=5&order=random&tag=tech&post_meta_key=thumbnail' );
  set_transient( 'special_query_results', $special_query_results );
}

// ふつうにデータがあった場合と同じようにデータを利用する...
?>

開発中に生のデータが必要なとき、条件文に WP_DEBUG を追加

<?php
if ( WP_DEBUG or false === ( $special_query_results = get_transient( 'special_query_results' ) ) ) ) {
  // 無ければ、データを再生成して Transient へ保存
  $special_query_results = new WP_Query( 'cat=5&order=random&tag=tech&post_meta_key=thumbnail' );
  set_transient( 'special_query_results', $special_query_results );
}
?>

参考

変更履歴

新規導入: 2.8

ソースファイル

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