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


お勧め

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

ブロックエディターをちょっとだけカスタマイズしてみる(2021年11月3日 更新)

ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか(自分好みに)調整してみた。

Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 更新)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。