wp_script_add_data()


WordPress関数wp_script_add_data()は、登録済みスクリプトのデータ属性を追加または変更するために使用されます。

シンタックス

wp_script_add_data( string $handle, string $key, mixed $value );

引数の説明:

  • $handle (string) — スクリプトのハンドル名。
  • $key (string) — 追加または変更するデータキー。例: 'defer', 'async'
  • $value (mixed) — データキーに対応する値。通常はtrue, falseまたは文字列。

例1: スクリプトにasync属性を追加

以下のコードは、スクリプトにasync属性を追加します。

wp_script_add_data( 'jquery', 'async', true );

例2: スクリプトにdefer属性を追加

以下のコードは、スクリプトにdefer属性を追加します。

wp_script_add_data( 'custom-script', 'defer', true );

例3: スクリプトのカスタムデータを設定

特定のデータキーにカスタム値を設定する例です。

wp_script_add_data( 'example-script', 'data-custom', 'custom-value' );

例4: 条件付きでデータ属性を追加

条件によってasyncまたはdefer属性を動的に追加します。

if ( is_front_page() ) {
    wp_script_add_data( 'home-script', 'async', true );
} else {
    wp_script_add_data( 'home-script', 'defer', true );
}

例5: スクリプトが登録されている場合のみデータを追加

スクリプトが登録済みかを確認してからデータ属性を追加します。

if ( wp_script_is( 'jquery', 'registered' ) ) {
    wp_script_add_data( 'jquery', 'async', true );
}

注意事項

  • $handleは正しく登録されたスクリプトである必要があります。
  • スクリプトが適切にエンキューされていない場合、属性の変更は反映されません。

関連機能: