wp_list_pluck() | Fonctions Wordpress

Description

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

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

Retourne

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

Structure de la fonction `wp_list_pluck()`

Définie dans le fichier wp-includes/functions.php à la ligne 4591 :

function wp_list_pluck( $list, $field, $index_key = null ) {
    $util = new WP_List_Util( $list );
    return $util->pluck( $field, $index_key );
}

Où trouver 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