__unsetメソッド

メソッド __unset は、PHPのマジックメソッドの一つです。これは、関数 unset を使用してオブジェクトの存在しない、またはアクセスできないプロパティを削除しようとしたときに自動的に呼び出されます。このメソッドは1つのパラメータ、削除しようとしているプロパティの名前を受け取ります。

文法

phppublic function __unset(string $name): void

例

マジックメソッド __unset を持つクラスを作成し、存在しないプロパティを削除してみましょう:

php<?php
class MyClass {
  private $data = ['a' => 1, 'b' => 2];
  
  public function __unset($name) {
    echo "'$name' を削除しようとしています\n";
    unset($this->data[$name]);
  }
}

$obj = new MyClass();
unset($obj->a);
unset($obj->c);
?>

コードの実行結果:

php'a' を削除しようとしています
'c' を削除しようとしています

例

プライベートプロパティへのアクセス制御に __unset を使用する:

php<?php
class User {
  private $email = 'user@example.com';
  
  public function __unset($name) {
    if ($name === 'email') {
      throw new Exception("プライベートプロパティ 'email' は削除できません");
    }
  }
}

$user = new User();
unset($user->email);
?>

コードの実行結果:

phpException: プライベートプロパティ 'email' は削除できません

関連項目

  • メソッド __set,
    アクセスできないプロパティに書き込むときに呼び出されます
  • メソッド __get,
    アクセスできないプロパティを読み取るときに呼び出されます
  • メソッド __isset,
    アクセスできないプロパティの存在を確認するときに呼び出されます