class-template.php
<?php
/**
* Template component.
*
* @package HivePress\Components
*/
namespace HivePress\Components;
use HivePress\Helpers as hp;
use HivePress\Blocks;
use HivePress\Menus;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;
/**
* Handles template rendering.
*/
final class Template extends Component {
/**
* Class constructor.
*
* @param array $args Component arguments.
*/
public function __construct( $args = [] ) {
// Set template title.
add_action( 'hivepress/v1/models/post/update', [ $this, 'set_template_title' ], 10, 2 );
// Add menu shortcode.
add_shortcode( 'hivepress_menu', [ $this, 'render_menu' ] );
if ( is_admin() ) {
// Add admin columns.
add_filter( 'manage_hp_template_posts_columns', [ $this, 'add_admin_columns' ] );
} else {
// Add theme class.
add_filter( 'body_class', [ $this, 'add_theme_class' ] );
// Add menu items.
add_filter( 'wp_nav_menu_items', [ $this, 'add_menu_items' ], 10, 2 );
add_filter( 'wp_page_menu', [ $this, 'add_menu_items' ], 10, 2 );
// Render site header.
add_action( 'storefront_header', [ $this, 'render_site_header' ], 31 );
// @deprecated since version 1.3.0.
add_action( 'hivetheme/v1/render/site_header', [ $this, 'render_site_header' ] );
// Render site footer.
add_action( 'wp_footer', [ $this, 'render_site_footer' ] );
// Remove theme header.
add_filter( 'twentynineteen_can_show_post_thumbnail', [ $this, 'remove_theme_header' ] );
add_filter( 'ocean_display_page_header', [ $this, 'remove_theme_header' ] );
}
parent::__construct( $args );
}
/**
* Fetches template block.
*
* @param array $template Template blocks.
* @param string $name Block name.
* @param bool $remove Remove block?
* @return array
*/
public function fetch_block( &$template, $name, $remove = true ) {
return hp\get_first_array_value( $this->fetch_blocks( $template, [ $name ], $remove ) );
}
/**
* Fetches template blocks.
*
* @param array $template Template blocks.
* @param array $names Block names.
* @param bool $remove Remove block?
* @return array
*/
public function fetch_blocks( &$template, $names, $remove = true ) {
if ( isset( $template['blocks'] ) ) {
return $this->_fetch_blocks( $template['blocks'], $names, $remove );
}
return $this->_fetch_blocks( $template, $names, $remove );
}
protected function _fetch_blocks( &$template, &$names, $remove ) {
$blocks = [];
foreach ( $template as $name => $block ) {
if ( ! $names ) {
break;
}
$index = array_search( $name, $names );
if ( false !== $index ) {
$blocks[ $name ] = $block;
if ( $remove ) {
unset( $template[ $name ] );
}
unset( $names[ $index ] );
} elseif ( isset( $block['blocks'] ) ) {
$blocks += $this->_fetch_blocks( $template[ $name ]['blocks'], $names, $remove );
}
}
return $blocks;
}
/**
* Merges template blocks.
*
* @param array $template Template blocks.
* @param array $blocks Blocks to merge.
* @return array
*/
public function merge_blocks( &$template, $blocks ) {
if ( isset( $template['blocks'] ) ) {
$template['blocks'] = $this->_merge_blocks( $template['blocks'], $blocks );
} else {
$template = $this->_merge_blocks( $template, $blocks );
}
return $template;
}
protected function _merge_blocks( &$template, &$blocks ) {
$names = array_keys( $blocks );
foreach ( $template as $name => $block ) {
if ( ! $names ) {
break;
}
$index = array_search( $name, $names );
if ( false !== $index ) {
$template[ $name ] = hp\merge_arrays( $template[ $name ], $blocks[ $name ] );
unset( $blocks[ $name ] );
unset( $names[ $index ] );
} elseif ( isset( $block['blocks'] ) ) {
$template[ $name ]['blocks'] = $this->_merge_blocks( $template[ $name ]['blocks'], $blocks );
}
}
return $template;
}
/**
* Sets template title.
*
* @param int $post_id Post ID.
* @param string $post_type Post type.
*/
public function set_template_title( $post_id, $post_type ) {
// Check post type.
if ( 'hp_template' !== $post_type ) {
return;
}
// Get post.
$post = get_post( $post_id );
// Get template.
$template = '\HivePress\Templates\\' . $post->post_name;
if ( ! class_exists( $template ) || ! $template::get_meta( 'label' ) ) {
return;
}
// Update title.
if ( $post->post_title !== $template::get_meta( 'label' ) ) {
wp_update_post(
[
'ID' => $post->ID,
'post_title' => $template::get_meta( 'label' ),
]
);
}
}
/**
* Adds admin columns.
*
* @param array $columns Columns.
* @return array
*/
public function add_admin_columns( $columns ) {
$columns['title'] = esc_html__( 'Template', 'hivepress' );
return $columns;
}
/**
* Adds theme class.
*
* @param array $classes Body classes.
* @return array
*/
public function add_theme_class( $classes ) {
// Add theme class.
$classes[] = 'hp-theme--' . hp\sanitize_slug( get_template() );
// Add template classes.
$route = hivepress()->router->get_current_route_name();
if ( $route ) {
$template = '\HivePress\Templates\\' . $route;
if ( class_exists( $template ) ) {
$classes[] = 'hp-template';
foreach ( array_slice( hp\get_class_parents( $template ), 2 ) as $class ) {
$classes[] = 'hp-template--' . hp\sanitize_slug( hp\get_class_name( $class ) );
}
}
}
return $classes;
}
/**
* Adds menu items.
*
* @param string $items Menu items.
* @param mixed $args Menu arguments.
* @return string
*/
public function add_menu_items( $items, $args ) {
// Check menu.
if ( ! function_exists( 'hivetheme' ) ) {
remove_filter( 'wp_nav_menu_items', [ $this, 'add_menu_items' ], 10, 2 );
remove_filter( 'wp_page_menu', [ $this, 'add_menu_items' ], 10, 2 );
} elseif ( hp\get_array_value( (array) $args, 'theme_location' ) !== 'header' ) {
return $items;
}
// Get class.
$class = 'menu-item menu-item--first';
if ( is_user_logged_in() ) {
$class .= ' menu-item--user-account menu-item-has-children';
} else {
$class .= ' menu-item--user-login';
}
// Render items.
$first_item = '<li class="' . esc_attr( $class ) . '">';
$first_item .= ( new Blocks\Part(
[
'path' => 'user/login/user-login-link',
]
) )->render();
if ( is_user_logged_in() ) {
// Render menu.
$first_item .= ( new Menus\User_Account(
[
'wrap' => false,
'attributes' => [
'class' => [ 'sub-menu' ],
],
]
) )->render();
}
$first_item .= '</li>';
$last_item = str_replace( 'menu-item--first', 'menu-item--last', $first_item );
// Add item.
$items = substr_replace( $items, $first_item, (int) strpos( $items, '<li' ), 0 );
$items = substr_replace( $items, $last_item, strrpos( $items, '/li>' ) + 4, 0 );
return $items;
}
/**
* Renders HivePress menu.
*/
public function render_menu() {
return ( new Blocks\Template( [ 'template' => 'site_header_block' ] ) )->render();
}
/**
* Renders site header.
*/
public function render_site_header() {
echo $this->render_menu();
}
/**
* Renders site footer.
*/
public function render_site_footer() {
echo ( new Blocks\Template( [ 'template' => 'site_footer_block' ] ) )->render();
}
/**
* Removes theme header.
*
* @param bool $display Display theme header?
* @return bool
*/
public function remove_theme_header( $display ) {
if ( hivepress()->router->get_current_route_name() ) {
$display = false;
}
return $display;
}
}
