set_site_transient

（2.9.0以降）
set_site_transient - サイト・トランジェント値を設定・更新する

説明

bool set_site_transient( string $transient, mixed $value [ , int $expiration = 0 ] )
サイト・トランジェント値を設定・更新する。

パラメータ

  • $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 );

フィルター

[3.0.0]はじめに"pre_set_site_transient_{$transient}"フィルターを呼び出す。パラメータ$valueには本関数が受け取った内容が格納されている。[4.4.0]パラメータ$transientには本関数が受け取った内容が格納されている。 
$value = apply_filters( "pre_set_site_transient_{$transient}", $value, $transient );
[4.4.0]"pre_set_site_transient_{$transient}"フィルターの後に"expiration_of_site_transient_{$transient}"フィルターを呼び出す。パラメータ$expirationには本関数が受け取った内容をintでキャストした値が、$valueには"pre_set_site_transient_{$transient}"フィルターの返り値が、$transientには本関数が受け取った内容が格納されている。 
$expiration = apply_filters( "expiration_of_site_transient_{$transient}", $expiration, $value, $transient );

アクション

[3.0.0]サイト・トランジェント値が設定・更新できた場合に"set_site_transient_{$transient}"アクションを呼び出す。パラメータ$valueには"pre_set_site_transient_{$transient}"フィルターの返り値が、$expirationには"expiration_of_site_transient_{$transient}"フィルターの返り値が格納されている。[4.4.0]パラメータ$transientには本関数が受け取った内容が格納されている。 
do_action( "set_site_transient_{$transient}", $value, $expiration, $transient );
[6.8.0]サイト・トランジェント値が設定・更新できた場合に'set_site_transient'アクションを呼び出す。パラメータ$transientには本関数が受け取った内容が、$valueには"pre_set_site_transient_{$transient}"フィルターの返り値が、$expirationには"expiration_of_site_transient_{$transient}"フィルターの返り値が格納されている。 
do_action( 'set_site_transient', $transient, $value, $expiration );

ソースファイル

/wp-includes/option.php

最終更新 : 2025年07月14日 10:26

関連

参考

Code Reference: set_site_transient

お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア（2018年5月27日 更新）

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている（基本的にはiOSの）絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。（2024年11月13日 更新）

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア（Clear Unknown Formatting）」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。