count_users

パラメータ

• $strategy
  集計方法として'time'または'memory'を指定（省略時は'time'）。
• $site_id
  [4.9.0]マルチサイト時にサイトIDを指定（省略時はnull）。

返り値

全ユーザ数と役割別のユーザ数を格納した連想配列を返す。

array(2) {
  ["total_users"]=>
  int(2)
  ["avail_roles"]=>
  array(3) {
    ["administrator"]=>
    int(1)
    ["subscriber"]=>
    int(1)
    ["none"]=>
    int(0)
  }
}

注意

パラメータ$strategyに指定する値は、著しく大量のユーザがいない限り'time'（時間優先）で問題ないと思われるが、メモリー不足でエラーになることを危惧するなら'memory'を指定する方が無難と思われる。

[4.4.0]返り値の配列["avail_roles"]["none"]に役割なしのユーザ数が格納されるようになった。

[4.9.0]パラメータ$site_idが追加され、マルチサイトの場合に任意のサイトから対象情報を取得できるようになった。

[5.1.0]ユーザー数を集計する前に'pre_count_users'フィルターが追加された。このフィルターでnull以外を返すと、集計は行われず、その値が本関数の返り値となる。

使用例

• 現在のサイトにて役割別のユーザ数を取得する。
  <?php $users = count_users(); ?>
• サイトIDが3のサイトから役割別のユーザ数を取得する。
  <?php $users = count_users( 'time', 3 ); ?>

フィルター

$pre = apply_filters( 'pre_count_users', $result, $strategy, $site_id );

アクション

ソースファイル