问题描述

有没有办法使用 wp_enqueue_script() 进行内联脚本?

我这样做是因为我的内联脚本取决于另一个脚本,我想要在加载后插入它的灵活性。

此外,它是一个内联脚本,因为我将 PHP 变量传入 javascript(像主题路径等)

提前致谢。

最佳解决方案

那么你有 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' );

这个想法是,您不应该依赖于依赖于脚本的内联脚本,而是后来。

次佳解决方案

只是不要使它成为一个内联脚本,然后将动态参数传递给它作为变量。奥托有 written a great guide 如何有效地做到这一点。

WordPress 3.3 也将使这个更强大:https://core.trac.wordpress.org/ticket/11520

第三种解决方案

该解决方案类似于 @ 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$jsn</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 版本,这可以很容易地转换为类。

第四种方案

我发现更好的方法是使用 wp_localize_script(),如 @scribu 所建议的。

通常,我决定使用 in-line Javascript,因为我需要为我的脚本提供一些 PHP 变量。这可以用 wp_localize_script()来解决。我将举一个例子:

您有一个数组 $aFoo 与一些选项,并需要传递给一个脚本。

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

使用 in-line 脚本:

<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)

这样你就不需要 in-line 脚本了。

第五种方案

scribu 是完全正确的。无论如何,我想添加一些信息:

我希望我的函数输出一个脚本一次,无论它多久被调用。它是一个 content-related 功能,所以我不能等待任何钩子。我使用 scribus 信息和一些阅读 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);

使用这种方法我可以打印一个内联的脚本一次。在我的情况下,我有一个功能创建一个 share-button,需要一个脚本来执行所有的按钮。但只有一次。

第六种方案

由于 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' );
}

参考文献

注:本文内容整合自 Google/Baidu/Bing 辅助翻译的英文资料结果。如果您对结果不满意,可以加入我们改善翻译效果:薇晓朵技术论坛。