wp_cache_set() の使い方|説明・引数・注意点

説明

wp_cache_set() は、オブジェクトキャッシュにデータを保存する関数です。

基本構文

wp_cache_set( int|string $key, mixed $data, string $group = '', int $expire = 0 ): bool

引数

  • $key:キャッシュキー
  • $data:保存するデータ
  • $group:グループ名
  • $expire:有効期間(秒)

戻り値

保存できたら true。

使い方(サンプル)

wp_cache_set( 'my_key', $data, 'my_group', 300 );

注意点

  • 既定のオブジェクトキャッシュは、そのリクエストの間だけ有効です。Redisなどを導入すると、リクエストをまたいで保持できます。

実務での使いどころ

  • 同じリクエストの中で、重い処理の結果を、使い回すとき。
  • 永続的なオブジェクトキャッシュ(RedisやMemcached)を使うサイトで、結果をキャッシュするとき。

よくあるミスと対処

  • 保存した値が、次のリクエストでも、残ると考えている。永続的なオブジェクトキャッシュがない環境では、リクエストごとに消える。
  • $group を指定せず、他の処理と、キーが重なる。
  • データが更新されても、キャッシュを、消していない。古い値が、使われ続ける。

NG例

wp_cache_set( 'items', $items ); // グループがなく、更新時の削除もない

OK例

wp_cache_set( 'items', $items, 'my_plugin', HOUR_IN_SECONDS );

使い分け早見表

関数 役割
wp_cache_set() キャッシュに保存する
wp_cache_get() キャッシュから取得する
wp_cache_delete() キャッシュから削除する

関連項目

wp_cache_get()、wp_cache_delete()、set_transient()

公式リファレンス:wp_cache_set() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました