Как использовать get_template_part() для подключения файла в плагине?

@s_ha_dum прав в том, что get_template_part — это функция темы, но он ошибается, утверждая, что плагины не предназначены для расширения таким образом. Просто это более сложно.

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

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

Как уже упоминалось ранее, вы не можете использовать get_template_part в плагинах, но на GitHub есть удобный класс (созданный Gary Jones), который имитирует функциональность get_template_part в плагинах, добавляя плагин в цепочку резервных вариантов (дочерняя тема > родительская тема > плагин).

Таким образом, вы можете переопределить «часть шаблона» вашего плагина внутри дочерней или родительской темы.

Использование (взято из инструкций на GitHub репозитории):

1. Скопируйте class-gamajo-template-loader.php в ваш плагин. Это может быть файл в корне плагина или, что лучше, в директории includes.
2. Создайте новый файл, например class-your-plugin-template-loader.php, в той же директории.
3. Создайте class в этом файле, который наследует Gamajo_Template_Loader.
4. Переопределите свойства класса в соответствии с вашим плагином. Вы также можете переопределить метод get_templates_dir(), если он вам не подходит.
5. Теперь вы можете создать экземпляр вашего пользовательского класса загрузчика шаблонов и использовать его для вызова метода get_template_part(). Это может быть внутри обработчика шорткода или того, что вы хотите, чтобы разработчики тем включали в свои файлы.

Пример кода:

// Экземпляр загрузчика шаблонов создан где-то ещё, например, в основном файле плагина.
$meal_planner_template_loader = new Meal_Planner_Template_Loader;

// Используйте его для вызова метода get_template_part(). Это может быть внутри 
// обработчика шорткода или того, что вы хотите, чтобы разработчики тем 
// включали в свои файлы.
$meal_planner_template_loader->get_template_part( 'recipe' );

// Если вы хотите передать данные в шаблон, вызовите метод set_template_data() 
// с массивом перед вызовом get_template_part().        
// set_template_data() возвращает объект загрузчика для цепочки вызовов методов.
$data = array( 'foo' => 'bar', 'baz' => 'boom' );

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

// Значение bar теперь доступно внутри шаблона recipe как $data->foo.
// Если вы хотите использовать другое имя переменной, добавьте второй параметр 
// в set_template_data():
$data = array( 'foo' => 'bar', 'baz' => 'boom' );

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

// Значение bar теперь доступно внутри шаблона recipe как $context->foo.