Arrays asociativos en PHP: pares clave valor

Un array asociativo guarda cada valor bajo una clave que eliges tú, escrita como key => value: $user = ['name' => 'Ada', 'age' => 36];. Lee un valor con $user['name'], y añade o cambia uno asignándolo a su clave: $user['email'] = 'ada@example.com';.

<?php
$user = [
    'name' => 'Ada',
    'age'  => 36,
    'city' => 'London',
];

echo $user['name'], "\n";
echo $user['age'], "\n";

$user['email'] = 'ada@example.com';   // add a pair
$user['city']  = 'Paris';             // change a value

print_r($user);

En otros lenguajes la misma estructura se llama diccionario, mapa o hash. En PHP es un array normal cuyas claves son cadenas en lugar de 0, 1, 2.

Añadir, cambiar y eliminar pares

Asignar a una clave que no existe la añade al final. Asignar a una clave que ya existe sustituye su valor y mantiene su posición. unset() elimina un par.

<?php
$stock = ['apples' => 10, 'pears' => 4];

$stock['plums'] = 7;      // new key: added at the end
$stock['apples'] = 12;    // existing key: value replaced
$stock['pears']--;        // change in place
unset($stock['plums']);   // remove a pair

print_r($stock);

array_push() no sirve aquí: solo puede añadir valores con claves numéricas. Para añadir varios pares a la vez, usa array_merge($stock, $more), donde ganan los valores nuevos, o $stock + $more, donde las claves existentes conservan sus valores; la página de array_merge compara las dos.

Recorrer claves y valores

foreach ($array as $key => $value) recorre los pares en el orden en que se añadieron. Omite $key => cuando solo necesites los valores.

<?php
$capitals = [
    'France'  => 'Paris',
    'Japan'   => 'Tokyo',
    'Brazil'  => 'Brasília',
];

foreach ($capitals as $country => $capital) {
    echo "The capital of $country is $capital.\n";
}

foreach ($capitals as $capital) {
    echo mb_strtoupper($capital), "\n";
}

Obtener todas las claves o todos los valores

array_keys() devuelve las claves como una lista simple y array_values() devuelve los valores, ambos reindexados desde 0. Dale a array_keys() un segundo argumento y devuelve solo las claves que contienen ese valor, que es como encuentras todas las claves de un valor.

<?php
$grades = ['Ada' => 'A', 'Linus' => 'B', 'Grace' => 'A'];

print_r(array_keys($grades));
print_r(array_values($grades));
print_r(array_keys($grades, 'A'));    // keys whose value is 'A'

echo array_search('B', $grades), "\n"; // first key with value 'B'

Para una sola clave, array_search() devuelve la primera coincidencia, o false si no hay ninguna. La página de array_search explica por qué debes comparar ese resultado con !== false.

Comprobar si existe una clave

isset($arr['key']) es la comprobación habitual y la más rápida, pero devuelve false cuando la clave existe y contiene null. array_key_exists('key', $arr) devuelve true en ese caso. Para leer con un valor por defecto, el operador ?? hace las dos cosas a la vez.

<?php
$settings = ['theme' => 'dark', 'font' => null];

var_dump(isset($settings['theme']));
var_dump(isset($settings['font']));            // null counts as not set
var_dump(array_key_exists('font', $settings)); // the key is there

$size = $settings['size'] ?? 14;               // default when missing
echo $size, "\n";

Ordenar por clave o por valor

ksort() ordena por clave y asort() por valor, y las dos mantienen cada clave unida a su valor. krsort() y arsort() ordenan al revés. No uses sort() con un array asociativo: descarta las claves y renumera desde 0.

<?php
$population = ['Tokyo' => 37, 'Delhi' => 32, 'Shanghai' => 29, 'Cairo' => 22];

ksort($population);       // A to Z by city
print_r($population);

arsort($population);      // largest value first
print_r($population);

sort($population);        // keys are lost
print_r($population);

Todas ordenan en el sitio y devuelven true, así que $sorted = ksort($arr) te da true, no un array. Los órdenes personalizados usan uasort() y uksort().

Invertir, contar y convertir a JSON

Con datos clave valor aparecen una y otra vez unas cuantas funciones de una línea: array_flip() intercambia claves y valores, array_count_values() cuenta cuántas veces aparece cada valor y json_encode() convierte el array en un objeto JSON.

<?php
$codes = ['red' => '#f00', 'green' => '#0f0', 'blue' => '#00f'];

print_r(array_flip($codes));           // look up a name by code

$votes = ['yes', 'no', 'yes', 'yes', 'no'];
print_r(array_count_values($votes));   // value => how many times

echo json_encode($codes), "\n";

Error frecuente: leer una clave que no existe

Leer una clave que falta devuelve null, pero tu PHP además imprime un warning:

<?php
$user = ['name' => 'Ada'];
echo $user['phone'];

Warning: Undefined array key "phone" in /var/www/html/index.php on line 3

Dale a la lectura un valor por defecto con ??, que nunca avisa, o comprueba antes con isset() cuando el caso de la clave ausente necesite su propia rama.

<?php
$user = ['name' => 'Ada', 'email' => 'ada@example.com'];

$phone = $user['phone'] ?? 'no phone on file';
echo $phone, "\n";

if (isset($user['email'])) {
    echo "Send mail to {$user['email']}\n";
}

Dentro de una cadena entre comillas dobles, envuelve la búsqueda entre llaves, "{$user['email']}". Sin ellas, PHP solo acepta la forma sin comillas "$user[email]", en la que es fácil equivocarse.