wp enqueue wbudowany skrypt ze względu na zależności

35

Czy istnieje sposób użycia wp_enqueue_script () dla skryptów wbudowanych?

Robię to, ponieważ mój skrypt wbudowany zależy od innego skryptu i chciałbym mieć elastyczność wstawiania go po załadowaniu.

Ponadto jest to skrypt wbudowany, ponieważ przekazuję zmienne php do javascript (np. Ścieżka motywu itp.)

Z góry dziękuję.

chrisjlee
źródło

Odpowiedzi:

33

Masz wp_localize_script (), ale to tylko do przekazywania danych.

W przeciwnym razie możesz to zrobić:

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

Chodzi o to, że nie powinieneś polegać na drukowaniu wbudowanego skryptu dokładnie po skrypcie, od którego zależy, ale później.

scribu
źródło
4
Z pewnością działa to tylko wtedy, gdy skrypt, na którym polegasz, został już wygenerowany? Jeśli skrypt, od którego zależysz, jest również zarejestrowany w wp_footer i wykonuje się po wbudowanym kodzie skryptu, skrypt wbudowany po prostu nie zostanie zapisany w kliencie, a tym samym wykonany?
Sam Peacey
6
Począwszy od wordpress 4.5 możesz używać wp_add_inline_script() wp_add_inline_script z wordpress jquery
Dhinju Divakaran
7

Rozwiązanie to jest podobne do @ scribu za odpowiedź , ale wynika formę wp_enquque_script()i będzie umieścić skrypt w nagłówku, jeżeli jego zależności są zawarte w nagłówku.

/**
 * 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'));

Uwaga: używa to anonimowych funkcji, ale w wersjach PHP wcześniejszych niż 5.3 można to łatwo przekształcić w klasę.

Stephen M. Harris
źródło
5

Od WordPress 4.5 możesz używać 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' );
}
cybmeta
źródło
4

Lepszym sposobem, jaki znalazłem, jest używanie wp_localize_script(), jak sugerował @scribu.

Zazwyczaj decydowałem się na użycie wbudowanego Javascript, ponieważ musiałem podać kilka zmiennych PHP do mojego skryptu. Można to rozwiązać za pomocą wp_localize_script(). Podam przykład:

Masz tablicę $aFooz kilkoma opcjami i musisz przekazać ją do skryptu.

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

Za pomocą skryptu wbudowanego:

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

Używanie 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' );    

Wtedy pathToScript/script.jsbyłoby:

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

W ten sposób nie potrzebujesz już skryptów wbudowanych.

Manolo
źródło
3

scribu ma absolutną rację. W każdym razie chcę dodać informacje:

Chcę, aby moja funkcja wypisała skrypt raz, bez względu na to, jak często jest wywoływany. Jest to funkcja związana z treścią, więc nie mogę się doczekać żadnych haków. Użyłem informacji o skryptach i przeczytaniu rdzenia WP, aby wymyślić:

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

Korzystając z tej metody, mogę raz wydrukować skrypt wbudowany. W moim przypadku mam funkcję, która tworzy przycisk udostępniania i wymaga wykonania jednego skryptu dla wszystkich przycisków. Ale tylko raz.

Julian F. Weinert
źródło
echoPodejście skrypt inline jest jak motyw Twenty Siedemnaście została skonstruowana, przynajmniej w jednym punkcie. I również używam tej techniki. Działa świetnie i pozwala zaczepić się w różnych miejscach.
Josh Habdas