get_query_template

Получает путь до указанного файла шаблона. Указывается тип запроса: index, category, 404 и т.д.

Используется для быстрого получения пути файла шаблона, расширение файла при этом указывать не надо. При поиске файла учитывается дочерняя тема (см. locate_template()).

get_query_template() – это основа для функций типа get_*_template():
  • get_index_template()
  • get_404_template()
  • get_archive_template()
  • get_post_type_archive_template()
  • get_author_template()
  • get_category_template()
  • get_tag_template()
  • get_taxonomy_template()
  • get_date_template()
  • get_home_template()
  • get_front_page_template()
  • get_page_template()
  • get_paged_template()
  • get_search_template()
  • get_single_template()
  • get_singular_template()
  • get_attachment_template()
  • get_comments_popup_template()

Подробнее о том при каком запросе, какой файл может быть подключен читайте в отдельной статье: Иерархия файлов темы (шаблона)


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

✈ 1 раз = 0.000085с = очень быстро | 50000 раз = 0.49с = очень быстро
Хуки из функции:
(type)_template
(type)_template_hierarchy
Возвращает

Строку. Серверный путь до файла шаблона. Если файл не удалось найти, то вернет пустую строку.

Использование

get_query_template( $type, $templates );
$type(строка) (обязательный)

Название файла без расширения (.php). Название может быть любым, но оно должно содержать только: строчные буквы лат.алфавита, цифры и ([^a-z0-9-]).
Предустановленные типы файлов (смотрите иерархию файлов):

  • index
  • 404
  • archive
  • post_type_archive
  • author
  • category
  • tag
  • taxonomy
  • date
  • home
  • front_page
  • page
  • paged
  • search
  • single
  • singular
  • attachment
  • comments_popup
$templates(массив)

Необязательный список кандидатов на файл шаблона (указывается название файла с расширением).

Если указать этот параметр, то предыдущий параметр $type будет проигнорирован и он будет использоваться только в фильтре. А название файла будет подбираться на основе этого параметра, с помощью функции locate_template().

По умолчанию: array()

Примеры

#1 Подключим файл шаблона 404

if ( '' != get_query_template( '404' ) )
	   include( get_query_template( '404' ) );

// тоже самое можно записать так:
if ( '' != get_404_template() )
	include( get_404_template() );

#2 Что выводит функция

echo get_query_template( 'category' );
// получим: /home/public_html/wp-content/themes/theme-name/category.php

// можно указать произвольное название и если такой файл есть 
// в родительской/дочерней теме то функция вернет его путь:
echo get_query_template( 'foo' );
// получим: /home/public_html/wp-content/themes/theme-name/foo.php

#2 Попробуем получить один из файлов шаблона

Указав второй параметр мы одновременно используем функцию locate_template() и указываем тип получаемого файла, к которому могут подключаться плагины через фильтр:

echo get_query_template( 'category', array('mycat.php','mycat2.php') );

/* получим:
/home/public_html/wp-content/themes/theme-name/mycat.php
если такого файла нет, будет проверен файл 'mycat2.php'
/home/public_html/wp-content/themes/theme-name/mycat2.php
*/

Код из


wp-includes/template.php

WP 4.7.2

<?php
function get_query_template( $type, $templates = array() ) {
	$type = preg_replace( '|[^a-z0-9-]+|', '', $type );

	if ( empty( $templates ) )
		$templates = array("{$type}.php");

	/**
	 * Filters the list of template filenames that are searched for when retrieving a template to use.
	 *
	 * The last element in the array should always be the fallback template for this query type.
	 *
	 * Possible values for `$type` include: 'index', '404', 'archive', 'author', 'category', 'tag', 'taxonomy', 'date',
	 * 'embed', home', 'frontpage', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
	 *
	 * @since 4.7.0
	 *
	 * @param array $templates A list of template candidates, in descending order of priority.
	 */
	$templates = apply_filters( "{$type}_template_hierarchy", $templates );

	$template = locate_template( $templates );

	/**
	 * Filters the path of the queried template by type.
	 *
	 * The dynamic portion of the hook name, `$type`, refers to the filename -- minus the file
	 * extension and any non-alphanumeric characters delimiting words -- of the file to load.
	 * This hook also applies to various types of files loaded as part of the Template Hierarchy.
	 *
	 * Possible values for `$type` include: 'index', '404', 'archive', 'author', 'category', 'tag', 'taxonomy', 'date',
	 * 'embed', home', 'frontpage', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
	 *
	 * @since 1.5.0
	 *
	 * @param string $template Path to the template. See locate_template().
	 */
	return apply_filters( "{$type}_template", $template );
}

Комментарии:


Оставить комментарий

Your email address will not be published. Required fields are marked *