WordPress/wp-includes/blocks/template-part.php

199 lines
7.1 KiB
PHP
Raw Normal View History

<?php
/**
* Server-side rendering of the `core/template-part` block.
*
* @package WordPress
*/
/**
* Renders the `core/template-part` block on the server.
*
* @param array $attributes The block attributes.
*
* @return string The render.
*/
function render_block_core_template_part( $attributes ) {
static $seen_ids = array();
$template_part_id = null;
$content = null;
$area = WP_TEMPLATE_PART_AREA_UNCATEGORIZED;
if (
isset( $attributes['slug'] ) &&
isset( $attributes['theme'] ) &&
wp_get_theme()->get_stylesheet() === $attributes['theme']
) {
$template_part_id = $attributes['theme'] . '//' . $attributes['slug'];
$template_part_query = new WP_Query(
array(
'post_type' => 'wp_template_part',
'post_status' => 'publish',
'post_name__in' => array( $attributes['slug'] ),
'tax_query' => array(
array(
'taxonomy' => 'wp_theme',
'field' => 'slug',
'terms' => $attributes['theme'],
),
),
'posts_per_page' => 1,
'no_found_rows' => true,
)
);
$template_part_post = $template_part_query->have_posts() ? $template_part_query->next_post() : null;
if ( $template_part_post ) {
// A published post might already exist if this template part was customized elsewhere
// or if it's part of a customized template.
$content = $template_part_post->post_content;
$area_terms = get_the_terms( $template_part_post, 'wp_template_part_area' );
if ( ! is_wp_error( $area_terms ) && false !== $area_terms ) {
$area = $area_terms[0]->name;
}
Update @wordpress packages Update packages to include these bug fixes from Gutenberg: - Gallery block: turn on auto-migration of v1 Gallery blocks to v2 format when edited - Add accessible labelling to submenu buttons. - Improve performance of wp_navigation lookup. - Various inline docblock corrections - Use core version of template and template part post types and REST endpoints for WP 5.9, with back compat for 5.8 - Gradients: Enable adding custom gradient when gradients are disabled - Custom color palette: add default color name - Color Picker: Re-instate debounce and controlled value to fix issue with gradient picker - Add aria-current="page" to active navigation item - Site Editor: Templat list fallback to slug - Fix: Custom color picker popover position - Fix: php 5.6 error in theme JSON class. - Update the WP_Theme_JSON_Gutenberg class to be like the core one - Update the WP_Theme_JSON_Resolver_Gutenberg class to be like the core one - Move Global Styles code to lib/compat/wordpress-5.9 folder - E2E Tests: Fix failing image e2e test by waiting for required element - Navigation: Try removing absorb toolbar prop. - Navigation: Fix navigation justifications. - Fix wordbreak for URLs - Polish unset color indicator. - Template revert flow: Make label description source agnostic - [Block Library - Navigation]: Fix vertical layout - Add: Corners to custom color picker popover - Add: Missing margin to the color picker clear button - Gradient: Fix clearing a custom gradient from throwing a React warning - [Block Library]: Rename Query Pagination blocks - PHP Unit Tests: Use global transients - Remove CSS that causes conflict with theme.json - Add actions which fire during the loading process of block template parts - Fix usage of useSetting('color.palette') - Update micromodal, include click-through fix - Site Editor: Remove unused PHP code - Don't try and render unstable location if Nav block has ID - Fix gutenberg prefixed function references in core - Card: support the extraSmall option for the size prop - Gallery block: enable the new gallery block by default if running in core - Block fixtures: Change port to 8889 to placate KSES - Full Site Editing: Remove block template resolution unit tests - Site Editor: Sync export API See #54487. Built from https://develop.svn.wordpress.org/trunk@52324 git-svn-id: http://core.svn.wordpress.org/trunk@51916 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-12-06 01:20:27 -05:00
/**
* Fires when a block template part is loaded from a template post stored in the database.
*
* @since 5.9.0
*
* @param string $template_part_id The requested template part namespaced to the theme.
* @param array $attributes The block attributes.
* @param WP_Post $template_part_post The template part post object.
* @param string $content The template part content.
*/
do_action( 'render_block_core_template_part_post', $template_part_id, $attributes, $template_part_post, $content );
} else {
// Else, if the template part was provided by the active theme,
// render the corresponding file content.
Update @wordpress packages Update packages to include these bug fixes from Gutenberg: - Image block: Set image display to grid when no alignment sent to properly align caption on resize - Update and align template descriptions - Site Editor - prevent loading state from showing the admin menu. - Add client side routing for Site Editor - Navigation: Add clearance for appender in submenus. - Fix CSS Custom Properties for presets in the site editor - Add/navigation blocks post processing after migration from menu items - Allow selector ordering to ensure theme.json root selector margin takes precedence - Do not remove theme presets if defaults are hidden - Format library: fix unsetting highlight color - FSE: Fix template resolution to give precedence to child theme PHP templates over parent theme block templates with equal specificity - ColorPalette: Improving accessibility and visibility - Update: Make the color popover on the gradient picker appear as expected - Site Editor: Display a notice if export fails - Fix docs and function naming for gallery block registration in PHP - Switch to addEventListener for load event in the navigation block view script - Fix mistake in _remove_theme_attribute_in_block_template_content - Better synchronisation between Gutenberg and Core code - Move the block page templates hook into compat/5.9 folder - Moves to the template loader hooks and functions into lib/compat folder - Refactor the gutenberg_is_fse_theme function to use wp_is_block_theme - Site Editor: Update support doc URL in Welcome Guide - Global Styles: Add Welcome Guide toggle - Hide remove control point when removing would break gradient control - Don't request the deprecated navigation areas endpoint outside of the Gutenberg plugin - Image: Fix resizer controls being hidden in Safari when switching between alignments - Remove Navigation Menus from WP Admin sidebar - Site Editor: Hide the block appender in the Template Part editor - Site Editor: Use server definition for the Template Areas - Synchronize wp_is_block_theme and block-templates block support with Core - E2E: Retry login again after a bad nonce request to prevent intermittent test failures - Fix theme requirement validation with WP 5.8 - Fix WP 5.9 check for conditionally running code - Fix post comment form input width - Border Style Control: Update styling for consistency with border width control - Fix form-submit styles by adding button classes to the submit-button in post-comments block - Site Editor: Fix edit template part link in header dropdown - Move duotone palette to the bottom of global styles gradients - Fix how appearanceTools works - Move WP 5.9 wp-admin menus compatibility code to lib/compat folder - Revert "Site Editor: Set the <title> on the list page to be same as the CPT name" - Site Editor: Document Actions: add SR text to heading 1 - Do not register global styles CPT in WordPress 5.9 - Global Styles: Move the 'Edit colors' button to a standard menu item - Fix styles for previews and patterns - Site Editor: Fix failing E2E test - Templates: Search for old template names in the parent theme too - Remove 4 instances of 'gutenberg' text domain from WordPress core - Fix content loss when ungrouping template parts or reusable blocks - Simplify the RESET_BLOCK action to fix template part focus mode content loss - [Global Styles]: Make Blocks section more distinguishable - Only use block markup for comment form button when using a block theme - Navigation: Fix vertical alignment of page list in modal. - Fix: ToggleGroupControl active state - Remove gutenberg_ prefix from @wordpress/block-library Props ocean90, oandregal, hellofromtonya, youknowriad. See #54487. Built from https://develop.svn.wordpress.org/trunk@52364 git-svn-id: http://core.svn.wordpress.org/trunk@51956 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-12-13 20:57:26 -05:00
$parent_theme_folders = get_block_theme_folders( get_template() );
$child_theme_folders = get_block_theme_folders( get_stylesheet() );
$child_theme_part_file_path = get_theme_file_path( '/' . $child_theme_folders['wp_template_part'] . '/' . $attributes['slug'] . '.html' );
$parent_theme_part_file_path = get_theme_file_path( '/' . $parent_theme_folders['wp_template_part'] . '/' . $attributes['slug'] . '.html' );
$template_part_file_path = 0 === validate_file( $attributes['slug'] ) && file_exists( $child_theme_part_file_path ) ? $child_theme_part_file_path : $parent_theme_part_file_path;
if ( 0 === validate_file( $attributes['slug'] ) && file_exists( $template_part_file_path ) ) {
$content = file_get_contents( $template_part_file_path );
$content = is_string( $content ) && '' !== $content
? _inject_theme_attribute_in_block_template_content( $content )
: '';
}
Update @wordpress packages Update packages to include these bug fixes from Gutenberg: - Gallery block: turn on auto-migration of v1 Gallery blocks to v2 format when edited - Add accessible labelling to submenu buttons. - Improve performance of wp_navigation lookup. - Various inline docblock corrections - Use core version of template and template part post types and REST endpoints for WP 5.9, with back compat for 5.8 - Gradients: Enable adding custom gradient when gradients are disabled - Custom color palette: add default color name - Color Picker: Re-instate debounce and controlled value to fix issue with gradient picker - Add aria-current="page" to active navigation item - Site Editor: Templat list fallback to slug - Fix: Custom color picker popover position - Fix: php 5.6 error in theme JSON class. - Update the WP_Theme_JSON_Gutenberg class to be like the core one - Update the WP_Theme_JSON_Resolver_Gutenberg class to be like the core one - Move Global Styles code to lib/compat/wordpress-5.9 folder - E2E Tests: Fix failing image e2e test by waiting for required element - Navigation: Try removing absorb toolbar prop. - Navigation: Fix navigation justifications. - Fix wordbreak for URLs - Polish unset color indicator. - Template revert flow: Make label description source agnostic - [Block Library - Navigation]: Fix vertical layout - Add: Corners to custom color picker popover - Add: Missing margin to the color picker clear button - Gradient: Fix clearing a custom gradient from throwing a React warning - [Block Library]: Rename Query Pagination blocks - PHP Unit Tests: Use global transients - Remove CSS that causes conflict with theme.json - Add actions which fire during the loading process of block template parts - Fix usage of useSetting('color.palette') - Update micromodal, include click-through fix - Site Editor: Remove unused PHP code - Don't try and render unstable location if Nav block has ID - Fix gutenberg prefixed function references in core - Card: support the extraSmall option for the size prop - Gallery block: enable the new gallery block by default if running in core - Block fixtures: Change port to 8889 to placate KSES - Full Site Editing: Remove block template resolution unit tests - Site Editor: Sync export API See #54487. Built from https://develop.svn.wordpress.org/trunk@52324 git-svn-id: http://core.svn.wordpress.org/trunk@51916 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-12-06 01:20:27 -05:00
if ( '' !== $content && null !== $content ) {
/**
* Fires when a block template part is loaded from a template part in the theme.
*
* @since 5.9.0
*
* @param string $template_part_id The requested template part namespaced to the theme.
* @param array $attributes The block attributes.
* @param string $template_part_file_path Absolute path to the template path.
* @param string $content The template part content.
*/
do_action( 'render_block_core_template_part_file', $template_part_id, $attributes, $template_part_file_path, $content );
} else {
/**
* Fires when a requested block template part does not exist in the database nor in the theme.
*
* @since 5.9.0
*
* @param string $template_part_id The requested template part namespaced to the theme.
* @param array $attributes The block attributes.
* @param string $template_part_file_path Absolute path to the not found template path.
*/
do_action( 'render_block_core_template_part_none', $template_part_id, $attributes, $template_part_file_path );
}
}
}
if ( is_null( $content ) && is_user_logged_in() ) {
if ( ! isset( $attributes['slug'] ) ) {
// If there is no slug this is a placeholder and we dont want to return any message.
return;
}
return sprintf(
/* translators: %s: Template part slug. */
__( 'Template part has been deleted or is unavailable: %s' ),
$attributes['slug']
);
}
if ( isset( $seen_ids[ $template_part_id ] ) ) {
// WP_DEBUG_DISPLAY must only be honored when WP_DEBUG. This precedent
// is set in `wp_debug_mode()`.
$is_debug = defined( 'WP_DEBUG' ) && WP_DEBUG &&
defined( 'WP_DEBUG_DISPLAY' ) && WP_DEBUG_DISPLAY;
return $is_debug ?
// translators: Visible only in the front end, this warning takes the place of a faulty block.
__( '[block rendering halted]' ) :
'';
}
// Run through the actions that are typically taken on the_content.
$seen_ids[ $template_part_id ] = true;
$content = do_blocks( $content );
unset( $seen_ids[ $template_part_id ] );
$content = wptexturize( $content );
$content = convert_smilies( $content );
$content = shortcode_unautop( $content );
$content = wp_filter_content_tags( $content );
$content = do_shortcode( $content );
// Handle embeds for block template parts.
global $wp_embed;
$content = $wp_embed->autoembed( $content );
if ( empty( $attributes['tagName'] ) ) {
$defined_areas = get_allowed_block_template_part_areas();
$area_tag = 'div';
foreach ( $defined_areas as $defined_area ) {
if ( $defined_area['area'] === $area && isset( $defined_area['area_tag'] ) ) {
$area_tag = $defined_area['area_tag'];
}
}
$html_tag = $area_tag;
} else {
$html_tag = esc_attr( $attributes['tagName'] );
}
$wrapper_attributes = get_block_wrapper_attributes();
return "<$html_tag $wrapper_attributes>" . str_replace( ']]>', ']]&gt;', $content ) . "</$html_tag>";
}
/**
* Returns an array of variation objects for the template part block.
*
* @return array Array containing the block variation objects.
*/
function build_template_part_block_variations() {
$variations = array();
$defined_areas = get_allowed_block_template_part_areas();
foreach ( $defined_areas as $area ) {
if ( 'uncategorized' !== $area['area'] ) {
$variations[] = array(
'name' => $area['area'],
'title' => $area['label'],
'description' => $area['description'],
'attributes' => array(
'area' => $area['area'],
),
'scope' => array( 'inserter' ),
'icon' => $area['icon'],
);
}
}
return $variations;
}
/**
* Registers the `core/template-part` block on the server.
*/
function register_block_core_template_part() {
register_block_type_from_metadata(
__DIR__ . '/template-part',
array(
'render_callback' => 'render_block_core_template_part',
'variations' => build_template_part_block_variations(),
)
);
}
add_action( 'init', 'register_block_core_template_part' );