PHP: array_column

Description

function array_column(array $array, int|string|null $column_key, int|string|null $index_key = null): array

array_column() retourne les valeurs d'une colonne de array, identifiée par column_key. Optionnellement, il est possible de 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.

array est traité comme une liste de lignes, chacune étant elle-même un tableau ou un objet ; une colonne est l'entrée ou la propriété que column_key désigne dans chaque ligne. Les lignes qui ne sont ni un tableau ni un objet, ainsi que celles dans lesquelles cette entrée ou cette propriété est absente, sont ignorées sans aucun diagnostic. Les clés de array ne sont jamais préservées.

Liste de paramètres

array: Une liste dont les lignes sont des tableaux ou des objets, à partir de laquelle une colonne de valeurs est extraite. Si une ligne est un objet, les propriétés publiques sont lues directement. Pour qu'une propriété qui n'est pas accessible publiquement soit lue, la classe doit implémenter les deux méthodes magiques __get() et __isset() : sans __isset(), la ligne est ignorée, et avec __isset() mais sans __get(), une Error est lancée.
column_key: La colonne de valeurs à retourner. Cette valeur peut être la clé entière de la colonne à récupérer, ou bien le nom de la clé, sous forme de chaîne de caractères, pour un tableau associatif ou le nom de la propriété. Elle peut aussi valoir null pour retourner les lignes complètes (ceci est utile en conjonction du paramètre index_key pour réindexer le tableau).
index_key: La 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 objets qui supportent une conversion en chaîne de caractères étaient aussi autorisés).

Valeurs de retour

Retourne un tableau de valeurs représentant une seule colonne depuis le tableau d'entrée. Si column_key vaut null, ce sont les lignes elles-mêmes qui sont retournées.

Historique

Version	Description
8.0.0	Les objets dans les colonnes indiquées par le paramètre `index_key` ne seront plus convertis en chaîne de caractères et lanceront désormais une TypeError à la place.
7.1.0	La visibilité des propriétés est désormais respectée. Antérieur à cette version, les propriétés protected et private étaient lues directement.
7.0.0	Les lignes de `array` peuvent désormais être des objets aussi bien que des tableaux.

Exemples

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 = [
    [
        'id' => 2135,
        'first_name' => 'John',
        'last_name' => 'Doe',
    ],
    [
        'id' => 3245,
        'first_name' => 'Sally',
        'last_name' => 'Smith',
    ],
    [
        'id' => 5342,
        'first_name' => 'Jane',
        'last_name' => 'Jones',
    ],
    [
        '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ée par la colonne "id"

<?php

// En utilisant le tableau de l'exemple #1
$records = [
    [
        'id' => 2135,
        'first_name' => 'John',
        'last_name' => 'Doe',
    ],
    [
        'id' => 3245,
        'first_name' => 'Sally',
        'last_name' => 'Smith',
    ],
    [
        'id' => 5342,
        'first_name' => 'Jane',
        'last_name' => 'Jones',
    ],
    [
        'id' => 5623,
        'first_name' => 'Peter',
        'last_name' => 'Doe',
    ]
];

$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 les méthodes magiques __isset() et __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
)

Si __isset() n'est pas fourni, l'objet ne contribue à aucune entrée dans le tableau retourné.