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が追加され、マルチサイトの場合に任意のサイトから対象情報を取得できるようになった。


使用例

  • 現在のサイトにて役割別のユーザ数を取得する。
    <?php $users = count_users(); ?>
  • サイトIDが3のサイトから役割別のユーザ数を取得する。
    <?php $users = count_users( 'time', 3 ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/user.php

最終更新 : 2018年05月27日 10:43



お勧め

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

管理者ページに文言を表示する(2012年4月19日 更新)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。