wp_insert_site()


WordPressのwp_insert_site()関数は、新しいサイトをネットワーク(マルチサイト)に追加するために使用されます。この関数は、サイトの詳細を配列として受け取り、新しいサイトを作成します。

構文

wp_insert_site( array $args );

引数の説明:

  • $args (array) — 新しいサイトの設定を含む配列。以下のキーを持つことができます:
    • domain (string) — サイトのドメイン。
    • path (string) — サイトのパス。
    • title (string) — サイトのタイトル。
    • user_id (int) — サイトの管理者ユーザーID。
    • meta (array) — サイトメタデータの配列。
    • network_id (int) — ネットワークID(デフォルトは現在のネットワーク)。

例1: 基本的なサイトの追加

新しいサイトをネットワークに追加する基本的な例です。

wp_insert_site( array( 'domain' => 'example.com', 'path' => '/', 'title' => '新しいサイト' ) );

例2: 管理者ユーザーを指定してサイトを追加

特定のユーザーを管理者としてサイトを追加します。

wp_insert_site( array( 'domain' => 'example.com', 'path' => '/blog', 'title' => 'ブログサイト', 'user_id' => get_current_user_id() ) );

例3: カスタムメタデータ付きでサイトを追加

サイトにメタデータを追加して作成します。

wp_insert_site( array( 'domain' => 'example.com', 'path' => '/shop', 'title' => 'オンラインショップ', 'meta' => array( 'language' => 'ja' ) ) );

例4: 特定のネットワークにサイトを追加

ネットワークIDを指定してサイトを作成します。

wp_insert_site( array( 'domain' => 'example.com', 'path' => '/news', 'title' => 'ニュースサイト', 'network_id' => 2 ) );

例5: パスを指定してサブディレクトリサイトを追加

カスタムパスを持つサイトを追加します。

wp_insert_site( array( 'domain' => 'example.com', 'path' => '/subdir', 'title' => 'サブディレクトリサイト' ) );

例6: 空のタイトルでサイトを追加

タイトルを指定せずにサイトを追加します(デフォルト値が使用されます)。

wp_insert_site( array( 'domain' => 'example.com', 'path' => '/empty' ) );

例7: すべての引数を使用してサイトを追加

すべての利用可能な引数を使用してサイトを作成します。

wp_insert_site( array( 'domain' => 'example.com', 'path' => '/full', 'title' => '完全なサイト', 'user_id' => 1, 'meta' => array( 'template' => 'custom' ), 'network_id' => 1 ) );

注意点

  • この関数はマルチサイト環境でのみ使用可能です。
  • 必要な権限(manage_sites)を持っている必要があります。
  • ドメインとパスの組み合わせは一意である必要があります。

関連機能: