【PHP8.x】DOMEntity::__sleep()メソッドの使い方

__sleepメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月06日

基本的な使い方

__sleepメソッドはDOMEntityオブジェクトがシリアライズされる直前に呼び出されるメソッドです。通常、このメソッドは、オブジェクトのプロパティの中から、シリアライズ（オブジェクトの状態を保存可能な形式に変換すること）すべきものを指定するために使用されます。開発者はこのメソッドをオーバーライドし、シリアライズ時に保持したいプロパティ名を文字列の配列として返すことで、オブジェクトの特定の部分だけを保存したり、不要なプロパティを除外したりします。

しかし、PHPのDOM拡張機能に含まれるDOMEntityのようなオブジェクトは、C言語で実装された内部構造を持ち、複雑なリソースや他のDOMノードとの密接な参照関係を保持しています。このため、標準的なserialize()関数によるシリアライズはサポートされていません。DOMEntityオブジェクトを直接シリアライズしようとすると、内部リソースの性質上、オブジェクトの状態を適切に保存することができず、予期せぬ結果やエラーを引き起こす可能性があります。

したがって、DOMEntityクラスにおける__sleepメソッドは、このオブジェクトが標準的なシリアライズには適さないことを暗に示します。このメソッドが内部的にどのように実装されているかにかかわらず、DOMEntityオブジェクトをシリアライズしようとする操作は避けるべきです。このメソッドは、DOMオブジェクトがシリアライズの対象外であり、その状態を保存する場合には別の手段（例えば、DOMをXML文字列として出力するなど）を検討する必要があることを開発者に伝達する役割を担っています。

構文(syntax)


1<?php
2
3class DOMEntity
4{
5    public function __sleep(): array
6    {
7        return [];
8    }
9}

引数(parameters)

引数なし

引数はありません

戻り値(return)

array

DOMEntity::__sleep メソッドは、オブジェクトをシリアライズ（保存や転送のためにデータ構造をバイト列に変換すること）する際に、どのプロパティを保存するかを指定するために、DOMEntity オブジェクトのプロパティ名の配列を返します。

サンプルコード

PHPで0.5秒プログラムを一時停止する


1<?php
2
3/**
4 * 指定された秒数だけプログラムの実行を一時停止します。
5 *
6 * この関数は、usleep() を使用してミリ秒単位での待機を実現します。
7 * 処理の前後のタイムスタンプを記録し、実際の待機時間をコンソールに出力します。
8 *
9 * @param float $seconds 待機する秒数 (例: 0.5)
10 * @return void
11 */
12function wait(float $seconds): void
13{
14    // 処理開始前のタイムスタンプを取得
15    $startTime = microtime(true);
16
17    echo "プログラムの実行を {$seconds} 秒間、一時停止します..." . PHP_EOL;
18
19    // 秒をマイクロ秒に変換 (1秒 = 1,000,000マイクロ秒)
20    $microseconds = (int)($seconds * 1000000);
21
22    // usleep()関数は、指定されたマイクロ秒だけスクリプトの実行を遅延させます
23    usleep($microseconds);
24
25    // 処理再開後のタイムスタンプを取得
26    $endTime = microtime(true);
27    
28    // 実際の経過時間を計算
29    $elapsedTime = $endTime - $startTime;
30
31    echo "一時停止が完了しました。" . PHP_EOL;
32    echo "実際の経過時間: " . round($elapsedTime, 4) . " 秒" . PHP_EOL;
33}
34
35// 0.5秒間、実行を一時停止する
36wait(0.5);

このPHPサンプルコードは、プログラムの実行を指定された秒数だけ一時停止するwaitという関数を定義し、それを利用する例です。Webページの読み込み処理や、APIへの連続アクセスを防ぐ目的などで利用されます。

このコードの中心となるのは、PHPに標準で組み込まれているusleep関数です。usleep関数は、引数に指定されたマイクロ秒（100万分の1秒）の間、プログラムの実行を停止させます。サンプルコードでは、より直感的に秒単位で時間を指定できるように、引数で受け取った秒数を1,000,000倍してマイクロ秒に変換し、usleep関数に渡しています。

