PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    compact

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

    compact — 変数名とその値から配列を作成する

    説明

    compact(array|string $var_name, array|string ...$var_names): array

    変数名とその値から配列を作成します。

    各引数について、compact() は現在の シンボルテーブル においてその名前を有する変数を探し、 変数名がキー、変数の値がそのキーに関する値となるように追加します。 端的に言うと、extract() の逆の動作をします。

    注意:

    PHP 7.3 より前のバージョンでは、設定されていない全ての文字列は、単にスキップされます。

    パラメータ

    var_name
    var_names

    compact() がとるパラメータの数は可変です。 各パラメータは、変数名を値とする文字列か、 変数名の配列のどちらかとすることができます。 配列は、変数名を値とする別の配列を持つことができます。 compact()はこれを再帰的に処理します。

    戻り値

    追加された全ての変数を値とする出力配列を返します。

    エラー / 例外

    compact() は、与えられた文字列が示す変数が未定義の場合、 E_WARNING レベルのエラーを発行します。

    変更履歴

    バージョン 説明
    7.3.0 compact() は、与えられた文字列が示す変数が未定義の場合、 E_NOTICE レベルのエラーを発行するようになりました。 以前のバージョンでは、設定されていない全ての文字列は、単にスキップされます。

    例

    例1 compact() の例

    <?php

    $city     = "San Francisco";
    $state = "CA";
    $event = "SIGGRAPH";

    $location_vars = array("city", "state");

    $result = compact("event", $location_vars);
    print_r($result);

    ?>

    上の例の出力は以下となります。

    Array
(
    [event] => SIGGRAPH
    [city] => San Francisco
    [state] => CA
)

    注意

    注意: 分かった!

    可変変数 は関数内で PHP の スーパーグローバル配列 と併用してはいけませんので、 スーパーグローバル配列を compact() に渡してはいけません。

    参考

    • extract() - 配列からシンボルテーブルに変数をインポートする

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 5 notes

    up
    170
    M Spreij
    17 years ago
    Can also handy for debugging, to quickly show a bunch of variables and their values:

    <?php
    print_r    (compact(explode(' ', 'count acw cols coldepth')));
    ?>

    gives

    Array
    (
    [count] => 70
    [acw] => 9
    [cols] => 7
    [coldepth] => 10
    )
    up
    63
    lekiagospel at gmail dot com
    4 years ago
    Consider these two examples. The first as used in the manual, and the second a slight variation of it.

    Example #1

    <?php
    $city     = "San Francisco";
    $state = "CA";
    $event = "SIGGRAPH";

    $location_vars = array("city", "state");

    $result = compact("event", $location_vars);
    print_r($result);
    ?>

    Example #1 above will output:

    Array
    (
    [event] => SIGGRAPH
    [city] => San Francisco
    [state] => CA
    )

    Example #2

    <?php
    $city     = "San Francisco";
    $state = "CA";
    $event = "SIGGRAPH";

    $location_vars = array("city", "state");

    $result = compact("event", "location_vars");
    print_r($result);
    ?>

    Example #2 above will output:

    Array
    (
    [event] => SIGGRAPH

    [location_vars] => Array
    (
    [0] => city
    [1] => state
    )

    )

    In the first example, the value of the variable $location_values (which is an array containing city, and state) is passed to compact().

    In the second example, the name of the variable $location_vars (i.e without the '$' sign) is passed to compact() as a string. I hope this further clarifies the points made in the manual?
    up
    56
    jmarkmurph at yahoo dot com
    8 years ago
    So compact('var1', 'var2') is the same as saying array('var1' => $var1, 'var2' => $var2) as long as $var1 and $var2 are set.
    up
    2
    c dot smith at fantasticmedia dot co dot uk
    1 year ago
    If you must utilise this knowing that a variable may be unset, then you need to use an alternative method.

    So instead of the following:

    <?php
    $var1     = "lorem";
    $var2 = "ipsum";
    $result = compact('var1', 'var2', 'unsetvar');
    ?>

    Consider the following:

    <?php
    $var1     = "lorem";
    $var2 = "ipsum";
    $result = [];
    foreach( [    'var1', 'var2', 'unsetvar'] as $attr ) {
    if ( isset( $    $attr ) ) {
    $result[ $attr ] = $$attr;
    }
    }
    ?>
    up
    28
    Robc
    13 years ago
    The description says that compact is the opposite of extract() but it is important to understand that it does not completely reverse extract(). In particluar compact() does not unset() the argument variables given to it (and that extract() may have created). If you want the individual variables to be unset after they are combined into an array then you have to do that yourself.
    ＋add a note