wp_register()


WordPress関数wp_register()は、WordPress内でスクリプトやスタイルシートを登録するために使用されます。この関数を使用すると、テーマやプラグインでリソースの読み込みを効率的に管理できます。

シンタックス

wp_register( string $handle, string $src, array $deps = array(), string|bool|null $ver = false, string $media = 'all' );

引数の説明:

  • $handle (string) — 登録するスクリプトまたはスタイルの一意の名前。
  • $src (string) — スクリプトやスタイルのURL。
  • $deps (array) — 依存関係として必要な他のスクリプトまたはスタイルのハンドル。
  • $ver (string|bool|null) — バージョン番号。省略時はWordPressのバージョンが使用されます。
  • $media (string) — スタイルのメディアタイプ。デフォルトは'all'。

例 1: 基本的なスクリプト登録

スクリプトを登録する基本的な例。

<?php wp_register( 'custom-script', get_template_directory_uri() . '/js/custom.js', array( 'jquery' ), '1.0', false ); ?>

例 2: スタイルシートの登録

テーマでスタイルシートを登録する場合。

<?php wp_register( 'custom-style', get_template_directory_uri() . '/css/custom.css', array(), '1.0', 'all' ); ?>

例 3: 依存関係を指定してスクリプトを登録

依存関係を持つスクリプトを登録する例。

<?php wp_register( 'custom-script', get_template_directory_uri() . '/js/custom.js', array( 'jquery', 'wp-util' ), null, true ); ?>

例 4: 登録したスクリプトをキューに追加

登録したスクリプトをキューに追加して使用。

<?php
wp_register( 'custom-script', get_template_directory_uri() . '/js/custom.js' );
wp_enqueue_script( 'custom-script' );
?>

例 5: 条件に応じてスクリプトを登録

特定の条件でのみスクリプトを登録する例。

<?php
if ( is_single() ) {
    wp_register( 'single-post-script', get_template_directory_uri() . '/js/single.js' );
    wp_enqueue_script( 'single-post-script' );
}
?>

注意事項

登録したスクリプトやスタイルはwp_enqueue_script()やwp_enqueue_style()でキューに追加しない限り、実際には出力されません。効率的に管理するためには、wp_register()とwp_enqueue_script()を組み合わせて使用してください。

関連機能：