Передача переменной в get_template_part

55

WP Кодекс говорит , чтобы сделать это:

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

Но как я могу echo $my_varвнутри части шаблона? get_query_var($my_var)не работает для меня.

Я видел множество рекомендаций для использования locate_templateвместо этого. Это лучший путь?

Florian
источник
Если бы примерно такой же вопрос и получил его на работу с set_query_varи get_query_var, тем не менее это было для использования значений в $argsмассиве , который передается к WP_Query. Может быть полезно для других людей, начинающих изучать это.
lowtechsun

Ответы:

53

Поскольку сообщения получают свои данные через the_post()(соответственно через setup_postdata()) и, следовательно, становятся доступными через API ( get_the_ID()например, для), давайте предположим, что мы выполняем цикл через набор пользователей (поскольку setup_userdata()заполняет глобальные переменные текущего пользователя, вошедшего в систему, и isn ' t полезно для этой задачи) и попробуйте отобразить метаданные для пользователя:

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

Затем в нашем wpse-theme/template-parts/user-contact_methods.phpфайле нам нужно получить доступ к идентификатору пользователя:

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

Вот и все.

Объяснение на самом деле точно выше той части, которую вы указали в своем вопросе:

Однако, load_template()который вызывается косвенным путем, get_template_part()извлекает все WP_Queryпеременные запроса в область загруженного шаблона.

Нативная extract()функция PHP «извлекает» переменные ( global $wp_query->query_varsсвойство) и помещает каждую часть в свою собственную переменную, имя которой точно совпадает с именем ключа. Другими словами:

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'
кайзер
источник
1
все еще работает отлично
Хураджи
23

hm_get_template_partФункция от humanmade очень хорош в этом , и я использую его все время.

Ты звонишь

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

а затем внутри вашего шаблона, вы используете

$template_args['option'];

вернуть значение. Это делает кэширование и все такое, хотя вы можете убрать это, если хотите.

Вы даже можете вернуть обработанный шаблон в виде строки, передав 'return' => trueв массив ключ / значение.

/**
 * 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
источник
Включите 1300 строк кода (из github HM) в проект, чтобы передать один параметр в шаблон? Не могу сделать это в моем проекте :(
Гедиминас
11

Я искал вокруг и нашел множество ответов. Кажется, на родном уровне Wordpress допускает доступ к переменным в частях шаблона. Я обнаружил, что использование include в сочетании с locate_template позволило сделать доступными переменные области в файле.

include(locate_template('your-template-name.php'));
Мюррей Чепмен
источник
Использование includeне пройдет проверку темы .
lowtechsun
Нужно ли нам что-то вроде проверки W3C для 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"

Рекомендую прочитать о функции PHP Extract ().

Хьюго Р
источник
2

Я столкнулся с той же проблемой в проекте, над которым я сейчас работаю. Я решил создать свой собственный небольшой плагин, который позволит вам более явно передавать переменные в get_template_part с помощью новой функции.

Если это может оказаться полезным, вот страница для этого на GitHub: https://github.com/JolekPress/Get-Template-Part-With-Variables

И вот пример того, как это будет работать:

$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>
Джон О
источник
1

Я как стручки плагинов и их pods_view функции. Он работает аналогично hm_get_template_partфункции, упомянутой в ответе djb. Я использую дополнительную функцию ( findTemplateв коде ниже), чтобы сначала найти файл шаблона в текущей теме, и если он не найден, он возвращает шаблон с тем же именем в /templatesпапке моего плагина . Это грубое представление о том, как я использую pods_viewв своем плагине:

/**
 * 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_viewтакже поддерживает кэширование, но мне это не нужно для моих целей. Дополнительную информацию об аргументах функции можно найти на страницах документации Pods. См. Страницы для pods_view и частичного кэширования страниц и частей смарт-шаблонов с модулями .

thirdender
источник
1

Основано на ответе @djb с использованием кода от человека.

Это облегченная версия get_template_part, которая может принимать аргументы. Таким образом, переменные локально ограничиваются этим шаблоном. Нет необходимости иметь 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();
}

Например в cart.php:

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

В apple.php:

<p>The apple color is: <?php echo $args['color']; ?></p>
Veedka
источник
0

Как насчет этого?

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

Используя ${$key}вы можете добавить переменные в текущую область функции. Работает для меня, быстро и легко, и это не протекает и не сохраняется в глобальном масштабе.

Mattijs
источник
0

Для тех, кто ищет очень простой способ передачи переменных, вы можете изменить функцию, включив в нее:

include (locate_template ('YourTemplate.php', false, false));

И тогда вы сможете использовать все переменные, которые определены до того, как вы включите шаблон, без дополнительной PASSING, каждая из которых для шаблона.

Кредиты отправляются по адресу : https://mekshq.com/passing-variables-via-get_template_part-wordpress/

Гедиминас
источник