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


お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。