serialize

(PHP 4, PHP 5, PHP 7, PHP 8)

serialize — 値の保存可能な表現を生成する

説明

serialize(mixed $value): string

値の保存可能な表現を生成します。

型や構造を失わずに PHP の値を保存または渡す際に有用です。

シリアル化された文字列を PHP の値に戻すには、 unserialize() を使用してください。

パラメータ

value

シリアル化する値。 serialize() は、resource および一部の object 以外のすべての型を処理します。（下記の注を参照ください）自分自身への参照を含む配列を serialize() することも可能です。シリアル化した配列/オブジェクト内の循環参照も保存されます。その他の参照は失われます。

PHP は、シリアル化の前にまずメンバ関数 __serialize() または __sleep() のコールを試みます。ここで、シリアル化の前のオブジェクトの後始末処理などを行います。同様に、unserialize() でオブジェクトを復元した際にはメンバ関数 __unserialize() または __wakeup() がコールされます。

注意:
オブジェクトの private メンバは、メンバ名の前にクラス名がつきます。また protected メンバはメンバ名の前に '*' がつきます。前に付加されるこれらの値の前後には null バイトがついています。

戻り値

value の保存可能なバイトストリーム表現を含む文字列を返します。

これはバイナリ文字列であり、null バイトを含む可能性もあることに注意しましょう。保存したり利用したりするときも、null バイトが含まれることを想定しておかないといけません。たとえば、serialize() の出力をデータベースに格納するときには、通常は CHAR 型や TEXT 型ではなく BLOB 型を使わないといけません。

例

例1 serialize() の例

<?php
// $session_data はカレントユーザーのセッション情報を含む多次元配列を
// 保持しています。リクエストの最後にこれをデータベースに保存するために
// serialize() を使用します。

$conn = odbc_connect("webdb", "php", "chicken");
$stmt = odbc_prepare($conn,
      "UPDATE sessions SET data = ? WHERE id = ?");
$sqldata = array (serialize($session_data), $_SERVER['PHP_AUTH_USER']);
if (!odbc_execute($stmt, $sqldata)) {
    $stmt = odbc_prepare($conn,
     "INSERT INTO sessions (id, data) VALUES(?, ?)");
    if (!odbc_execute($stmt, array_reverse($sqldata))) {
        /* 何か問題があったようです.. */
    }
}
?>

注意

注意:
PHP の組み込みオブジェクトの多くはシリアル化できないことに注意しましょう。しかし、 Serializable インターフェイスを実装しているか、あるいはマジックメソッド __serialize()/__unserialize() または __sleep()/__wakeup() を実装していればシリアル化することができます。内部クラスがこれらの要件を満たしていない場合は、確実にシリアル化することはできません。

この規則には歴史的な例外もあり、上記のインターフェイスやマジックメソッドを実装していない内部オブジェクトの中にもシリアル化可能なものがあります。

警告

serialize() でオブジェクトをシリアル化するときに、名前空間を指定したクラスの名前の先頭にあるバックスラッシュは含めません。これは互換性を高めるためです。

参考

unserialize() - 保存用表現から PHP の値を生成する
var_export() - 変数の文字列表現を出力または返す
json_encode() - 値を JSON 形式にして返す
オブジェクトのシリアル化
__sleep()
__wakeup()
__serialize()
__unserialize()