enfileiramento wp script embutido devido a dependências

35

Existe uma maneira de usar wp_enqueue_script () para scripts embutidos?

Estou fazendo isso porque meu script embutido depende de outro script e eu gostaria da flexibilidade de inseri-lo após o carregamento.

Além disso, é um script embutido porque estou passando variáveis ​​php para o javascript (como caminho do tema, etc.)

Desde já, obrigado.

chrisjlee
fonte

Respostas:

33

Bem, você tem wp_localize_script (), mas isso é apenas para transmitir dados.

Caso contrário, você pode fazer isso:

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

A idéia é que você não deve confiar no seu script embutido sendo impresso exatamente após o script em que ele depende, mas mais tarde.

scribu
fonte
4
Certamente isso só funciona se o script que você está dependendo já tiver sido produzido? Se o script do qual você depende também estiver registrado no wp_footer e for executado após o código do script inline, o script inline simplesmente não será gravado no cliente e, portanto, executado?
Sam Peacey
6
A partir do wordpress 4.5, você pode usar o wp_add_inline_script() wp_add_inline_script com o wordpress jquery
Dhinju Divakaran
7

Essa solução é semelhante à resposta do @ scribu , mas segue a forma de wp_enquque_script(), e colocará o script no cabeçalho se suas dependências estiverem incluídas no cabeçalho.

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

Nota: isso usa o uso de funções anônimas, mas para versões do PHP anteriores à 5.3, isso pode ser facilmente convertido em uma classe.

Stephen M. Harris
fonte
5

Desde o WordPress 4.5, você pode usar 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
fonte
4

A melhor maneira que eu encontrei é usando wp_localize_script() , como sugeriu @scribu.

Geralmente, eu decidia usar o Javascript em linha porque precisava fornecer algumas variáveis ​​PHP ao meu script. Isso pode ser resolvido com wp_localize_script(). Vou dar um exemplo:

Você tem uma matriz $aFoocom algumas opções e precisa transmiti-la para um script.

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

Usando script em linha:

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

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

Então, pathToScript/script.jsseria:

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

Dessa forma, você não precisa mais de scripts em linha.

Manolo
fonte
3

scribu está absolutamente correto. De qualquer forma, quero adicionar algumas informações:

Quero que minha função produza um script uma vez, não importa com que frequência seja chamado. É uma função relacionada ao conteúdo, por isso não posso esperar por nenhum gancho. Usei informações do scribus e algumas leituras do núcleo do WP para fazer isso:

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

Usando esse método, sou capaz de imprimir um script embutido uma vez. No meu caso, tenho uma função que cria um botão de compartilhamento e precisa de um script para ser executado para todos os botões. Mas apenas uma vez.

Julian F. Weinert
fonte
A echoabordagem do script embutido é como o tema dos vinte e dezessete foi construído, pelo menos em um ponto. E eu uso essa técnica também. Funciona muito bem e permite conectar-se a lugares diferentes.
Josh Habdas