Método __sleep

O método __sleep é chamado automaticamente durante a serialização de um objeto usando a função serialize. Este método deve retornar um array com os nomes das propriedades que devem ser incluídas na representação serializada do objeto.

Sintaxe

phppublic function __sleep(): array;

Exemplo

Vamos criar uma classe e implementar o método __sleep para serializar apenas propriedades específicas:

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);
?>

Resultado da execução do código:

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

Exemplo

Usando __sleep para excluir dados confidenciais da serialização:

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);
?>

Resultado da execução do código:

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

Veja também