usort

    (PHP 4, PHP 5, PHP 7, PHP 8)

    usort — Sortiert ein Array nach Werten mittels einer benutzerdefinierten Vergleichsfunktion

    Beschreibung

    usort(array&$array, callable$callback): true

    Diese Funktion sortiert array nach seinen Werten mittels einer benutzerdefinierten Vergleichsfunktion, um die Reihenfolge zu bestimmen.

    Hinweis:

    Wenn zwei Mitglieder als identisch verglichen werden, behalten sie ihre ursprüngliche Reihenfolge bei. Vor PHP 8.0.0 war die relative Sortierung im sortierten Array nicht definiert.

    Hinweis: Diese Funktion weist den Elementen des Arrays array neue Schlüssel zu. Bestehende Schlüssel, die bereits zugewiesen wurden, werden entfernt statt einfach nur die Schlüssel neu anzuordnen

    Parameter-Liste

    array

    Das zu sortierende Array.

    callback

    Die Vergleichsfunktion muss einen Integer kleiner als, gleich oder größer als Null zurückgeben, wenn das erste Argument respektive kleiner, gleich oder größer als das zweite ist.

    callback(mixed$a, mixed$b): int
    Achtung

    Wenn die Vergleichsfunktion nicht-ganzzahlige Werte zurückgibt, z. B. vom Typ float, wird der Rückgabewert des Callbacks intern in den Typ int umgewandelt. Werte wie 0.99 und 0.1 werden also beide in einen Integer-Wert von 0 umgewandelt, wodurch diese Werte als gleichwertig eingestuft werden.

    Rückgabewerte

    Gibt immer true zurück.

    Changelog

    VersionBeschreibung
    8.2.0 Der Rückgabewert ist nun true vorher war es bool.
    8.0.0 Wenn callback einen per Referenz übergebenen Parameter erwartet, gibt diese Funktion nun einen Fehler der Stufe E_WARNING aus.

    Beispiele

    Beispiel #1 usort()-Beispiel

    <?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 $key => $value) {
    echo     "$key: $value\n";
    }
    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    0: 1 1: 2 2: 3 3: 5 4: 6

    Der Raumschiff-Operator kann verwendet werden, um den internen Vergleich noch weiter zu vereinfachen.

    <?php
    function cmp($a, $b)
    {
    return     $a <=> $b;
    }

    $a = array(3, 2, 5, 6, 1);

    usort($a, "cmp");

    foreach (    $a as $key => $value) {
    echo     "$key: $value\n";
    }
    ?>

    Hinweis:

    Für dieses einfache Beispiel wäre die Funktion sort() offensichtlich die bessere Wahl.

    Beispiel #2 usort()-Beispiel für mehrdimensionale Arrays

    <?php
    function cmp($a, $b)
    {
    return     strcmp($a["frucht"], $b["frucht"]);
    }

    $fruechte[0]["frucht"] = "Zitronen";
    $fruechte[1]["frucht"] = "Aepfel";
    $fruechte[2]["frucht"] = "Orangen";

    usort($fruechte, "cmp");

    foreach (    $fruechte as $key => $value) {
    echo     "\$fruechte[$key]: " . $value["frucht"] . "\n";
    }
    ?>

    Wenn ein mehrdimensionales Array sortiert wird, enthalten $a und $b Verweise auf den ersten Index des Arrays.

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    $fruechte[0]: Aepfel $fruechte[1]: Orangen $fruechte[2]: Zitronen

    Beispiel #3 usort()-Beispiel, das die Methode eines Objekts benutzt

    <?php
    class TestObj {
    private     string $name;

    function     __construct($name)
    {
    $this->name = $name;
    }


    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";
    }
    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    b c d

    Beispiel #4 usort()-Beispiel zum Einsatz einer Closure zum Sortieren eines mehrdimensionalen Arrays

    <?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";
    }
    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    y, a x, b z, c

    Beispiel #5 usort() Beispiel unter Verwendung des Raumschiff-Operators

    Der Raumschiff-Operator ermöglicht den einfachen Vergleich von zusammengesetzten Werten über mehrere Achsen hinweg. Das folgende Beispiel sortiert $people nach dem Nachnamen und anschließend, wenn der Nachname übereinstimmt, nach dem Vornamen.

    <?php
    $people    [0] = ['first' => 'Adam', 'last' => 'West'];
    $people[1] = ['first' => 'Alec', 'last' => 'Baldwin'];
    $people[2] = ['first' => 'Adam', 'last' => 'Baldwin'];

    function     sorter(array $a, array $b) {
    return [    $a['last'], $a['first']] <=> [$b['last'], $b['first']];
    }

    usort($people, 'sorter');

    foreach (    $people as $person) {
    print     $person['last'] . ', ' . $person['first'] . PHP_EOL;
    }
    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    Baldwin, Adam Baldwin, Alec West, Adam

    Siehe auch

    To Top