wp_cache_incr()


WordPressのwp_cache_incr()関数は、キャッシュに保存されている数値を指定した値だけ増加させるために使用されます。この関数は、オブジェクトキャッシュを操作する際に便利です。

構文

wp_cache_incr( string $key, int $offset = 1, string $group = '', int $expiration = 0 );

引数の説明:

  • $key (string) — キャッシュ内のデータを識別するためのキー。
  • $offset (int) — 増加させる値。デフォルトは1。
  • $group (string) — キャッシュデータのグループ名。デフォルトは空。
  • $expiration (int) — キャッシュの有効期限（秒単位）。デフォルトは0（期限なし）。

例1: キャッシュの値を1増やす

キャッシュに保存された数値を1増やす基本的な例です。

wp_cache_incr('my_counter');

例2: キャッシュの値を指定した値だけ増やす

キャッシュに保存された数値を5増やす例です。

wp_cache_incr('my_counter', 5);

例3: グループを指定してキャッシュの値を増やす

特定のグループに属するキャッシュの値を増やす例です。

wp_cache_incr('my_counter', 1, 'my_group');

例4: キャッシュの有効期限を設定して値を増やす

キャッシュの有効期限を60秒に設定して値を増やす例です。

wp_cache_incr('my_counter', 1, '', 60);

例5: キャッシュの値が存在しない場合の処理

キャッシュの値が存在しない場合にデフォルト値を設定する例です。

if (!wp_cache_incr('my_counter')) { wp_cache_set('my_counter', 10); }

例6: キャッシュの値を減らす

キャッシュの値を減らすために負の値を指定する例です。

wp_cache_incr('my_counter', -1);

例7: 複数のキャッシュキーを操作する

複数のキャッシュキーに対して値を増やす例です。

wp_cache_incr('counter_1'); wp_cache_incr('counter_2', 2);

例8: キャッシュの値を確認しながら増やす

キャッシュの値を確認し、特定の条件で増やす例です。

if (wp_cache_get('my_counter') < 100) { wp_cache_incr('my_counter'); }

注意点

  • キャッシュの値が数値でない場合、この関数は動作しません。
  • キャッシュの値が存在しない場合、デフォルトでは何も起こりません。
  • キャッシュの有効期限を設定する場合、正しい秒数を指定してください。

関連機能：