概要
wp_cache_set関数は、任意のデータをキャッシュに保存するために使われる非常に便利な関数です。この関数は、性能を向上させるために、既に計算済みのデータや重い処理結果をキャッシュに保存する際に使用されます。一般的には以下のような機能を実装する際によく使われます。
- データベースクエリの結果のキャッシュ
- 検索結果のキャッシュ
- APIコールの結果のキャッシュ
- ユーザーセッションデータのキャッシュ
- 計算結果（例えば、複雑な計算やフィルタ処理）のキャッシュ
- 設定やオプションのキャッシュ
- 投稿やページのメタデータのキャッシュ
- 外部リソースから取得したデータのキャッシュ
構文
wp_cache_set( $key, $data, $group = '', $expire = 0 );
パラメータ
$key(string) : キャッシュ内でのデータの識別子。$data(mixed) : キャッシュに保存するデータ。$group(string) : 総合的なグループ名で、同じグループ内のデータをまとめるために利用されます。$expire(int) : キャッシュが有効である時間（秒単位）。指定しない場合は無期限。
戻り値
- 成功した場合は
trueを返し、失敗した場合はfalseを返します。
関連する関数
使用可能なワードプレスバージョン
wp_cache_set関数は、WordPress 2.0.0以降で使用可能です。
コアファイルのパス
wp-includes/cache.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | 〇 |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
wp_cache_set関数は、特定のバージョンで非推奨または削除されたという情報はありません。