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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。