wp_list_pluck( array $list, int|string $field, int|string $index_key = null )

Retire certain champ d'une liste d'objet.

Paramètres

$list(array)requis

Liste de tableaux ou d'objets.

$field(int|string)requis

Les champs de l'objet à garder au lieu de l'objet entier.

$index_key(int|string)optionnel

Champ de l'objet à utiliser comme clé du nouveau tableau.

Valeur par défaut : null

Description / Informations supplémentaires

Cette fonction a la même fonctionnalité que array_column() en php, sauf qu'en plus elle accepte les objets.

Retourne

(array) Tableau des valeurs trouvées. Si $index_key existe, retourne un tableau de pairs valeur de $index_key / valeur de $field.

Déclaration et structure de la fonction wp_list_pluck()

function wp_list_pluck( $input_list, $field, $index_key = null ) {
    if ( ! is_array( $input_list ) ) {
        return array();
    }

    $util = new WP_List_Util( $input_list );

    return $util->pluck( $field, $index_key );
}

Où est utilisée la fonction wp_list_pluck() dans le CMS WordPress

Exemples

Voici une liste de nourriture :
$foods = array(
    array(
        'name'  => 'Banana',
        'color' => 'Yellow',
    ),
    array(
        'name'  => 'Apple',
        'color' => 'Red',
    ),
    array(
        'name'  => 'Lettuce',
        'color' => 'Green',
    ),
    array(
        'name'  => 'Apple',
        'color' => 'Red',
    ),
);

$food_names = wp_list_pluck( $foods, 'name' );

// Le tableau retourné sera :
array(
    'Banana',
    'Apple',
    'Lettuce',
    'Apple'
);
$foods = array(
    array(
        'name'  => 'Banana',
        'color' => 'Yellow',
    ),
    array(
        'name'  => 'Apple',
        'color' => 'Red',
    ),
    array(
        'name'  => 'Kiwi',
        'color' => null,
    ),
    array(
        'name'  => 'Lettuce',
        'color' => 'Green',
    ),
    array(
        'name'  => 'Cherry',
        'color' => 'Red',
    ),
);

$food_names = wp_list_pluck( $foods, 'name', 'color' );

// Le tableau retourné sera :
array(
    'Yellow' => 'Banana',
    'Red'    => 'Cherry',
     0       => 'Kiwi',
    'Green'  => 'Lettuce',
)

Sources

Codex WordPress : wp_list_pluck()

Autres fonctions dans le même fichier : wp-includes/functions.php

Retour