wait関数は、引数として停止したい秒数をfloat型（小数点数）で受け取ります。戻り値はvoidと指定されており、これはこの関数が特定の値を返さないことを意味します。また、処理の前後でmicrotime(true)を使い時刻を取得することで、実際にどれくらいの時間プログラムが停止したかを計測し、その結果を出力しています。最後にwait(0.5);と記述することで、この関数を呼び出し、プログラムの実行を0.5秒間停止させています。

提供されたリファレンス情報の__sleepメソッドは、オブジェクトの保存（シリアライズ）時に使われるもので、プログラムの実行を一時停止する機能とは異なります。サンプルコードで使われているusleep()関数は、マイクロ秒単位で処理を一時停止するため、0.5秒のような秒数未満の待機に適しています。ただし、この関数はOSの状況により、指定した時間から若干の誤差が生じる可能性があります。また、usleep()や秒単位で待機するsleep()関数は、実行中のプロセスを完全に停止させます。Webサーバーなどで安易に長時間使用すると、他のリクエスト処理を遅延させる原因となりうるため、利用場面には注意が必要です。

PHPでミリ秒単位の待機処理


1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたミリ秒だけプログラムの実行を待機します。
7 *
8 * PHPの標準関数 `sleep()` は秒単位ですが、`usleep()` を使うことで
9 * より細かいマイクロ秒単位での待機が可能です。
10 * この関数は、ミリ秒をマイクロ秒に変換して `usleep()` を呼び出します。
11 *
12 * @param int $milliseconds 待機する時間（ミリ秒単位）。
13 */
14function sleepMilliseconds(int $milliseconds): void
15{
16    // usleep()はマイクロ秒を引数に取るため、ミリ秒を1000倍して変換します。
17    // (1ミリ秒 = 1000マイクロ秒)
18    if ($milliseconds > 0) {
19        usleep($milliseconds * 1000);
20    }
21}
22
23// --- ここから実行サンプル ---
24
25// 現在のタイムスタンプとマイクロ秒を取得して表示
26echo "処理開始: " . microtime(true) . PHP_EOL;
27
28// 待機させたい時間（ミリ秒）
29$waitTime = 1500; // 1.5秒
30
31echo "{$waitTime}ミリ秒待機します..." . PHP_EOL;
32
33// 作成した関数を呼び出して待機
34sleepMilliseconds($waitTime);
35
36// 待機後のタイムスタンプとマイクロ秒を取得して表示
37echo "処理終了: " . microtime(true) . PHP_EOL;
38

このPHPコードは、プログラムの実行をミリ秒単位で一時停止するカスタム関数 sleepMilliseconds の実装例です。PHPに標準で用意されている sleep() 関数は秒単位での待機しかできませんが、より短い時間で処理を中断させたい場合にこのコードのような手法が役立ちます。

このサンプルでは、マイクロ秒（100万分の1秒）単位で待機できる usleep() 関数を利用しています。sleepMilliseconds 関数は、引数として待機したい時間 $milliseconds をミリ秒単位の整数で受け取ります。関数内部では、usleep() 関数がマイクロ秒単位の引数を必要とするため、受け取ったミリ秒の値を1000倍してマイクロ秒に変換しています。これにより、指定したミリ秒だけプログラムの実行が停止します。この関数は処理を行うだけで特定の値を返さないため、戻り値の型は void となっています。

コードの後半では、実際にこの関数を呼び出し、処理の開始時刻と終了時刻を表示しています。これにより、意図した時間だけプログラムが正しく待機したことを確認できます。

このサンプルコードで使われているusleep()関数は、マイクロ秒（100万分の1秒）単位で時間を指定します。ミリ秒（1000分の1秒）で待機させたい場合は、コードのように値を1000倍する必要がある点に注意してください。また、sleep()やusleep()による待機時間はOSの処理状況に影響されるため、指定した時間よりもわずかに長くなる可能性があります。なお、PHPには__sleep()という名前のメソッドもありますが、これはオブジェクトを保存する際に使われる全く別の機能です。プログラムの実行を一時停止させるsleep()やusleep()と混同しないようにしましょう。