(PHP 5 >= 5.5.0, PHP 7, PHP 8)
array_column — Devuelve los valores de una columna de un array de entrada
array_column() devuelve los valores de una columna de array
, identificada por la clave
column_key
. Opcionalmente, se puede proporcionar
un argumento index_key
para indexar los valores
en el array devuelto por los valores de la columna
index_key
del array de entrada.
array
Un array multidimensional o un array de objetos a partir del cual se extrae una columna de valor. Si se proporciona un array de objetos, entonces las propiedades públicas pueden ser directamente extraídas. Para que las propiedades protegidas o privadas sean extraídas, la clase debe implementar las dos métodos mágicos __get() y __isset().
column_key
La columna de valores a devolver. Este valor puede ser la clave
entera de la columna que se desea recuperar, o bien el
nombre de la clave para un array asociativo o el nombre de la propiedad.
También puede valer null
para devolver el array completo o
los objetos (esto puede ser útil en conjunción con el argumento
index_key
para reindexar el array).
index_key
La columna a utilizar como índice/clave para el array devuelto. Este valor puede ser la clave entera de la columna, o el nombre de la clave. El valor es cast como de costumbre para las claves del array (sin embargo, anterior a PHP 8.0.0, los objetos que soportan una conversión en string también eran permitidos).
Devuelve un array de valores que representan una sola columna desde el array de entrada.
Versión | Descripción |
---|---|
8.0.0 |
Los objetos en las columnas indicadas por el argumento index_key
ya no se convertirán en string y lanzarán ahora
una TypeError en su lugar.
|
Ejemplo #1 Recupera la columna de los nombres
<?php
// Array que representa un conjunto de registros de una base de datos
$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);
?>
El resultado del ejemplo sería:
Array ( [0] => John [1] => Sally [2] => Jane [3] => Peter )
Ejemplo #2 Recupera la columna de los apellidos, indexada por la columna "id"
<?php
// Utilizando el array del ejemplo #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);
?>
El resultado del ejemplo sería:
Array ( [2135] => Doe [3245] => Smith [5342] => Jones [5623] => Doe )
Ejemplo #3 Recupera la columna de los nombres de usuario desde la propiedad pública "username" de un objeto
<?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'));
?>
El resultado del ejemplo sería:
Array ( [0] => user 1 [1] => user 2 [2] => user 3 )
Ejemplo #4 Recupera la columna de nombres desde la propiedad privada "name" de un objeto utilizando los métodos mágicos __isset() y __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'));
?>
El resultado del ejemplo sería:
Array ( [0] => Fred [1] => Jane [2] => John )