acf_get_users()


WordPress関数acf_get_users()は、Advanced Custom Fields(ACF)プラグインの一部であり、特定の条件に基づいてユーザー情報を取得するために使用されます。

シンタックス

acf_get_users( array $args = array() );

引数の説明:

  • $args (array) — ユーザーを取得するための引数を指定する配列。デフォルトは空の配列。
  • 'role' (string) — 取得するユーザーの役割。例えば、’administrator’や’editor’。
  • 'meta_key' (string) — メタデータのキー。特定のメタデータに基づいてユーザーを絞り込むことができます。
  • 'meta_value' (string) — メタデータの値。指定された値に一致するユーザーを取得します。
  • 'number' (int) — 取得するユーザーの数。指定しない場合、すべてのユーザーが取得されます。
  • 'orderby' (string) — ユーザーを並べ替える基準。’ID’、’login’、’email’などが使用できます。
  • 'order' (string) — 並べ替えの順番。’ASC’(昇順)または’DESC’(降順)が指定できます。

例1: 特定の役割のユーザーを取得する

管理者のユーザーを取得する基本的な例です。

<?php
$users = acf_get_users( array( 'role' => 'administrator' ) );
?>

例2: メタデータを基にユーザーを絞り込む

特定のメタデータキーと値を持つユーザーを取得する方法です。

<?php
$users = acf_get_users( array( 'meta_key' => 'favorite_color', 'meta_value' => 'blue' ) );
?>

例3: ユーザー数を制限する

最大5人のユーザーのみを取得する方法です。

<?php
$users = acf_get_users( array( 'number' => 5 ) );
?>

例4: ユーザーを並べ替える

ユーザーを登録順で昇順に並べ替える方法です。

<?php
$users = acf_get_users( array( 'orderby' => 'registered', 'order' => 'ASC' ) );
?>

例5: メタデータと役割でユーザーをフィルタリング

特定のメタデータと役割を基にユーザーを絞り込む例です。

<?php
$users = acf_get_users( array( 'role' => 'editor', 'meta_key' => 'premium_user', 'meta_value' => 'yes' ) );
?>

例6: 役割ごとにユーザーを取得する

複数の役割を指定してユーザーを取得する方法です。

<?php
$users = acf_get_users( array( 'role' => 'editor' ) );
?>

注意点

  • 引数で指定された値に基づいてユーザーが取得されますが、大量のデータを扱う場合はパフォーマンスに影響を与える可能性があります。
  • 引数の値によって、適切なエラーチェックを行うことが推奨されます。