Passando uma variável para get_template_part

55

O WP Codex diz para fazer isso:

// You wish to make $my_var available to the template part at `content-part.php`
set_query_var( 'my_var', $my_var );
get_template_part( 'content', 'part' );

Mas como faço para echo $my_vardentro da parte do modelo? get_query_var($my_var)Nao funciona para mim.

Já vi várias recomendações de uso locate_template. Esse é o melhor caminho a percorrer?

Florian
fonte
Teve a mesma pergunta e conseguiu trabalhar com ela set_query_vare get_query_var, no entanto, isso foi para usar os valores de uma $argsmatriz que é passada para a WP_Query. Pode ser útil para outras pessoas que estão começando a aprender isso.
lowtechsun

Respostas:

53

À medida que as postagens obtêm seus dados configurados via the_post()(respectivamente via setup_postdata()) e, portanto, são acessíveis pela API ( get_the_ID()por exemplo), vamos supor que estamos percorrendo um conjunto de usuários (como setup_userdata()preenche as variáveis ​​globais do usuário conectado no momento e não é ' útil para esta tarefa) e tente exibir metadados por usuário:

<?php
get_header();

// etc.

// In the main template file
$users = new \WP_User_Query( [ ... ] );

foreach ( $users as $user )
{
    set_query_var( 'user_id', absint( $user->ID ) );
    get_template_part( 'template-parts/user', 'contact_methods' );
}

Em seguida, em nosso wpse-theme/template-parts/user-contact_methods.phparquivo, precisamos acessar o ID do usuário:

<?php
/** @var int $user_id */
$some_meta = get_the_author_meta( 'some_meta', $user_id );
var_dump( $some_meta );

É isso aí.

A explicação está exatamente acima da parte que você citou na sua pergunta:

No entanto, load_template()que é chamado indiretamente por get_template_part()extrai todas as WP_Queryvariáveis ​​de consulta, no escopo do modelo carregado.

A extract()função nativa do PHP "extrai" as variáveis ​​(a global $wp_query->query_varspropriedade) e coloca cada parte em sua própria variável, que tem exatamente o mesmo nome da chave. Em outras palavras:

set_query_var( 'foo', 'bar' );

$GLOBALS['wp_query'] (object)
    -> query_vars (array)
        foo => bar (string 3)

extract( $wp_query->query_vars );

var_dump( $foo );
// Result:
(string 3) 'bar'
kaiser
fonte
11
ainda trabalhando muito bem
huraji 11/06
23

A hm_get_template_partfunção do humanmade é extremamente boa nisso e eu a uso o tempo todo.

Você chama

hm_get_template_part( 'template_path', [ 'option' => 'value' ] );

e depois dentro do seu modelo, você usa

$template_args['option'];

para retornar o valor. Faz cache e tudo, embora você possa removê-lo, se quiser.

Você pode até retornar o modelo renderizado como uma string, passando 'return' => truepara a matriz de chave / valor.

/**
 * Like get_template_part() put lets you pass args to the template file
 * Args are available in the tempalte as $template_args array
 * @param string filepart
 * @param mixed wp_args style argument list
 */
function hm_get_template_part( $file, $template_args = array(), $cache_args = array() ) {
    $template_args = wp_parse_args( $template_args );
    $cache_args = wp_parse_args( $cache_args );
    if ( $cache_args ) {
        foreach ( $template_args as $key => $value ) {
            if ( is_scalar( $value ) || is_array( $value ) ) {
                $cache_args[$key] = $value;
            } else if ( is_object( $value ) && method_exists( $value, 'get_id' ) ) {
                $cache_args[$key] = call_user_method( 'get_id', $value );
            }
        }
        if ( ( $cache = wp_cache_get( $file, serialize( $cache_args ) ) ) !== false ) {
            if ( ! empty( $template_args['return'] ) )
                return $cache;
            echo $cache;
            return;
        }
    }
    $file_handle = $file;
    do_action( 'start_operation', 'hm_template_part::' . $file_handle );
    if ( file_exists( get_stylesheet_directory() . '/' . $file . '.php' ) )
        $file = get_stylesheet_directory() . '/' . $file . '.php';
    elseif ( file_exists( get_template_directory() . '/' . $file . '.php' ) )
        $file = get_template_directory() . '/' . $file . '.php';
    ob_start();
    $return = require( $file );
    $data = ob_get_clean();
    do_action( 'end_operation', 'hm_template_part::' . $file_handle );
    if ( $cache_args ) {
        wp_cache_set( $file, $data, serialize( $cache_args ), 3600 );
    }
    if ( ! empty( $template_args['return'] ) )
        if ( $return === false )
            return false;
        else
            return $data;
    echo $data;
}
djb
fonte
Incluir 1300 linhas de código (do github HM) no projeto para passar um parâmetro para um modelo? Não é possível fazer isso no meu projeto :(
Gediminas
11

Eu estava olhando em volta e encontrei uma variedade de respostas. Parece em um nível nativo, o Wordpress permite que variáveis ​​sejam acessadas nas partes do modelo. Eu descobri que o uso do include acoplado ao local_template permitiu que o escopo das variáveis ​​fosse acessível no arquivo.

include(locate_template('your-template-name.php'));
Murray Chapman
fonte
Usar includenão passará na verificação .
lowtechsun
Realmente precisamos de algo parecido com o verificador W3C dos Temas WP?
Fredy31
5
// you can use any value including objects.

set_query_var( 'var_name_to_be_used_later', 'Value to be retrieved later' );
//Basically set_query_var uses PHP extract() function  to do the magic.


then later in the template.
var_dump($var_name_to_be_used_later);
//will print "Value to be retrieved later"

Eu recomendo ler sobre a função PHP Extract ().

Hugo R
fonte
2

Encontrei esse mesmo problema em um projeto no qual estou trabalhando atualmente. Decidi criar meu próprio pequeno plug-in que permite transmitir variáveis ​​de forma mais explícita para get_template_part usando uma nova função.

Caso você ache útil, aqui está a página no GitHub: https://github.com/JolekPress/Get-Template-Part-With-Variables

E aqui está um exemplo de como isso funcionaria:

$variables = [
    'name' => 'John',
    'class' => 'featuredAuthor',
];

jpr_get_template_part_with_vars('author', 'info', $variables);


// In author-info.php:
echo "
<div class='$class'>
    <span>$name</span>
</div>
";

// Would output:
<div class='featuredAuthor'>
    <span>John</span>
</div>
John O
fonte
1

Gosto do plug-in Pods e da função pods_view . Funciona de maneira semelhante à hm_get_template_partfunção mencionada na resposta do djb. Eu uso uma função adicional ( findTemplateno código abaixo) para procurar um arquivo de modelo no tema atual primeiro e, se não for encontrado, ele retorna o modelo com o mesmo nome na /templatespasta do meu plugin . Esta é uma idéia aproximada de como estou usando pods_viewno meu plugin:

/**
 * Helper function to find a template
 */
function findTemplate($filename) {
  // Look first in the theme folder
  $template = locate_template($filename);
  if (!$template) {
    // Otherwise, use the file in our plugin's /templates folder
    $template = dirname(__FILE__) . '/templates/' . $filename;
  }
  return $template;
}

// Output the template 'template-name.php' from either the theme
// folder *or* our plugin's '/template' folder, passing two local
// variables to be available in the template file
pods_view(
  findTemplate('template-name.php'),
  array(
    'passed_variable' => $variable_to_pass,
    'another_variable' => $another_variable,
  )
);

pods_viewtambém suporta cache, mas não era necessário para meus propósitos. Mais informações sobre os argumentos da função podem ser encontradas nas páginas de documentação dos Pods. Consulte as páginas pods_view e cache parcial de páginas e peças de modelo inteligente com pods .

terceiro
fonte
1

Com base na resposta de @djb usando o código de humanmade.

Esta é uma versão leve de get_template_part que pode aceitar argumentos. Dessa forma, as variáveis ​​têm escopo local para esse modelo. Não há necessidade de ter global, get_query_var, set_query_var.

/**
 * Like get_template_part() but lets you pass args to the template file
 * Args are available in the template as $args array.
 * Args can be passed in as url parameters, e.g 'key1=value1&key2=value2'.
 * Args can be passed in as an array, e.g. ['key1' => 'value1', 'key2' => 'value2']
 * Filepath is available in the template as $file string.
 * @param string      $slug The slug name for the generic template.
 * @param string|null $name The name of the specialized template.
 * @param array       $args The arguments passed to the template
 */

function _get_template_part( $slug, $name = null, $args = array() ) {
    if ( isset( $name ) && $name !== 'none' ) $slug = "{$slug}-{$name}.php";
    else $slug = "{$slug}.php";
    $dir = get_template_directory();
    $file = "{$dir}/{$slug}";

    ob_start();
    $args = wp_parse_args( $args );
    $slug = $dir = $name = null;
    require( $file );
    echo ob_get_clean();
}

Por exemplo em cart.php:

<? php _get_template_part( 'components/items/apple', null, ['color' => 'red']); ?>

Em apple.php:

<p>The apple color is: <?php echo $args['color']; ?></p>
Veedka
fonte
0

Que tal agora?

render( 'template-parts/header/header', 'desktop', 
    array( 'user_id' => 555, 'struct' => array( 'test' => array( 1,2 ) ) )
);
function render ( $slug, $name, $arguments ) {

    if ( $arguments ) {
        foreach ( $arguments as $key => $value ) {
                ${$key} = $value;
        }
    }

$name = (string) $name;
if ( '' !== $name ) {
    $templates = "{$slug}-{$name}.php";
    } else {
        $templates = "{$slug}.php";
    }

    $path = get_template_directory() . '/' . $templates;
    if ( file_exists( $path ) ) {
        ob_start();
        require( $path);
        ob_get_clean();
    }
}

Ao usar, ${$key}você pode adicionar as variáveis ​​ao escopo da função atual. Funciona para mim, rápido e fácil e não está vazando ou armazenado no escopo global.

Mattijs
fonte
0

Para quem parece uma maneira muito fácil de passar variáveis, você pode alterar a função para incluir:

include (local_template ('YourTemplate.php', falso, falso));

E então você poderá usar todas as variáveis ​​definidas antes de incluir o modelo sem PASSAR adicionalmente cada uma para o modelo.

Os créditos vão para: https://mekshq.com/passing-variables-via-get_template_part-wordpress/

Gediminas
fonte