説明
パラメータ
- $args検索条件を配列または文字列を指定(省略時はarray())。主なキーワードは次の通り。
キーワード 意味 count trueの場合はリストではなくサイト数を返す(省略時は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_id site_idを指定(省略時は0)。 network__in site_idの配列を指定(省略時は'')。 network__not_in 除外するsite_idの配列を指定(省略時は'')。 domain domainを指定(省略時は'')。 domain__in domainの配列を指定(省略時は'')。 domain__not_in 除外するdomainの配列を指定(省略時は'')。 path pathを指定(省略時は'')。 path__in pathの配列を指定(省略時は'')。 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の配列を指定(省略時は'')。 public publicの値として1か0を指定(省略時はnull)。 archived archivedの値として1か0を指定(省略時はnull)。 mature matureの値として1か0を指定(省略時はnull)。 spam spamの値として1か0を指定(省略時はnull)。 deleted deletedの値として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
お勧め
個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。