array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.usort.php', 1 => 'usort', ), 'up' => array ( 0 => 'ref.array.php', 1 => 'Funções para Array', ), 'prev' => array ( 0 => 'function.uksort.php', 1 => 'uksort', ), 'next' => array ( 0 => 'book.classobj.php', 1 => 'Classes/Objetos', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'pt_BR', 'path' => 'reference/array/functions/usort.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 4, PHP 5, PHP 7, PHP 8)
usort — Ordena um array pelos valores utilizando uma função de comparação definida pelo usuário
Ordenar o array
pelos valores usando uma
função de comparação definida pelo usuário para determinar a ordem.
Nota:
Se dois elementos são comparados como iguais, eles mantêm sua ordem original. Antes do PHP 8.0.0, sua ordem relativa no array ordenado era indefinida.
Nota: Esta função atribui novas chaves aos elementos do
array
. Ela removerá todas as chaves existentes que possam ter sido atribuídas, em vez de apenas reordenar as chaves.
array
The input array.
callback
A função de comparação deve retornar um inteiro menor que, igual ou maior que zero se o primeiro argumento for considerado respectivamente menor que, igual ou maior que o segundo.
Sempre retorna true
.
Versão | Descrição |
---|---|
8.2.0 |
O tipo do retorno agora é true ; anteriormente, era bool.
|
8.0.0 |
Se a função callback espera que um parâmetro seja passado
por referência, esta função agora emitirá um E_WARNING .
|
Exemplo #1 Exemplo de usort()
<?php
function cmp($a, $b)
{
if ($a == $b) {
return 0;
}
return ($a < $b) ? -1 : 1;
}
$a = array(3, 2, 5, 6, 1);
usort($a, "cmp");
foreach ($a as $chave => $valor) {
echo "$chave: $valor\n";
}
?>
O exemplo acima produzirá:
0: 1 1: 2 2: 3 3: 5 4: 6
O operador nave espacial (<=>) pode ser usado para simplificar ainda mais a comparação interna.
<?php
function cmp($a, $b)
{
return $a <=> $b;
}
$a = array(3, 2, 5, 6, 1);
usort($a, "cmp");
foreach ($a as $chave => $valor) {
echo "$chave: $valor\n";
}
?>
Nota:
Obviamente que nesse caso trivial a função sort() seria mais apropriada.
Exemplo #2 Exemplo de usort() usando um array multidimensional
<?php
function cmp($a, $b)
{
return strcmp($a["fruta"], $b["fruta"]);
}
$frutas[0]["fruta"] = "limões";
$frutas[1]["fruta"] = "abacaxis";
$frutas[2]["fruta"] = "goiabas";
usort($frutas, "cmp");
foreach ($frutas as $chave => $valor) {
echo "\$frutas[$chave]: " . $valor["fruta"] . "\n";
}
?>
Na ordenação de um array multi-dimensional, $a e $b contêm referências ao primeiro índice do array.
O exemplo acima produzirá:
$frutas[0]: abacaxis $frutas[1]: goiabas $frutas[2]: limões
Exemplo #3 Exemplo de usort() usando uma função membro de um objeto
<?php
class TestObj {
var $name;
function TestObj($name)
{
$this->name = $name;
}
/* Essa é a função estática de comparação */
static function cmp_obj($a, $b)
{
return strtolower($a->name) <=> strtolower($b->name);
}
}
$a[] = new TestObj("c");
$a[] = new TestObj("b");
$a[] = new TestObj("d");
usort($a, [TestObj::class, "cmp_obj"]);
foreach ($a as $item) {
echo $item->name . "\n";
}
?>
O exemplo acima produzirá:
b c d
Exemplo #4 Exemplo de usort() usando uma closure para ordernar um array multidimensional
<?php
$array[0] = array('key_a' => 'z', 'key_b' => 'c');
$array[1] = array('key_a' => 'x', 'key_b' => 'b');
$array[2] = array('key_a' => 'y', 'key_b' => 'a');
function build_sorter($key) {
return function ($a, $b) use ($key) {
return strnatcmp($a[$key], $b[$key]);
};
}
usort($array, build_sorter('key_b'));
foreach ($array as $item) {
echo $item['key_a'] . ', ' . $item['key_b'] . "\n";
}
?>
O exemplo acima produzirá:
y, a x, b z, c
Exemplo #5 Exemplo de usort() usando o operador nave espacial
O operador nave espacial permite comparação direta de
valores compostos atráves de múltiplos eixos. O exemplo a seguir irá ordenar
$pessoas
pelo último nome, e depois pelo primeiro nome se
o último nome for igual.
<?php
$pessoas[0] = ['primeiro' => 'Adam', 'ultimo' => 'West'];
$pessoas[1] = ['primeiro' => 'Alec', 'ultimo' => 'Baldwin'];
$pessoas[2] = ['primeiro' => 'Adam', 'ultimo' => 'Baldwin'];
function sorter(array $a, array $b) {
return [$a['ultimo'], $a['primeiro']] <=> [$b['ultimo'], $b['primeiro']];
}
usort($pessoas, 'sorter');
foreach ($pessoas as $pessoa) {
print $pessoa['ultimo'] . ', ' . $pessoa['primeiro'] . PHP_EOL;
}
?>
O exemplo acima produzirá:
Baldwin, Adam Baldwin, Alec West, Adam