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


お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

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

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

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。