Memcache::delete

(PECL memcache >= 0.2.0)

Memcache::delete — サーバーから項目を削除する

説明

Memcache::delete ( string $key [, int $timeout = 0 ] ) : bool

Memcache::delete() は、 key に対応する項目を削除します。

パラメータ

key

削除したい項目のキー。

timeout

この非推奨のパラメータはサポートしておらず、デフォルトで 0 秒になっています。 このパラメータを使ってはいけません。

変更履歴

バージョン 説明
Unknown timeout パラメータを使うことは推奨しません。 このパラメータの挙動は memcached のバージョンによって異なりますが、 0 に設定しておけば安全です。 その他の値を指定すると、memcache の削除が失敗する原因となる可能性があります。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例

例1 Memcache::delete() の例

<?php

/* 手続き型の API */
$memcache_obj = memcache_connect('memcache_host', 11211);

/* 項目をサーバーから削除します */
memcache_delete($memcache_obj, 'key_to_delete');

/* オブジェクト指向の API */
$memcache_obj = new Memcache;
$memcache_obj->connect('memcache_host', 11211);

$memcache_obj->delete('key_to_delete');

?>

参考