5.5.15

compact

(PHP 4, PHP 5)

compactCreate array containing variables and their values

Description

array compact ( mixed $varname1 [, mixed $... ] )

Creates an array containing variables and their values.

For each of these, compact() looks for a variable with that name in the current symbol table and adds it to the output array such that the variable name becomes the key and the contents of the variable become the value for that key. In short, it does the opposite of extract().

Any strings that are not set will simply be skipped.

Parameters

varname1

compact() takes a variable number of parameters. Each parameter can be either a string containing the name of the variable, or an array of variable names. The array can contain other arrays of variable names inside it; compact() handles it recursively.

Return Values

Returns the output array with all the variables added to it.

Examples

Example #1 compact() example

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

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

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

The above example will output:

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

Notes

Note: Gotcha

Because variable variables may not be used with PHP's Superglobal arrays within functions, the Superglobal arrays may not be passed into compact().

See Also

  • extract() - Import variables into the current symbol table from an array

add a note add a note

User Contributed Notes 5 notes

up
27
tatarynowicz at gmail dot com
3 years ago
Please note that compact() will _not_ issue a warning if the specified variable name is undefined.
up
31
M Spreij
7 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
6
Robc
3 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.
up
-10
piedone at pyrocenter dot hu
3 years ago
A quick way of compacting all local variables:

<?php
$localVariables
= compact(array_keys(get_defined_vars()));
?>

This is useful if you want to return all local variables from a function/method or you want to pass all local variables to one. A valid example would be to use this with application hooks/events (if you want the called hook to be able to modify everything in the caller), but otherwise use with care (as methods should be used through their declared interface).
up
-13
hericklr at gmail dot com
9 years ago
The compact function doesn't work inside the classes or functions.
I think its escope is local...
Above it is a code to help about it.
Comments & Suggestions are welcome.
PS: Sorry for my poor english...

<?php

   
function x_compact()
    {    if(
func_num_args()==0)
        {    return
false; }
       
$m=array();

        function
attach($val)
        {    global
$m;
            if((!
is_numeric($val)) && array_key_exists($val,$GLOBALS))
            {   
$m[$val]=$GLOBALS[$val];}
        }

        function
sub($par)
        {    global
$m;
            if(
is_array($par))
            {    foreach(
$par as $cel)
                {    if(
is_array($cel))
                    {   
sub($cel); }
                    else
                    {   
attach($cel); }
                }
            }
            else
            {   
attach($par); }
            return
$m;
        }

        for(
$i=0;$i<func_num_args();$i++)
        {   
$arg=func_get_arg($i);
           
sub($arg);
        }

        return
sub($arg);
    }
?>
To Top