wp_list_pluck()


WordPress関数wp_list_pluck()は、多次元配列またはオブジェクトから特定のキーやプロパティの値を取得し、単一の配列として返します。

構文

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

引数の説明:

  • $list (array) — 処理対象の多次元配列またはオブジェクト。
  • $field (string|int) — 抽出するキーまたはプロパティ。
  • $index_key (string|int|null) — オプション。返される配列のキーとして使用する値。

例 1: 投稿タイトルの取得

投稿リストから投稿タイトルを取得する例です。

<?php
$posts = get_posts();
$titles = wp_list_pluck( $posts, 'post_title' );
?>

例 2: ユーザー名の取得

ユーザーリストからユーザー名を取得する例です。

<?php
$users = get_users();
$usernames = wp_list_pluck( $users, 'user_login' );
?>

例 3: メタデータの取得

カスタムメタデータを持つ投稿のメタ値を取得する例です。

<?php
$meta_data = [
    ['meta_key' => 'color', 'meta_value' => 'red'],
    ['meta_key' => 'color', 'meta_value' => 'blue'],
];
$values = wp_list_pluck( $meta_data, 'meta_value' );
?>

例 4: カテゴリIDのリスト作成

カテゴリオブジェクトの配列からカテゴリIDを取得する例です。

<?php
$categories = get_categories();
$category_ids = wp_list_pluck( $categories, 'cat_ID' );
?>

例 5: オブジェクトキーをインデックスキーとして使用

ユーザーリストからIDをインデックスキーにして名前を取得する例です。

<?php
$users = get_users();
$user_names = wp_list_pluck( $users, 'display_name', 'ID' );
?>

注意事項

wp_list_pluck()は入力が多次元配列またはオブジェクトであることを前提としています。配列が適切でない場合、不正確な結果やエラーが発生する可能性があります。

関連機能：