set_transient

パラメータ

• $transient
  トランジェント名（172文字以下）を指定。
• $value
  保持する値を指定。
• $expiration
  値を保持する秒数を指定（省略時は0）。

返り値

値を保持できた場合はtrueを、保持できなかった場合はfalseを返す。

注意

本関数は特定のデータを一時的または永続的に保持する。値の保持方法はサイトの環境に依存し、オブジェクトキャッシュ（ wp_cache_set関数）かオプションテーブル（ update_option関数など）が使用される。

パラメータ$transientはフィルター名やアクション名に使用され、WordPress本体が使用する名称と被らないように注意しなければならない。

配列やオブジェクトを保持する場合、パラメータ$valueにはシリアライズする必要はない。

保持期間を示すパラメータ$expirationは、"expiration_of_transient_{$transient}"フィルターを経て判定される（0の場合は永続的に保持）。

使用例

• トランジェントの値を設定する。

  <?php set_transient( 'myplugin_data', $value ); ?>

• 3時間保持するトランジェントの値を設定する。

  <?php set_transient( 'myplugin_data', $value, 3 * HOUR_IN_SECONDS ); ?>

フィルター

$value = apply_filters( "pre_set_transient_{$transient}", $value, $expiration, $transient );

$expiration = apply_filters( "expiration_of_transient_{$transient}", $expiration, $value, $transient );

アクション

do_action( "set_transient_{$transient}", $value, $expiration, $transient );

do_action( 'setted_transient', $transient, $value, $expiration );

ソースファイル