set_site_transient

パラメータ

• $transient
  サイト・トランジェント名（167文字以下）を指定。
• $value
  サイト・トランジェント値を指定。
• $expiration
  有効期間を秒で指定（省略時は0）。

返り値

サイト・トランジェント値が設定・更新できた場合はtrueを、設定・更新できなかった場合はfalseを返す。

注意

サイト・トランジェント値はadd_site_optionまたは update_site_option関数を使って「'_site_transient_' . $transient」という名前で設定・更新される（有効期間は「'_site_transient_timeout_' . $transient」）。それらの関数との違いはパラメータ$expirationで有効期間を設定できるところにある。

[4.4.0]"pre_set_site_transient_{$transient}"フィルターおよび"set_site_transient_{$transient}"アクションにパラメータ$transientが追加された。

[6.8.0]'set_site_transient'アクションが追加され、'setted_site_transient'アクションが非推奨に変更された。

使用例

• サイト・トランジェント値を設定・更新する

  set_site_transient( 'site_data', $value );

• サイト・トランジェント値を有効期間24時間として設定・更新する

  set_site_transient( 'site_data', $value, DAY_IN_SECONDS );

フィルター

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

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

アクション

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

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

ソースファイル