wp_set_template_globals() の説明と使用例

WordPressのwp_set_template_globals()関数は、テンプレート内で使用されるグローバル変数を設定するために使用されます。この関数は、テーマやプラグイン開発者がテンプレート内でグローバル変数を簡単に設定できるようにします。

構文

wp_set_template_globals( array $globals );

$globals(array) — テンプレート内で使用するグローバル変数の配列。

例1: 基本的なグローバル変数の設定

この例では、テンプレート内で使用するグローバル変数を設定します。

wp_set_template_globals( array( 'custom_var' => 'Hello, World!' ) );

例2: 複数のグローバル変数の設定

複数のグローバル変数を一度に設定する例です。

wp_set_template_globals( array( 'var1' => 'Value1', 'var2' => 'Value2' ) );

例3: テンプレート内でのグローバル変数の使用

設定したグローバル変数をテンプレート内で使用する例です。

global $custom_var; echo $custom_var;

例4: 条件付きでグローバル変数を設定

条件に基づいてグローバル変数を設定する例です。

if ( is_page() ) { wp_set_template_globals( array( 'page_var' => 'This is a page' ) ); }

例5: ループ内でのグローバル変数の設定

ループ内でグローバル変数を設定する例です。

while ( have_posts() ) { the_post(); wp_set_template_globals( array( 'post_title' => get_the_title() ) ); }

例6: ショートコード内での使用

ショートコード内でグローバル変数を設定する例です。

function my_shortcode() { wp_set_template_globals( array( 'shortcode_var' => 'Shortcode Value' ) ); return ''; } add_shortcode( 'my_shortcode', 'my_shortcode' );

例7: フィルターフックとの連携

フィルターフックを使用してグローバル変数を設定する例です。

add_filter( 'wp_set_template_globals', function( $globals ) { $globals['filtered_var'] = 'Filtered Value'; return $globals; } );

例8: グローバル変数の上書き

既存のグローバル変数を上書きする例です。

wp_set_template_globals( array( 'existing_var' => 'New Value' ) );

注意点

グローバル変数を多用すると、コードの可読性が低下する可能性があります。
テンプレート内でグローバル変数を使用する際は、変数が正しく設定されていることを確認してください。

構文