Pasando una variable a get_template_part
-
-
Tuve [sobre lamismapregunta y lo hicefuncionar] (https://wordpress.stackexchange.com/questions/270166/pass-a-variable-to-get-template-part) con `set_query_var` y`get_query_var`,sinembargo,estofuepara usar los valores de unamatriz `$ args` que sepasa a una` WP_Query`.Podría ser útilpara otraspersonas que comienzan a aprenderesto.Had [about the same question and got it to work](https://wordpress.stackexchange.com/questions/270166/pass-a-variable-to-get-template-part) with `set_query_var` and `get_query_var`, however this was for using the values of an `$args` array that is passed to a `WP_Query`. Might be helpful for other people starting to learn this.
- 0
- 2017-06-14
- lowtechsun
-
@Florian,consulte https://wordpress.stackexchange.com/a/373230/54986 ymarque como respuesta si corresponde; ahoraes una cosa compatible deprimera clase@Florian please see https://wordpress.stackexchange.com/a/373230/54986 and mark as an answer if appropriate - it's now a first-class supported thing
- 0
- 2020-08-18
- Selrond
-
13 respuestas
- votos
-
- 2015-02-02
Amedida que laspublicaciones obtienen sus datos configurados através de
the_post()
(respectivamente através desetup_postdata()
) y,por lotanto,son accesibles através de la API (get_the_ID()
porejemplo),supongamos queestamos recorriendo un conjunto de usuarios (comosetup_userdata()
llena las variablesglobales del usuario actualmente conectado ynoes útilparaestatarea)e intentamostrarmetadatospor usuario:<?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' ); }
Luego,en nuestro archivo
wpse-theme/template-parts/user-contact_methods.php
,necesitamos acceder al ID de usuario:<?php /** @var int $user_id */ $some_meta = get_the_author_meta( 'some_meta', $user_id ); var_dump( $some_meta );
Esoes.
Laexplicaciónestáexactamenteporencima de laparte que citóen supregunta:
Sinembargo,
load_template()
,quees llamadoindirectamenteporget_template_part()
extraetodas las variables de consultaWP_Query
,en el alcance de laplantilla cargada.Lafunciónnativa PHP
extract()
"extrae" las variables (lapropiedadglobal $wp_query->query_vars
) y coloca cadaparteen supropia variable quetiene exactamenteelmismonombre que la clave. En otraspalabras: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'
As posts get their data set up via
the_post()
(respectively viasetup_postdata()
) and are therefore accessible through the API (get_the_ID()
for e.g.), let's assume that we are looping through a set of users (assetup_userdata()
fills the global variables of the currently logged in user and isn't useful for this task) and try to display meta data per user:<?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' ); }
Then, in our
wpse-theme/template-parts/user-contact_methods.php
file, we need to access the users ID:<?php /** @var int $user_id */ $some_meta = get_the_author_meta( 'some_meta', $user_id ); var_dump( $some_meta );
That's it.
The explanation is actually exactly above the part you quoted in your question:
However,
load_template()
, which is called indirectly byget_template_part()
extracts all of theWP_Query
query variables, into the scope of the loaded template.The native PHP
extract()
function "extracts" the variables (theglobal $wp_query->query_vars
property) and puts every part into its own variable which has exactly the same name as the key. In other words: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'
-
todavíafuncionamuybienstill working great
- 1
- 2019-06-11
- middlelady
-
- 2015-02-04
Lafunción
hm_get_template_part
de humanmade esextremadamentebuenoen esto y lo usotodoeltiempo.Tu llamas
hm_get_template_part( 'template_path', [ 'option' => 'value' ] );
y luego,dentro de suplantilla,usa
$template_args['option'];
para devolverel valor. Haceel almacenamientoen caché ytodo,aunquepuedeeliminarlo si lo desea.
Inclusopuede devolver laplantilla renderizada como una cadenapasando
'return' => true
en lamatriz clave/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; }
The
hm_get_template_part
function by humanmade is extremely good at this and I use it all the time.You call
hm_get_template_part( 'template_path', [ 'option' => 'value' ] );
and then inside your template, you use
$template_args['option'];
to return the value. It does caching and everything, though you can take that out if you like.
You can even return the rendered template as a string by passing
'return' => true
into the key/value array./** * 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; }
-
¿Incluir 1300 líneas de código (degithub HM) alproyectoparapasar unparámetro a unaplantilla?Nopuedo hacerestoen miproyecto :(Include 1300 lines of code(from github HM) to the project to pass one parameter to a template? Can not do this in my project :(
- 1
- 2019-09-04
- Gediminas
-
Puedeincluirel código quepegó arribaen sufunctions.php ...You can just include the code he pasted above to your functions.php...
- 3
- 2019-11-15
- DokiCRO
-
- 2016-06-04
Estabamirando ami alrededor yencontré una variedad de respuestas.Parece a unnivelnativo,Wordpresspermite acceder a las variablesen laspartes de laplantilla.Descubrí queel uso de lainclusiónjunto con laplantilla de localizaciónpermitía queel alcance de las variablesfuera accesibleen el archivo.
include(locate_template('your-template-name.php'));
I was looking around and have found a variety of answers. Its seems at a native level, Wordpress does allow for variables to be accessed in Template parts. I did find that using the include coupled with locate_template did allow for variables scope to be accessible in the file.
include(locate_template('your-template-name.php'));
-
El uso de `include`nopasará [themecheck] (https://github.com/anhskohbo/wp-cli-themecheck).Using `include` won't pass [themecheck](https://github.com/anhskohbo/wp-cli-themecheck).
- 0
- 2017-06-14
- lowtechsun
-
¿Realmentenecesitamos algo que sea comoel verificador W3Cpara WP Themes?Do we really need something that is like the W3C checker for WP Themes?
- 1
- 2019-08-15
- Fredy31
-
- 2017-08-05
// 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"
Recomiendo leer sobre lafunción PHP Extract ().
// 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"
I recommend to read about PHP Extract() function.
-
- 2016-09-11
Meencontré conestemismoproblemaen unproyectoen el queestoytrabajando actualmente.Decidí crearmi propiopequeño complemento quete permitepasar variables demaneramásexplícita aget_template_part usando unanuevafunción.
En caso de que le resulte útil,aquíestá lapáginaen GitHub: https://github.com/JolekPress/Get-Template-Part-With-Variables
Y aquí hay unejemplo de cómofuncionaría:
$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>
I ran into this same issue on a project I'm currently working on. I decided to create my own small plugin that allows you to more explicitly pass variables to get_template_part by using a new function.
In case you might find it useful, here's the page for it on GitHub: https://github.com/JolekPress/Get-Template-Part-With-Variables
And here's an example of how it would work:
$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>
-
- 2020-08-03
Apartir de 5.5 ,seráposiblepasar datos aplantillas através delas diversasfuncionesbásicas de carga deplantillas.
Todas lasfunciones de carga deplantillas de WordPress admitirán unparámetro adicional de
$args
,quepermite a los autores detemaspasar unamatriz asociativa de datos a laplantilla cargada.Lasfunciones que admitenestenuevoparámetro son:get_header() get_footer() get_sidebar() get_template_part() locate_template() load_template()
Cualquiergancho asociado con lasfuncionestambiénpasa los datos.
Para obtenermásinformación: https://make.wordpress.org/core/2020/07/17/passing-arguments-to-template-files-in-wordpress-5-5/
Starting in 5.5, it will be possible to pass data to templates via the various core template-loading functions.
All of the WordPress template-loading functions will support an additional parameter of
$args
, which allows theme authors to pass along an associative array of data to the loaded template. The functions that support this new parameter are:get_header() get_footer() get_sidebar() get_template_part() locate_template() load_template()
Any hooks associated with the functions also pass along the data.
For more information: https://make.wordpress.org/core/2020/07/17/passing-arguments-to-template-files-in-wordpress-5-5/
-
Desafortunadamente,elparámetro `$ args`no seejecuta através de`extract () `así quenecesitará hacer`echo $ args ['foo'] `en laplantilla.Ojalá hubiera una opciónparaextraer los argumentostambién.Unfortunately the `$args` parameter isn't run through `extract()` so you'll need to do `echo $args['foo']` in the template. I wish there was an option to extract the args too.
- 0
- 2020-08-17
- powerbuoy
-
- 2016-08-20
Megustael complemento Pods y su funciónpods_view . Funciona demanera similar a lafunción
hm_get_template_part
mencionadaen la respuesta de djb. Utilizo unafunción adicional (findTemplate
en el código a continuación)parabuscarprimero un archivo deplantillaen eltema actual,y sino seencuentra,devuelve laplantilla conelmismonombreen el/templates
. Estaes unaidea aproximada de cómoestoy usandopods_view
en mi complemento:/** * 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
también admiteel almacenamientoen caché,perono lonecesitabaparamispropósitos. Sepuedeencontrarmásinformación sobre los argumentos de lafunciónen laspáginas de documentación de Pods. Consulte laspáginas de pods_view y Almacenamientoen caché depáginaparcial yelementos deplantillainteligente conpods .I like the Pods plugin and their pods_view function. It works similar to the
hm_get_template_part
function mentioned in djb's answer. I use an additional function (findTemplate
in the code below) to search for a template file in the current theme first, and if not found it returns the template with the same name in my plugin's/templates
folder. This is a rough idea of how I'm usingpods_view
in my 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_view
also supports caching, but I didn't need that for my purposes. More information about the function arguments can be found in the Pods documentation pages. See the pages for pods_view and Partial Page Caching and Smart Template Parts with Pods. -
- 2018-12-18
Basadoen la respuesta de @djb usando código de humanmade.
Estaes una versión ligera deget_template_part quepuede aceptar argumentos. Deestamanera,las variablestienen un alcance localparaesaplantilla. Noesnecesariotener
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(); }
Porejemplo,en
cart.php
:<? php _get_template_part( 'components/items/apple', null, ['color' => 'red']); ?>
En
apple.php
:<p>The apple color is: <?php echo $args['color']; ?></p>
Based on the answer from @djb using code from humanmade.
This is a lightweight version of get_template_part that can accept args. This way variables are scoped locally to that template. No need to have
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(); }
For example in
cart.php
:<? php _get_template_part( 'components/items/apple', null, ['color' => 'red']); ?>
In
apple.php
:<p>The apple color is: <?php echo $args['color']; ?></p>
-
- 2020-08-18
Elparámetro
$args
para lasfunciones de carga deplantillas acaba de llegar a WordPress 5.5 "Eckstine" :Pasar datos a archivos deplantilla
Lasfunciones de carga deplantillas (get_header (),get_template_part (),etc.)tienen unnuevo argumento $ args.Por lotanto,ahorapuedetransferir los datos de unamatriz completa aesasplantillas.
The
$args
parameter for template loading functions has just landed in WordPress 5.5 “Eckstine”:Passing data to template files
The template loading functions (get_header(), get_template_part(), etc.) have a new $args argument. So now you can pass an entire array’s worth of data to those templates.
-
- 2018-06-22
¿Quétalesto?
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(); } }
Al usar
${$key}
puede agregar las variables al alcance de lafunción actual. Funcionaparamí,rápido yfácil yno sefiltrani se almacenaen el alcanceglobal.How about this?
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(); } }
By using
${$key}
you can add the variables into the current function scope. Works for me, quick and easy and its not leaking or stored into the global scope. -
- 2019-09-04
Para aquellos queparecen unaformamuyfácil depasar variables,pueden cambiar lafunciónparaincluir:
include (Locate_template ('YourTemplate.php',false,false));
Y luegopodrá utilizartodas las variables queestán definidas antes deincluir laplantilla sin PASAR adicionalmente cada unapor laplantilla.
Los créditos van a: https://mekshq.com/passing-variables-via-get_template_part-wordpress/
For ones who looks very easy way to pass variables, you can change function to include:
include( locate_template( 'YourTemplate.php', false, false ) );
And then you will be able to use all variables which are defined before you are including template without PASSING additionally each one for the template.
Credits goes to: https://mekshq.com/passing-variables-via-get_template_part-wordpress/
-
- 2020-09-02
Actualización
Como selrond correctamente respondido apartir de Wordpress 5.5 get_template_part () ( ver registro de cambios ) ahora acepta un tercerparámetro
array $args = array()
,queestará disponibleen su archivo deplantilla como$args
.Veaesteejemplo:
$bar = 'bar'; // get helper-my-template.php get_template_part( 'template-parts/helper', 'my-template', array( 'foo' => $bar, // passing this array possible since WP 5.5 ) );
En su archivo deplantilla
p.ej. helper-my-template.php ahorapuede acceder a su variable deestamanera:
<?php /** * @var array $args */ $foo = $args['foo']; ?> <h1><?php echo $foo; ?></h1> <?php // will print 'bar' ?>
Update
As selrond correctly answered as of Wordpress 5.5 get_template_part() (see changelog) now accepts a third parameter
array $args = array()
, which will be available in your template file as$args
.See this example:
$bar = 'bar'; // get helper-my-template.php get_template_part( 'template-parts/helper', 'my-template', array( 'foo' => $bar, // passing this array possible since WP 5.5 ) );
In your template file
e.g. helper-my-template.php you can now access your variable like this:
<?php /** * @var array $args */ $foo = $args['foo']; ?> <h1><?php echo $foo; ?></h1> <?php // will print 'bar' ?>
-
- 2018-01-16
Estaes la soluciónexacta yfuncionóbien. https://developer.wordpress.org/reference/functions/set_query_var/
This is exact solution and it worked well. https://developer.wordpress.org/reference/functions/set_query_var/
El WP Codex dice que hagaesto:
¿Pero cómo
echo $my_var
dentro de laparte de laplantilla?get_query_var($my_var)
nome funciona.En su lugar,he vistotoneladas de recomendacionespara usar
locate_template
.¿Esesa lamejormanera de hacerlo?