将变量传递给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代替使用。那是最好的方法吗?


曾有相同的问题,并set_query_var工作get_query_var,但是这是为了使用$args传递给数组的数组的值WP_Query。可能会对其他开始学习此方法的人有所帮助。
lowtechsun

Answers:


53

当帖子通过the_post()(分别通过setup_postdata())设置其数据并因此可以通过API get_the_ID()进行访问(例如)时,我们假设我们正在遍历一组用户(因为它setup_userdata()填充了当前登录用户的全局变量,并且对此任务很有用),并尝试按用户显示元数据:

<?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文件中,我们需要访问用户ID:

<?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查询变量提取到加载模板的范围中来间接调用。

本地PHP extract()函数“提取”变量(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
仍然运作良好
Huraji

23

人造hm_get_template_part功能在这方面非常出色,我一直在使用它。

你打电话

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

包括1300行代码(来自github HM)到项目,以将一个参数传递给模板?无法在我的项目中做到这一点:(
Gediminas

11

我环顾四周,发现了各种各样的答案。在本地级别,Wordpress确实允许在模板部分中访问变量。我确实发现结合使用include和locate_template确实可以在文件中访问变量作用域。

include(locate_template('your-template-name.php'));

使用include不会通过themecheck
lowtechsun

我们真的需要像WP主题的W3C检查器之类的东西吗?
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插件及其pods_view函数。它的工作方式类似于hm_get_template_partdjb的答案中提到的功能。我使用附加功能(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部分页面缓存以及带有Pod的智能模板部分的页面


1

基于@djb的答案,使用humanmade的代码。

这是可以接受args的get_template_part的轻量级版本。这样,变量就可以在本地范围内限定于该模板。没有必要有globalget_query_varset_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>

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}您可以将变量添加到当前函数作用域中。为我快速便捷地工作,并且不会泄漏或存储到全局范围内。



By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.