Use core version of template and template part post types and REST endpoints for WP 5.9, with back compat for 5.8 #36898
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| <?php | ||
| /** | ||
| * Block template part functions. | ||
| * | ||
| * This is a temporary compatibility fix for WordPress 5.8.x, which is missing | ||
| * some features for template parts that are present in 5.9. | ||
| * | ||
| * Once 5.9 is the minimum supported WordPress version for the Gutenberg | ||
| * plugin, this shim can be removed. | ||
| * | ||
| * @package gutenberg | ||
| */ | ||
|
|
||
| // Only run any of the code in this file if the version is less than 5.9. | ||
| // wp_is_block_template_theme was introduced in 5.9. | ||
| if ( ! function_exists( 'wp_is_block_template_theme' ) ) { | ||
| /** | ||
| * Registers block editor 'wp_template_part' post type. | ||
| */ | ||
| function gutenberg_register_template_part_post_type() { | ||
| if ( ! gutenberg_supports_block_templates() ) { | ||
| return; | ||
| } | ||
|
|
||
| $labels = array( | ||
| 'name' => __( 'Template Parts', 'gutenberg' ), | ||
| 'singular_name' => __( 'Template Part', 'gutenberg' ), | ||
| 'menu_name' => _x( 'Template Parts', 'Admin Menu text', 'gutenberg' ), | ||
| 'add_new' => _x( 'Add New', 'Template Part', 'gutenberg' ), | ||
| 'add_new_item' => __( 'Add New Template Part', 'gutenberg' ), | ||
| 'new_item' => __( 'New Template Part', 'gutenberg' ), | ||
| 'edit_item' => __( 'Edit Template Part', 'gutenberg' ), | ||
| 'view_item' => __( 'View Template Part', 'gutenberg' ), | ||
| 'view_items' => __( 'View Template Parts', 'gutenberg' ), | ||
| 'all_items' => __( 'All Template Parts', 'gutenberg' ), | ||
| 'search_items' => __( 'Search Template Parts', 'gutenberg' ), | ||
| 'parent_item_colon' => __( 'Parent Template Part:', 'gutenberg' ), | ||
| 'not_found' => __( 'No template parts found.', 'gutenberg' ), | ||
| 'not_found_in_trash' => __( 'No template parts found in Trash.', 'gutenberg' ), | ||
| 'archives' => __( 'Template part archives', 'gutenberg' ), | ||
| 'insert_into_item' => __( 'Insert into template part', 'gutenberg' ), | ||
| 'uploaded_to_this_item' => __( 'Uploaded to this template part', 'gutenberg' ), | ||
| 'filter_items_list' => __( 'Filter template parts list', 'gutenberg' ), | ||
| 'items_list_navigation' => __( 'Template parts list navigation', 'gutenberg' ), | ||
| 'items_list' => __( 'Template parts list', 'gutenberg' ), | ||
| ); | ||
|
|
||
| $args = array( | ||
| 'labels' => $labels, | ||
| 'description' => __( 'Template parts to include in your templates.', 'gutenberg' ), | ||
| 'public' => false, | ||
| 'has_archive' => false, | ||
| 'show_ui' => true, | ||
| 'show_in_menu' => false, | ||
| 'show_in_admin_bar' => false, | ||
| 'show_in_rest' => true, | ||
| 'rest_base' => 'template-parts', | ||
| 'rest_controller_class' => 'Gutenberg_REST_Templates_Controller', | ||
| 'map_meta_cap' => true, | ||
| 'supports' => array( | ||
| 'title', | ||
| 'slug', | ||
| 'excerpt', | ||
| 'editor', | ||
| 'revisions', | ||
| 'author', | ||
| ), | ||
| ); | ||
|
|
||
| register_post_type( 'wp_template_part', $args ); | ||
| } | ||
| add_action( 'init', 'gutenberg_register_template_part_post_type' ); | ||
|
|
||
| /** | ||
| * Registers the 'wp_template_part_area' taxonomy. | ||
| */ | ||
| function gutenberg_register_wp_template_part_area_taxonomy() { | ||
| if ( ! gutenberg_supports_block_templates() ) { | ||
| return; | ||
| } | ||
|
|
||
| register_taxonomy( | ||
| 'wp_template_part_area', | ||
| array( 'wp_template_part' ), | ||
| array( | ||
| 'public' => false, | ||
| 'hierarchical' => false, | ||
| 'labels' => array( | ||
| 'name' => __( 'Template Part Areas', 'gutenberg' ), | ||
| 'singular_name' => __( 'Template Part Area', 'gutenberg' ), | ||
| ), | ||
| 'query_var' => false, | ||
| 'rewrite' => false, | ||
| 'show_ui' => false, | ||
| '_builtin' => true, | ||
| 'show_in_nav_menus' => false, | ||
| 'show_in_rest' => false, | ||
| ) | ||
| ); | ||
| } | ||
| add_action( 'init', 'gutenberg_register_wp_template_part_area_taxonomy' ); | ||
|
|
||
| /** | ||
| * Fixes the label of the 'wp_template_part' admin menu entry. | ||
| */ | ||
| function gutenberg_fix_template_part_admin_menu_entry() { | ||
| if ( ! gutenberg_supports_block_templates() ) { | ||
| return; | ||
| } | ||
|
|
||
| global $submenu; | ||
| if ( ! isset( $submenu['themes.php'] ) ) { | ||
| return; | ||
| } | ||
| $post_type = get_post_type_object( 'wp_template_part' ); | ||
| if ( ! $post_type ) { | ||
| return; | ||
| } | ||
| foreach ( $submenu['themes.php'] as $key => $submenu_entry ) { | ||
| if ( $post_type->labels->all_items === $submenu['themes.php'][ $key ][0] ) { | ||
| $submenu['themes.php'][ $key ][0] = $post_type->labels->menu_name; // phpcs:ignore WordPress.WP.GlobalVariablesOverride | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| add_action( 'admin_menu', 'gutenberg_fix_template_part_admin_menu_entry' ); | ||
|
|
||
| // Customize the `wp_template` admin list. | ||
| add_filter( 'manage_wp_template_part_posts_columns', 'gutenberg_templates_lists_custom_columns' ); | ||
| add_action( 'manage_wp_template_part_posts_custom_column', 'gutenberg_render_templates_lists_custom_column', 10, 2 ); | ||
| add_filter( 'views_edit-wp_template_part', 'gutenberg_filter_templates_edit_views' ); | ||
|
|
||
| /** | ||
| * Sets a custom slug when creating auto-draft template parts. | ||
| * This is only needed for auto-drafts created by the regular WP editor. | ||
| * If this page is to be removed, this won't be necessary. | ||
| * | ||
| * @param int $post_id Post ID. | ||
| */ | ||
| function gutenberg_set_unique_slug_on_create_template_part( $post_id ) { | ||
| // This is the core function with the same functionality. | ||
| if ( function_exists( 'wp_set_unique_slug_on_create_template_part' ) ) { | ||
| return; | ||
| } | ||
|
|
||
| $post = get_post( $post_id ); | ||
| if ( 'auto-draft' !== $post->post_status ) { | ||
| return; | ||
| } | ||
|
|
||
| if ( ! $post->post_name ) { | ||
| wp_update_post( | ||
| array( | ||
| 'ID' => $post_id, | ||
| 'post_name' => 'custom_slug_' . uniqid(), | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| $terms = get_the_terms( $post_id, 'wp_theme' ); | ||
| if ( ! $terms || ! count( $terms ) ) { | ||
| wp_set_post_terms( $post_id, wp_get_theme()->get_stylesheet(), 'wp_theme' ); | ||
| } | ||
| } | ||
|
|
||
| add_action( 'save_post_wp_template_part', 'gutenberg_set_unique_slug_on_create_template_part' ); | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There were some minor changes to this function in WordPress core, so I've replicated them for Gutenberg.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this branch there is no
foreach ( $template_blocks as $block )which is something I see in the Core version. Is that right?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, oops. I obviously wasn't thorough enough. Fixed in #37137.