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



お勧め

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

Somewhere search box:プラグイン作ってみました(2021年4月26日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

カスタムブロックを作っていると、ブロック自身の「サイズ」を指定するUIを持たせることがある。そんなときにちょっとモヤっとするのが、「マージン」や「パディング」の設定しているパネルのタイトルが「サイズ」なこと。この「サイズ」の原文は「Dimensions」であり、個人的にもう少しスッキリするワードに変更してみた。

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

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

5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)

日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。