説明
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
関連
お勧め
meta_compare_key使ってみた（2019年3月19日 更新）
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。
WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。
テーマから投稿画像のサイズを指定する（2012年3月15日 更新）
投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。ログインページを変える（2014年9月12日 更新）
WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）
ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。