説明
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
関連
お勧め
WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧（2018年5月27日 更新）
WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。
ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。wp_titleからwp_get_document_titleへ（2018年5月27日 更新）
先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
検索ワード「-10,000円」を検索できるようにしたい（2018年5月27日 更新）
とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。
ダッシュボードのフィードボックスをカスタマイズ（2011年7月8日 更新）
管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する（管理者権限）。