メソッド __sleep

メソッド __sleep は、関数 serialize を使ってオブジェクトをシリアライズする際に自動的に呼び出されます。このメソッドは、シリアライズされたオブジェクト表現に含めるべきプロパティ名の配列を返す必要があります。

構文

phppublic function __sleep(): array;

例

クラスを作成し、特定のプロパティのみをシリアライズするために __sleep メソッドを実装してみましょう：

php<?php
class User {
  public $name = 'John';
  public $age = 30;
  private $password = '12345';
  
  public function __sleep() {
    return ['name', 'age'];
  }
}

$user = new User();
echo serialize($user);
?>

コード実行結果：

php'O:4:"User":2:{s:4:"name";s:4:"John";s:3:"age";i:30;}'

例

シリアライズから機密データを除外するための __sleep の使用：

php<?php
class Account {
  public $login = 'admin';
  private $password = 'secret';
  public $email = 'admin@example.com';
  
  public function __sleep() {
    return ['login', 'email'];
  }
}

$account = new Account();
echo serialize($account);
?>

コード実行結果：

php'O:7:"Account":2:{s:5:"login";s:5:"admin";s:5:"email";s:17:"admin@example.com";}'

関連項目