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



お勧め

ログアウト後はいつもサイトトップ(2018年5月27日 更新)

ログアウト後に表示(リダイレクト)されるページは、標準ではログインページ(wp-login.php)である。4.2.0ではログアウト処理後のページリダイレクト前に呼び出されるフィルターが追加された。

さくらのVPSでKUSANAGI#3(2018年5月27日 更新)

今回は「前回」の続き。http(80番)をクローズ、そのほかに行った調整作業について整理する。

oEmbed対応サイトを整理した(2017年11月18日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

Login rebuilder:プラグイン作ってみました(2019年9月7日 更新)

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。