説明
array count_users( [ string $strategy = 'time' [, int $site_id = null ] ] )
役割別のユーザ数を取得する。
パラメータ
- $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 ); ?>
フィルター
[5.1.0]ユーザー数の集計前に'pre_count_users'フィルターを呼び出す。パラメータ$resultにはnullが、$strategyには受け取った内容が, $site_idにはサイトIDが格納されている。$pre = apply_filters( 'pre_count_users', $result, $strategy, $site_id );アクション
実行するアクションはありません。ソースファイル
/wp-includes/user.php最終更新 : 2019年03月01日 13:51
関連
お勧め
Contact Form 7に確認フェーズを（2012年12月16日 更新）
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript（jQuery）を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。投稿一覧に独自リンクを追加する（2013年10月16日 更新）
管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。HTML編集モードに定型文ボタンを追加する（2011年6月1日 更新）
投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。投稿日の検索が自由自在に（2015年3月7日 更新）
WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス（もちろん query_posts関数でも）で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。
プラグインのヘッダー情報を国際化対応しよう（2018年5月27日 更新）
バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。