wp_prepare_site_data()


WordPressのwp_prepare_site_data()関数は、サイトデータを配列形式で準備するために使用されます。主にマルチサイト環境で利用され、サイト情報を整理して返します。

構文

wp_prepare_site_data( array $data, WP_Site $site );

引数の説明:

  • $data (array) — サイトデータを含む配列。
  • $site (WP_Site) — WP_Siteオブジェクト。

例1: 基本的なサイトデータの取得

現在のサイトの基本データを取得します。

$site_data = wp_prepare_site_data( array(), get_site() );

例2: カスタムデータの追加

サイトデータにカスタムフィールドを追加します。

$custom_data = array( 'custom_field' => '値' ); $site_data = wp_prepare_site_data( $custom_data, get_site() );

例3: 特定のサイトIDを使用

指定したサイトIDのデータを取得します。

$site_data = wp_prepare_site_data( array(), get_site( 2 ) );

例4: ドメイン情報の取得

サイトのドメイン情報を含むデータを取得します。

$site_data = wp_prepare_site_data( array( 'domain' => '' ), get_site() );

例5: パス情報の追加

サイトのパス情報を明示的に指定します。

$site_data = wp_prepare_site_data( array( 'path' => '/custom-path/' ), get_site() );

例6: サイト名の上書き

サイト名をカスタム値で上書きします。

$site_data = wp_prepare_site_data( array( 'blogname' => 'カスタムサイト名' ), get_site() );

例7: 言語設定の追加

サイトの言語設定を追加します。

$site_data = wp_prepare_site_data( array( 'lang' => 'ja' ), get_site() );

注意点

  • この関数はマルチサイト環境でのみ有効です。
  • データを上書きする場合は既存のキーに注意してください。

関連機能：