Come includere un file usando get_template_part() in un plugin?

@s_ha_dum ha ragione sul fatto che get_template_part sia una funzione del tema, ma si sbaglia nell'affermare che i plugin non sono pensati per essere estesi in questo modo. È semplicemente più complicato.

Questo articolo di Pippin, descrive come utilizzare una funzione che si occuperà di caricare i template del tuo plugin, consentendo agli utenti di sovrascrivere i template del plugin all'interno del loro tema.

In sostanza, cerca in una cartella speciale del tema, poi se non trova nulla lì, cerca nella cartella dei template del plugin.

Come detto in precedenza, non puoi utilizzare get_template_part nei plugin, ma esiste una classe utile su Github (creata da Gary Jones) che emula la funzionalità di get_template_part nei plugin, aggiungendo il plugin alla gerarchia di fallback (child theme > parent theme > plugin).

In questo modo, puoi sovrascrivere i "template part" del tuo plugin all'interno di un child theme o di un parent theme.

Utilizzo (tratto dalle istruzioni del repository Github):

1. Copia class-gamajo-template-loader.php nel tuo plugin. Può essere inserito in un file nella root del plugin o, meglio ancora, in una directory includes.
2. Crea un nuovo file, ad esempio class-your-plugin-template-loader.php, nella stessa directory.
3. Crea una class in quel file che estende Gamajo_Template_Loader.
4. Sovrascrivi le proprietà della classe per adattarle al tuo plugin. Potresti anche sovrascrivere il metodo get_templates_dir() se non è adatto alle tue esigenze.
5. Ora puoi istanziare la tua classe personalizzata di template loader e utilizzarla per chiamare il metodo get_template_part(). Questo potrebbe essere all'interno di un callback di uno shortcode o qualcosa che vuoi che gli sviluppatori di temi includano nei loro file.

Codice di esempio:

// Template loader istanziato altrove, ad esempio nel file principale del plugin.
$meal_planner_template_loader = new Meal_Planner_Template_Loader;

// Usalo per chiamare il metodo get_template_part(). Questo potrebbe essere 
// all'interno di un callback di uno shortcode o qualcosa che vuoi 
// che gli sviluppatori di temi includano nei loro file.
$meal_planner_template_loader->get_template_part( 'recipe' );

// Se vuoi passare dati al template, chiama il metodo set_template_data() 
// con un array prima di chiamare get_template_part().        
// set_template_data() restituisce l'oggetto loader per permettere il method chaining.
$data = array( 'foo' => 'bar', 'baz' => 'boom' );

$meal_planner_template_loader
    ->set_template_data( $data );
    ->get_template_part( 'recipe' );

// Il valore di bar è ora disponibile all'interno del template recipe come $data->foo.
// Se desideri utilizzare un nome di variabile diverso, aggiungi un secondo parametro 
// a set_template_data():
$data = array( 'foo' => 'bar', 'baz' => 'boom' );

$meal_planner_template_loader
    ->set_template_data( $data, 'context' )
    ->get_template_part( 'recipe', 'ingredients' );

// Il valore di bar è ora disponibile all'interno del template recipe come $context->foo.