Przekazywanie zmiennej do get_template_part

55

WP Codex mówi , aby to zrobić:

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

Ale jak mogę znaleźć się echo $my_varw części szablonu? get_query_var($my_var)nie działa dla mnie.

Widziałem mnóstwo rekomendacji do używania locate_templatezamiast tego. Czy to najlepsza droga?

Florian
źródło
Miałem o to samo pytanie i mam go do pracy z set_query_var, a get_query_varjednak to było za korzystanie z wartości z $argstablicy, która jest przekazywana do WP_Query. Może być pomocny dla innych osób, które zaczynają się tego uczyć.
lowtechsun

Odpowiedzi:

53

Ponieważ posty są konfigurowane przez the_post()(odpowiednio przez setup_postdata()) i dlatego są dostępne przez API ( get_the_ID()na przykład), załóżmy, że zapętlamy zestaw użytkowników (ponieważ setup_userdata()wypełnia zmienne globalne aktualnie zalogowanego użytkownika i nie jest przydatne w tym zadaniu) i spróbuj wyświetlić metadane dla każdego użytkownika:

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

Następnie w naszym wpse-theme/template-parts/user-contact_methods.phppliku musimy uzyskać dostęp do identyfikatora użytkownika:

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

Otóż ​​to.

Wyjaśnienie znajduje się dokładnie nad częścią, którą zacytowałeś w swoim pytaniu:

Jednak load_template()wywoływane pośrednio przez get_template_part()wypakowanie wszystkich WP_Queryzmiennych zapytania do zakresu załadowanego szablonu.

Natywna extract()funkcja PHP „wyodrębnia” zmienne ( global $wp_query->query_varswłaściwość) i umieszcza każdą część w swojej zmiennej, która ma dokładnie taką samą nazwę jak klucz. Innymi słowy:

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'
kajzer
źródło
1
wciąż działa świetnie
huraji
23

hm_get_template_partFunkcji przez humanmade jest bardzo dobry w tym i używam go cały czas.

Ty dzwonisz

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

a następnie w szablonie używasz

$template_args['option'];

aby zwrócić wartość. Buforuje i wszystko, choć możesz to wyjąć, jeśli chcesz.

Możesz nawet zwrócić renderowany szablon jako ciąg znaków, przekazując 'return' => truego do tablicy klucz / wartość.

/**
 * 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
źródło
Czy dołączyć do projektu 1300 wierszy kodu (z github HM), aby przekazać jeden parametr do szablonu? Nie mogę tego zrobić w moim projekcie :(
Gediminas
11

Rozglądałem się i znalazłem różne odpowiedzi. Wydaje się, że na poziomie natywnym Wordpress pozwala na dostęp do zmiennych w częściach szablonu. Przekonałem się, że użycie parametru include w połączeniu z locate_template pozwoliło na dostęp do zakresu zmiennych w pliku.

include(locate_template('your-template-name.php'));
Murray Chapman
źródło
Używanie includenie przejdzie kontroli .
lowtechsun
Czy naprawdę potrzebujemy czegoś podobnego do sprawdzania W3C dla motywów 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"

Polecam przeczytać o funkcji PHP Extract ().

Hugo R.
źródło
2

Ten sam problem natrafiłem na projekt, nad którym obecnie pracuję. Postanowiłem stworzyć własną małą wtyczkę, która pozwala bardziej jawnie przekazywać zmienne do get_template_part przy użyciu nowej funkcji.

Jeśli okaże się to przydatne, oto strona na GitHub: https://github.com/JolekPress/Get-Template-Part-With-Variables

A oto przykład, jak to by działało:

$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
źródło
1

Lubię wtyczkę Pods i ich funkcję pods_view . Działa podobnie do hm_get_template_partfunkcji wymienionej w odpowiedzi djb. Korzystam z dodatkowej funkcji ( findTemplatew poniższym kodzie), aby najpierw wyszukać plik szablonu w bieżącym motywie, a jeśli nie zostanie znaleziony, zwraca szablon o tej samej nazwie w /templatesfolderze mojej wtyczki . To jest przybliżony pomysł tego, jak używam pods_vieww mojej wtyczce:

/**
 * 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_viewobsługuje również buforowanie, ale nie potrzebowałem tego do moich celów. Więcej informacji na temat argumentów funkcji można znaleźć na stronach dokumentacji modułu Pods. Zobacz strony dotyczące pods_view i Częściowego buforowania stron oraz inteligentnych części szablonu z zasobnikami .

Trzeci
źródło
1

Na podstawie odpowiedzi @djb przy użyciu kodu stworzonego przez człowieka.

Jest to lekka wersja get_template_part, która może akceptować argumenty. W ten sposób zmienne są skalowane lokalnie do tego szablonu. Nie trzeba mieć 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();
}

Na przykład w cart.php:

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

W apple.php:

<p>The apple color is: <?php echo $args['color']; ?></p>
Veedka
źródło
0

Co powiesz na to?

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

Za pomocą ${$key}można dodać zmienne do bieżącego zakresu funkcji. Działa dla mnie szybko i łatwo i nie przecieka ani nie jest przechowywana w globalnym zasięgu.

Mattijs
źródło
0

Dla tych, którzy wyglądają na bardzo łatwy sposób na przekazywanie zmiennych, możesz zmienić funkcję na:

include (locate_template („YourTemplate.php”, false, false));

I wtedy będziesz mógł używać wszystkich zmiennych, które są zdefiniowane przed dołączeniem szablonu bez PASOWANIA, dodatkowo każdej dla szablonu.

Kredyty trafiają do: https://mekshq.com/passing-variables-via-get_template_part-wordpress/

Giedymina
źródło