%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* Template and theme collector.
*
* @package query-monitor
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
class QM_Collector_Theme extends QM_Collector {
/**
* @var string
*/
public $id = 'response';
/**
* @var bool
*/
protected $got_theme_compat = false;
/**
* @return void
*/
public function set_up() {
parent::set_up();
add_filter( 'body_class', array( $this, 'filter_body_class' ), 9999 );
add_filter( 'timber/output', array( $this, 'filter_timber_output' ), 9999, 3 );
add_action( 'template_redirect', array( $this, 'action_template_redirect' ) );
add_action( 'get_template_part', array( $this, 'action_get_template_part' ), 10, 3 );
add_action( 'render_block_core_template_part_post', array( $this, 'action_render_block_core_template_part_post' ), 10, 3 );
add_action( 'render_block_core_template_part_file', array( $this, 'action_render_block_core_template_part_file' ), 10, 3 );
add_action( 'render_block_core_template_part_none', array( $this, 'action_render_block_core_template_part_none' ), 10, 3 );
}
/**
* @return void
*/
public function tear_down() {
remove_filter( 'body_class', array( $this, 'filter_body_class' ), 9999 );
remove_filter( 'timber/output', array( $this, 'filter_timber_output' ), 9999 );
remove_action( 'template_redirect', array( $this, 'action_template_redirect' ) );
remove_action( 'get_template_part', array( $this, 'action_get_template_part' ), 10 );
remove_action( 'render_block_core_template_part_post', array( $this, 'action_render_block_core_template_part_post' ), 10 );
remove_action( 'render_block_core_template_part_file', array( $this, 'action_render_block_core_template_part_file' ), 10 );
remove_action( 'render_block_core_template_part_none', array( $this, 'action_render_block_core_template_part_none' ), 10 );
parent::tear_down();
}
/**
* @return array<int, string>
*/
public function get_concerned_actions() {
return array(
'template_redirect',
);
}
/**
* @return array<int, string>
*/
public function get_concerned_filters() {
$filters = array(
'stylesheet',
'stylesheet_directory',
'template',
'template_directory',
'template_include',
);
foreach ( self::get_query_filter_names() as $filter ) {
$filters[] = $filter;
$filters[] = "{$filter}_hierarchy";
}
return $filters;
}
/**
* @return array<int, string>
*/
public function get_concerned_options() {
return array(
'stylesheet',
'template',
);
}
/**
* @return string[]
*/
public static function get_query_template_names() {
$names = array();
$names['embed'] = 'is_embed';
$names['404'] = 'is_404';
$names['search'] = 'is_search';
$names['front_page'] = 'is_front_page';
$names['home'] = 'is_home';
if ( function_exists( 'is_privacy_policy' ) ) {
$names['privacy_policy'] = 'is_privacy_policy';
}
$names['post_type_archive'] = 'is_post_type_archive';
$names['taxonomy'] = 'is_tax';
$names['attachment'] = 'is_attachment';
$names['single'] = 'is_single';
$names['page'] = 'is_page';
$names['singular'] = 'is_singular';
$names['category'] = 'is_category';
$names['tag'] = 'is_tag';
$names['author'] = 'is_author';
$names['date'] = 'is_date';
$names['archive'] = 'is_archive';
$names['index'] = '__return_true';
return $names;
}
/**
* @return string[]
*/
public static function get_query_filter_names() {
$names = array();
$names['embed'] = 'embed_template';
$names['404'] = '404_template';
$names['search'] = 'search_template';
$names['front_page'] = 'frontpage_template';
$names['home'] = 'home_template';
if ( function_exists( 'is_privacy_policy' ) ) {
$names['privacy_policy'] = 'privacypolicy_template';
}
$names['taxonomy'] = 'taxonomy_template';
$names['attachment'] = 'attachment_template';
$names['single'] = 'single_template';
$names['page'] = 'page_template';
$names['singular'] = 'singular_template';
$names['category'] = 'category_template';
$names['tag'] = 'tag_template';
$names['author'] = 'author_template';
$names['date'] = 'date_template';
$names['archive'] = 'archive_template';
$names['index'] = 'index_template';
return $names;
}
/**
* @return void
*/
public function action_template_redirect() {
add_filter( 'template_include', array( $this, 'filter_template_include' ), PHP_INT_MAX );
foreach ( self::get_query_template_names() as $template => $conditional ) {
// If a matching theme-compat file is found, further conditional checks won't occur in template-loader.php
if ( $this->got_theme_compat ) {
break;
}
$get_template = "get_{$template}_template";
if ( function_exists( $conditional ) && function_exists( $get_template ) && call_user_func( $conditional ) ) {
$filter = str_replace( '_', '', $template );
add_filter( "{$filter}_template_hierarchy", array( $this, 'filter_template_hierarchy' ), PHP_INT_MAX );
call_user_func( $get_template );
remove_filter( "{$filter}_template_hierarchy", array( $this, 'filter_template_hierarchy' ), PHP_INT_MAX );
}
}
}
/**
* Fires before a template part is loaded.
*
* @param string $slug The slug name for the generic template.
* @param string $name The name of the specialized template.
* @param string[] $templates Array of template files to search for, in order.
* @return void
*/
public function action_get_template_part( $slug, $name, $templates ) {
$data = compact( 'slug', 'name', 'templates' );
$trace = new QM_Backtrace( array(
'ignore_hook' => array(
current_filter() => true,
),
) );
$data['caller'] = $trace->get_caller();
$this->data['requested_template_parts'][] = $data;
}
/**
* Fires when a post is loaded for a template part block.
*
* @param string $template_part_id
* @param mixed[] $attributes
* @param WP_Post $post
* @return void
*/
public function action_render_block_core_template_part_post( $template_part_id, $attributes, WP_Post $post ) {
$data = array(
'id' => $template_part_id,
'attributes' => $attributes,
'post' => $post->ID,
);
$this->data['requested_template_part_posts'][] = $data;
}
/**
* Fires when a file is loaded for a template part block.
*
* @param string $template_part_id
* @param mixed[] $attributes
* @param string $template_part_file_path
* @return void
*/
public function action_render_block_core_template_part_file( $template_part_id, $attributes, $template_part_file_path ) {
$data = array(
'id' => $template_part_id,
'attributes' => $attributes,
'path' => $template_part_file_path,
);
$this->data['requested_template_part_files'][] = $data;
}
/**
* Fires when neither a post nor file is found for a template part block.
*
* @param string $template_part_id
* @param mixed[] $attributes
* @param string $template_part_file_path
* @return void
*/
public function action_render_block_core_template_part_none( $template_part_id, $attributes, $template_part_file_path ) {
$data = array(
'id' => $template_part_id,
'attributes' => $attributes,
'path' => $template_part_file_path,
);
$this->data['requested_template_part_nopes'][] = $data;
}
/**
* @param array<int, string> $templates
* @return array<int, string>
*/
public function filter_template_hierarchy( array $templates ) {
if ( ! isset( $this->data['template_hierarchy'] ) ) {
$this->data['template_hierarchy'] = array();
}
foreach ( $templates as $template_name ) {
if ( file_exists( ABSPATH . WPINC . '/theme-compat/' . $template_name ) ) {
$this->got_theme_compat = true;
break;
}
}
$this->data['template_hierarchy'] = array_merge( $this->data['template_hierarchy'], $templates );
return $templates;
}
/**
* @param array<int, string> $class
* @return array<int, string>
*/
public function filter_body_class( array $class ) {
$this->data['body_class'] = $class;
return $class;
}
/**
* @param array<int, string> $template_path
* @return array<int, string>
*/
public function filter_template_include( $template_path ) {
$this->data['template_path'] = $template_path;
return $template_path;
}
/**
* @param mixed[] $output
* @param mixed $data
* @param string $file
* @return mixed[]
*/
public function filter_timber_output( $output, $data = null, $file = null ) {
if ( $file ) {
$this->data['timber_files'][] = $file;
}
return $output;
}
/**
* @return void
*/
public function process() {
$stylesheet_directory = QM_Util::standard_dir( get_stylesheet_directory() );
$template_directory = QM_Util::standard_dir( get_template_directory() );
$theme_directory = QM_Util::standard_dir( get_theme_root() );
if ( isset( $this->data['template_hierarchy'] ) ) {
$this->data['template_hierarchy'] = array_unique( $this->data['template_hierarchy'] );
}
$this->data['has_template_part_action'] = function_exists( 'wp_body_open' );
if ( $this->data['has_template_part_action'] ) {
// Since WP 5.2, the `get_template_part` action populates this data nicely:
if ( ! empty( $this->data['requested_template_parts'] ) ) {
$this->data['template_parts'] = array();
$this->data['theme_template_parts'] = array();
$this->data['count_template_parts'] = array();
foreach ( $this->data['requested_template_parts'] as $part ) {
$file = locate_template( $part['templates'] );
if ( ! $file ) {
$this->data['unsuccessful_template_parts'][] = $part;
continue;
}
$file = QM_Util::standard_dir( $file );
if ( isset( $this->data['count_template_parts'][ $file ] ) ) {
$this->data['count_template_parts'][ $file ]++;
continue;
}
$this->data['count_template_parts'][ $file ] = 1;
$filename = str_replace( array(
$stylesheet_directory,
$template_directory,
), '', $file );
$display = trim( $filename, '/' );
$theme_display = trim( str_replace( $theme_directory, '', $file ), '/' );
$this->data['template_parts'][ $file ] = $display;
$this->data['theme_template_parts'][ $file ] = $theme_display;
}
}
} else {
// Prior to WP 5.2, we need to look into `get_included_files()` and do our best to figure out
// if each one is a template part:
foreach ( get_included_files() as $file ) {
$file = QM_Util::standard_dir( $file );
$filename = str_replace( array(
$stylesheet_directory,
$template_directory,
), '', $file );
if ( $filename !== $file ) {
$slug = trim( str_replace( '.php', '', $filename ), '/' );
$display = trim( $filename, '/' );
$theme_display = trim( str_replace( $theme_directory, '', $file ), '/' );
$count = did_action( "get_template_part_{$slug}" );
if ( $count ) {
$this->data['template_parts'][ $file ] = $display;
$this->data['theme_template_parts'][ $file ] = $theme_display;
$this->data['count_template_parts'][ $file ] = $count;
} else {
$slug = trim( preg_replace( '|\-[^\-]+$|', '', $slug ), '/' );
$count = did_action( "get_template_part_{$slug}" );
if ( $count ) {
$this->data['template_parts'][ $file ] = $display;
$this->data['theme_template_parts'][ $file ] = $theme_display;
$this->data['count_template_parts'][ $file ] = $count;
}
}
}
}
}
if (
! empty( $this->data['requested_template_part_posts'] ) ||
! empty( $this->data['requested_template_part_files'] ) ||
! empty( $this->data['requested_template_part_nopes'] )
) {
$this->data['template_parts'] = array();
$this->data['theme_template_parts'] = array();
$this->data['count_template_parts'] = array();
$posts = ! empty( $this->data['requested_template_part_posts'] ) ? $this->data['requested_template_part_posts'] : array();
$files = ! empty( $this->data['requested_template_part_files'] ) ? $this->data['requested_template_part_files'] : array();
$nopes = ! empty( $this->data['requested_template_part_nopes'] ) ? $this->data['requested_template_part_nopes'] : array();
$this->data['has_template_part_action'] = true;
$all = array_merge( $posts, $files, $nopes );
foreach ( $all as $part ) {
$file = isset( $part['path'] ) ? $part['path'] : $part['post'];
if ( isset( $this->data['count_template_parts'][ $file ] ) ) {
$this->data['count_template_parts'][ $file ]++;
continue;
}
$this->data['count_template_parts'][ $file ] = 1;
if ( isset( $part['post'] ) ) {
$display = sprintf(
'%1$s (post ID %2$d)',
$part['id'],
$part['post']
);
$theme_display = $display;
} else {
$file = QM_Util::standard_dir( $file );
$filename = str_replace( array(
$stylesheet_directory,
$template_directory,
), '', $file );
$display = trim( $filename, '/' );
$theme_display = trim( str_replace( $theme_directory, '', $file ), '/' );
}
$this->data['template_parts'][ $file ] = $display;
$this->data['theme_template_parts'][ $file ] = $theme_display;
}
}
if ( ! empty( $this->data['template_path'] ) ) {
$template_path = QM_Util::standard_dir( $this->data['template_path'] );
$template_file = str_replace( array( $stylesheet_directory, $template_directory, ABSPATH ), '', $template_path );
$template_file = ltrim( $template_file, '/' );
$theme_template_file = str_replace( array( $theme_directory, ABSPATH ), '', $template_path );
$theme_template_file = ltrim( $theme_template_file, '/' );
$this->data['template_path'] = $template_path;
$this->data['template_file'] = $template_file;
$this->data['theme_template_file'] = $theme_template_file;
}
$this->data['stylesheet'] = get_stylesheet();
$this->data['template'] = get_template();
$this->data['is_child_theme'] = ( $this->data['stylesheet'] !== $this->data['template'] );
if ( isset( $this->data['body_class'] ) ) {
asort( $this->data['body_class'] );
}
}
}
/**
* @param array<string, QM_Collector> $collectors
* @param QueryMonitor $qm
* @return array<string, QM_Collector>
*/
function register_qm_collector_theme( array $collectors, QueryMonitor $qm ) {
$collectors['response'] = new QM_Collector_Theme();
return $collectors;
}
if ( ! is_admin() ) {
add_filter( 'qm/collectors', 'register_qm_collector_theme', 10, 2 );
}
Zerion Mini Shell 1.0