web-dev-qa-db-ja.com

wp依存関係のためインラインスクリプトをエンキューする

インラインスクリプトにwp_enqueue_script（）を使用する方法はありますか？

私のインラインスクリプトは他のスクリプトに依存しているのでこれをやっています、そしてそれがロードされた後にそれを挿入する柔軟性を望みます。

また、これはインラインスクリプトです。なぜなら私はphp変数をjavascriptに渡しているからです（テーマパスなど）。

前もって感謝します。

wp-enqueue-script
35
chrisjlee

さて、あなたはwp_localize_script（）を持っています、しかしそれはデータを渡すためだけです。

そうでなければ、これを行うことができます：

function print_my_inline_script() {
  if ( wp_script_is( 'some-script-handle', 'done' ) ) {
?>
<script type="text/javascript">
// js code goes here
</script>
<?php
  }
}
add_action( 'wp_footer', 'print_my_inline_script' );

その考えは、インラインスクリプトが依存しているスクリプトの後に 正確に 印刷されていることに頼るべきではないということです。

33
scribu

この解決策は@ scribuの answer に似ていますが、wp_enquque_script()の形式に従い、依存関係がヘッダーに含まれている場合はスクリプトをヘッダーに配置します。

/**
 * Enqueue inline Javascript. @see wp_enqueue_script().
 * 
 * KNOWN BUG: Inline scripts cannot be enqueued before 
 *  any inline scripts it depends on, (unless they are
 *  placed in header, and the dependant in footer).
 * 
 * @param string      $handle    Identifying name for script
 * @param string      $src       The JavaScript code
 * @param array       $deps      (optional) Array of script names on which this script depends
 * @param bool        $in_footer (optional) Whether to enqueue the script before </head> or before </body> 
 * 
 * @return null
 */
function enqueue_inline_script( $handle, $js, $deps = array(), $in_footer = false ){
    // Callback for printing inline script.
    $cb = function()use( $handle, $js ){
        // Ensure script is only included once.
        if( wp_script_is( $handle, 'done' ) )
            return;
        // Print script & mark it as included.
        echo "<script type=\"text/javascript\" id=\"js-$handle\">\n$js\n</script>\n";
        global $wp_scripts;
        $wp_scripts->done[] = $handle;
    };
    // (`wp_print_scripts` is called in header and footer, but $cb has re-inclusion protection.)
    $hook = $in_footer ? 'wp_print_footer_scripts' : 'wp_print_scripts';

    // If no dependencies, simply hook into header or footer.
    if( empty($deps)){
        add_action( $hook, $cb );
        return;
    }

    // Delay printing script until all dependencies have been included.
    $cb_maybe = function()use( $deps, $in_footer, $cb, &$cb_maybe ){
        foreach( $deps as &$dep ){
            if( !wp_script_is( $dep, 'done' ) ){
                // Dependencies not included in head, try again in footer.
                if( ! $in_footer ){
                    add_action( 'wp_print_footer_scripts', $cb_maybe, 11 );
                }
                else{
                    // Dependencies were not included in `wp_head` or `wp_footer`.
                }
                return;
            }
        }
        call_user_func( $cb );
    };
    add_action( $hook, $cb_maybe, 0 );
}

// Usage
enqueue_inline_script('test','alert(\'enqueue inline script test\');',array( 'jquery'));

注：これは無名関数を使用しますが、バージョン5.3より前のPHPでは、これはクラスに簡単に変換できます。

7
Stephen M. Harris

インラインスクリプトにしないで、動的パラメータを変数として渡してください。 Ottoは これを効果的に行う方法についての素晴らしいガイドを書いています 。

WordPress 3.3もこれをより強力にするでしょう： https://core.trac.wordpress.org/ticket/11520

7
Viper007Bond

WordPress 4.5以降、 wp_add_inline_script（） を使用できます。

add_action( 'wp_enqueue_scripts', 'cyb_enqueue_scripts' );
function cyb_enqueue_scripts() {
   wp_enqueue_script( 'myscript', 'url/to/myscript.js', array(), '1.0' );
   wp_add_inline_script( 'myscript', 'Your inline javascript code gos here' );
}
5
cybmeta

@ scribuが示唆しているように、私が見つけたもっと良い方法はwp_localize_script()を使うことです。

通常、スクリプトにPHP変数をいくつか指定する必要があるため、インラインJavascriptを使用することにしました。これはwp_localize_script()で解決できます。例を挙げます。

いくつかのオプションを持つ配列$aFooがあり、それをスクリプトに渡す必要があります。

$aFoo = array( 'option1' => $option1Value, 'option2' => $option2Value );

インラインスクリプトを使用する：

<script> 
    var oFoo = {};
    oFoo.option1 = <?php echo $aFoo['option1'] ?>;  
    oFoo.option2 = <?php echo $aFoo['option2'] ?>;            
    //do some stuff with oFoo
</script>

wp_localize_script()を使う：

wp_register_script( 'script_name', 'pathToScript/script.js', array( 'jquery' )); //if jQuery is not needed just remove the last argument. 
wp_localize_script( 'script_name', 'object_name', $aFoo ); //pass 'object_name' to script.js
wp_enqueue_script( 'script_name' );

その場合、pathToScript/script.jsは次のようになります。

var oFoo = {};
oFoo.option1 = object_name.option1;   
oFoo.option2 = object_name.option2;            
//do some stuff with oFoo (no PHP needed)

このように、あなたはもうインラインスクリプトを必要としません。

4
Manolo

scribuは絶対に正しいです。とにかく、私はいくつかの情報を追加したいです。

スクリプトの呼び出し頻度に関係なく、関数にスクリプトを1回出力させたいのです。これはコンテンツ関連の機能なので、フックを待つことはできません。私はこれを思いつくためにスクライブ情報とWPコアのいくつかの読書を使いました：

function print_script_once() {
    if(!wp_script_is('my-handle', 'done')) {
        echo "<script>alert('once!');</script>";
        global $wp_scripts;
        $wp_scripts->done[] = 'my-handle';
    }
}
add_action('get_footer', print_script_once);

この方法を使うと、インラインスクリプトを一度印刷することができます。私の場合、共有ボタンを作成し、すべてのボタンに対して1つのスクリプトを実行する必要がある関数があります。しかし一度だけ。

3
Julian F. Weinert