(PHP 5 >= 5.5.0, PHP 7, PHP 8)
array_column — Retourne les valeurs d'une colonne d'un tableau d'entrée
array_column() retourne les valeurs d'une colonne de array, identifiée par la clé column_key. Optionnellement, vous pouvez fournir un paramètre index_key pour indexer les valeurs dans le tableau retourné par les valeurs de la colonne index_key du tableau d'entrée.
arrayUn tableau multidimensionnel ou un tableau d'objets à partir duquel on extrait une colonne de valeur. Si un tableau d'objets est fourni, alors les propriétés publiques peuvent être directement extraites. Pour que les propriétés protected ou private soient extraites, la classe doit implémenter les deux méthodes magiques __get() et __isset().
column_key La colonne de valeurs à retourner. Cette valeur peut être la clé entière de la colonne que vous souhaitez récupérer, ou bien le nom de la clé pour un tableau associatif ou le nom de la propriété. Il peut aussi valoir null pour retourner le tableau complet ou des objets (ceci peut être utile en conjonction du paramètre index_key pour ré-indexer le tableau).
index_keyLa colonne à utiliser comme index/clé pour le tableau retourné. Cette valeur peut être la clé entière de la colonne, ou le nom de la clé. La valeur est cast comme d'habitude pour les clés du tableau (cependant, antérieur à PHP 8.0.0, les objects qui supportent une conversion en chaîne de caractère étaient aussi autorisés).
Retourne un tableau de valeurs représentant une seule colonne depuis le tableau d'entrée.
| Version | Description |
|---|---|
| 8.0.0 | Les objets dans les colonnes indiqué par le paramètre index_key ne seront plus convertie en chaîne de caractères et lanceront désormais une TypeError à la place. |
Exemple #1 Récupère la colonne des prénoms
<?php
// Tableau représentant un jeu d'enregistrements issu d'une base de données
$records = array(
array(
'id' => 2135,
'first_name' => 'John',
'last_name' => 'Doe',
),
array(
'id' => 3245,
'first_name' => 'Sally',
'last_name' => 'Smith',
),
array(
'id' => 5342,
'first_name' => 'Jane',
'last_name' => 'Jones',
),
array(
'id' => 5623,
'first_name' => 'Peter',
'last_name' => 'Doe',
)
);
$first_names = array_column($records, 'first_name');
print_r($first_names);
?>L'exemple ci-dessus va afficher :
Array ( [0] => John [1] => Sally [2] => Jane [3] => Peter )
Exemple #2 Récupère la colonne des noms, indexé par la colonne "id"
<?php
// En utilisant le tableau de l'exemple #1
$last_names = array_column($records, 'last_name', 'id');
print_r($last_names);
?>L'exemple ci-dessus va afficher :
Array ( [2135] => Doe [3245] => Smith [5342] => Jones [5623] => Doe )
Exemple #3 Récupère la colonne des username depuis la propriété publique "username" d'un objet
<?php
class User
{
public $username;
public function __construct(string $username)
{
$this->username = $username;
}
}
$users = [
new User('user 1'),
new User('user 2'),
new User('user 3'),
];
print_r(array_column($users, 'username'));
?>L'exemple ci-dessus va afficher :
Array ( [0] => user 1 [1] => user 2 [2] => user 3 )
Exemple #4 Récupère la colonne nom depuis la propriété privée "name" d'un objet en utilisant la méthode magique __get().
<?php
class Person
{
private $name;
public function __construct(string $name)
{
$this->name = $name;
}
public function __get($prop)
{
return $this->$prop;
}
public function __isset($prop) : bool
{
return isset($this->$prop);
}
}
$people = [
new Person('Fred'),
new Person('Jane'),
new Person('John'),
];
print_r(array_column($people, 'name'));
?>L'exemple ci-dessus va afficher :
Array ( [0] => Fred [1] => Jane [2] => John )