get_sites

説明

array | int get_sites( [ string | array $args = array() ] )
サイトID(ブログID)またはサイト数を取得する。

パラメータ

  • $args
    検索条件を配列または文字列を指定(省略時はarray())。主なキーワードは次の通り。
    キーワード意味
    counttrueの場合はリストではなくサイト数を返す(省略時はfalse)。
    IDブログID(省略時は'')。
    site__inブログIDの配列(省略時は'')。
    site__not_in除外するブログIDの配列(省略時は'')。
    number取得件数(省略時は100)。
    offset取得開始位置(省略時は'')。
    orderbyソート対象を示すid、domain、path、network_id、last_updated、registered、deleted、mature、spam、archived、publicなど(省略時は'id')。
    orderソート順を示すASCかDESC(省略時は'ASC')。
    network_idsite_idを指定(省略時は0)。
    network__insite_idの配列を指定(省略時は'')。
    network__not_in除外するsite_idの配列を指定(省略時は'')。
    domaindomainを指定(省略時は'')。
    domain__indomainの配列を指定(省略時は'')。
    domain__not_in除外するdomainの配列を指定(省略時は'')。
    pathpathを指定(省略時は'')。
    path__inpathの配列を指定(省略時は'')。
    path__not_in除外するpathの配列を指定(省略時は'')。
    lang_id[4.8.0]lang_idを指定(省略時はnull)。
    lang__in[4.8.0]lang_idの配列を指定(省略時は'')。
    lang__not_in[4.8.0]除外するlang_idの配列を指定(省略時は'')。
    publicpublicの値として1か0を指定(省略時はnull)。
    archivedarchivedの値として1か0を指定(省略時はnull)。
    maturematureの値として1か0を指定(省略時はnull)。
    spamspamの値として1か0を指定(省略時はnull)。
    deleteddeletedの値として1か0を指定(省略時はnull)。

返り値

条件にマッチしたサイトのブログIDを格納した配列(パラメータ$args['count']がtrueの場合はサイト数)を返す。

注意

マルチサイト向けの関数で、wp_blogsテーブルを検索し、マッチしたサイトIDの配列かサイト数を取得する。パラメータnetwork_id、network__in、network__not_inはwp_blogsテーブルのsite_idカラムが検索対象となるので要注意。

[4.8.0]パラメータ$argsに'lang_id'、'lang__in'、'lang__not_in'キーが追加された。


使用例

  • 公開されているサイトIDのリストを取得する
    $sites = get_sites( array( 'public' => 1 ) );
  • サイト数を取得する
    $sites = get_sites( array( 'count' => true ) );

フィルター

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

アクション

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

ソースファイル

/wp-includes/ms-site.php

最終更新 : 2024年04月16日 22:24


お勧め

5.3の新機能:サイト管理者のメールアドレスを定期的に確認する(2019年9月27日 更新)

「WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。

Widgets on dashboard:プラグイン作ってみました(2014年5月7日 更新)

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

Login rebuilder 2.5.0の新機能紹介(2018年12月10日 更新)

今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。

フォーム内のエスケープ処理を考える(2018年10月19日 更新)

WordPressにはエスケープ処理を行う esc_html関数と esc_attr関数がある。HTML要素(タグ)の属性値ならesc_attr関数を、それ以外はesc_html関数を使うことがほとんどだが、今回esc_html関数が適していないと思われるケースに遭遇した。

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

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