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


お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

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

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。