説明
array | int get_sites( [ string | array $args = array() ] )
サイトID(ブログID)またはサイト数を取得する。
パラメータ
- $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
お勧め
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。
テーマから投稿画像のサイズを指定する(2012年3月15日 更新)
投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。ログインページを変える(2014年9月12日 更新)
WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)
ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。