count_users

（3.0.0以降）
count_users - 役割別のユーザ数を取得する

説明

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

参考

Code Reference: count_users

お勧め

投稿内容のid属性などを保存するための対策（2012年6月15日更新）

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった（id属性が保存できなくなった）。ここでは、その対策方法の1つを紹介しておく。

WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日更新）

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。

4.4では投稿ページも専用テンプレートが適用できる（2018年5月27日更新）

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

Google Mapsブロックを作る過程で悩んだ件（2022年8月23日更新）

自分なりのGoogle Mapsブロックを作るべく、カスタムHTMLブロックをベースにいくつかのパラメータ要素をサイドバーに追加していく。Google Maps用のAPIキーについてはオプションデータ（wp_optionsテーブル）に格納して利用していこうと思ったのだが、その方法がさっぱりわからなかった。

Popoverコンポーネントのanchorプロパティについて考えたときのメモ（2024年8月19日更新）

カスタムブロックやコアブロック向けのプラグインでお世話になるPopoverコンポーネント。表示位置を決定する上で大きく影響するのがanchorプロパティである。フィルターのコールバック関数で対象ブロックに干渉できない場合はどうしたらよいのだろうか。

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧め