【PHP8.x】offsetUnsetメソッドの使い方

offsetUnsetメソッドは、PHPのWeakMapクラスに属し、指定されたオブジェクトをキーとするエントリ（キーと値のペア）をマップから削除するために実行されるメソッドです。

WeakMapは、キーとしてオブジェクトのみを使用できる特殊なコレクションです。このクラスは、キーとして設定されたオブジェクトへの「弱い参照」を保持するという特徴を持っています。これは、WeakMapにキーとして登録されたオブジェクトが他のどこからも参照されなくなった場合でも、WeakMapの存在がそのオブジェクトのメモリ解放（ガベージコレクション）を妨げないことを意味します。さらに、キーのオブジェクトがメモリから解放されると、WeakMapから対応するエントリも自動的に削除されるため、メモリリークの防止に非常に有効です。

このoffsetUnsetメソッドは、通常、unset($weakmap[$objectKey])のように、配列の要素を削除するような構文で特定のオブジェクトキーに関連付けられたエントリをWeakMapから明示的に削除する際に、PHPの内部で自動的に呼び出されます。この操作により、指定されたオブジェクトキーとその関連値はWeakMapから完全に削除され、WeakMapのメモリ効率を保つ上で重要な役割を果たします。存在しないキーを指定してもエラーにはならず、何も処理されません。

Copy
1<?php
2$weakMap = new WeakMap();
3$key = new stdClass();
4$weakMap[$key] = '任意のデータ';
5unset($weakMap[$key]);
6?>

object $object

• object $object: WeakMapからunsetする対象となるオブジェクト

void

指定されたキーに対応する要素をWeakMapから削除します。このメソッドは値を返しません。