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

回答:


53

投稿はthe_post()(それぞれsetup_postdata())を介してデータを設定し、したがって(get_the_ID()たとえば)APIを介してアクセスできるので、一連のユーザーをループしていると仮定します(現在ログインしているユーザーの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
まだ素晴らしい仕事をしている
フラジ

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

1つのパラメーターをテンプレートに渡すために、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_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_viewおよび部分的なページキャッシングとポッドを使用したスマートテンプレートパーツのページを参照してください。


1

humanmadeのコードを使用した@djbからの回答に基づいています。

これは、引数を受け入れることができる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}することにより、変数を現在の関数スコープに追加できます。迅速かつ簡単に機能し、漏れたり、グローバルスコープに保存されたりすることはありません。


0

変数を渡す非常に簡単な方法を探している人のために、以下を含むように関数を変更できます:

include(Locate_template( 'YourTemplate.php'、false、false));

そして、テンプレートの各変数を追加で渡すことなく、テンプレートを含める前に定義されたすべての変数を使用できます。

クレジット:https : //mekshq.com/passing-variables-via-get_template_part-wordpress/


弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.