gutenberg / lib / template-parts.php

template-parts.php in Gutenberg 9.6.2, at lib/template-parts.php

151 lines 5.4 KB

Raw Download Zip

1	<?php
2	/**
3	* Block template part functions.
4	*
5	* @package gutenberg
6	*/
7
8	/**
9	* Registers block editor 'wp_template_part' post type.
10	*/
11	function gutenberg_register_template_part_post_type() {
12	if ( ! gutenberg_is_fse_theme() ) {
13	return;
14	}
15
16	$labels = array(
17	'name' => __( 'Template Parts', 'gutenberg' ),
18	'singular_name' => __( 'Template Part', 'gutenberg' ),
19	'menu_name' => _x( 'Template Parts', 'Admin Menu text', 'gutenberg' ),
20	'add_new' => _x( 'Add New', 'Template Part', 'gutenberg' ),
21	'add_new_item' => __( 'Add New Template Part', 'gutenberg' ),
22	'new_item' => __( 'New Template Part', 'gutenberg' ),
23	'edit_item' => __( 'Edit Template Part', 'gutenberg' ),
24	'view_item' => __( 'View Template Part', 'gutenberg' ),
25	'all_items' => __( 'All Template Parts', 'gutenberg' ),
26	'search_items' => __( 'Search Template Parts', 'gutenberg' ),
27	'parent_item_colon' => __( 'Parent Template Part:', 'gutenberg' ),
28	'not_found' => __( 'No template parts found.', 'gutenberg' ),
29	'not_found_in_trash' => __( 'No template parts found in Trash.', 'gutenberg' ),
30	'archives' => __( 'Template part archives', 'gutenberg' ),
31	'insert_into_item' => __( 'Insert into template part', 'gutenberg' ),
32	'uploaded_to_this_item' => __( 'Uploaded to this template part', 'gutenberg' ),
33	'filter_items_list' => __( 'Filter template parts list', 'gutenberg' ),
34	'items_list_navigation' => __( 'Template parts list navigation', 'gutenberg' ),
35	'items_list' => __( 'Template parts list', 'gutenberg' ),
36	);
37
38	$args = array(
39	'labels' => $labels,
40	'description' => __( 'Template parts to include in your templates.', 'gutenberg' ),
41	'public' => false,
42	'has_archive' => false,
43	'show_ui' => true,
44	'show_in_menu' => 'themes.php',
45	'show_in_admin_bar' => false,
46	'show_in_rest' => true,
47	'rest_base' => 'template-parts',
48	'map_meta_cap' => true,
49	'supports' => array(
50	'title',
51	'slug',
52	'excerpt',
53	'editor',
54	'revisions',
55	),
56	);
57
58	register_post_type( 'wp_template_part', $args );
59	}
60	add_action( 'init', 'gutenberg_register_template_part_post_type' );
61
62	/**
63	* Filters `wp_template_part` posts slug resolution to bypass deduplication logic as
64	* template part slugs should be unique.
65	*
66	* @param string $slug The resolved slug (post_name).
67	* @param int $post_ID Post ID.
68	* @param string $post_status No uniqueness checks are made if the post is still draft or pending.
69	* @param string $post_type Post type.
70	* @param int $post_parent Post parent ID.
71	* @param int $original_slug The desired slug (post_name).
72	* @return string The original, desired slug.
73	*/
74	function gutenberg_filter_wp_template_part_wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent, $original_slug ) {
75	if ( 'wp_template_part' === $post_type ) {
76	return $original_slug;
77	}
78	return $slug;
79	}
80	add_filter( 'wp_unique_post_slug', 'gutenberg_filter_wp_template_part_wp_unique_post_slug', 10, 6 );
81
82	/**
83	* Fixes the label of the 'wp_template_part' admin menu entry.
84	*/
85	function gutenberg_fix_template_part_admin_menu_entry() {
86	if ( ! gutenberg_is_fse_theme() ) {
87	return;
88	}
89
90	global $submenu;
91	if ( ! isset( $submenu['themes.php'] ) ) {
92	return;
93	}
94	$post_type = get_post_type_object( 'wp_template_part' );
95	if ( ! $post_type ) {
96	return;
97	}
98	foreach ( $submenu['themes.php'] as $key => $submenu_entry ) {
99	if ( $post_type->labels->all_items === $submenu['themes.php'][ $key ][0] ) {
100	$submenu['themes.php'][ $key ][0] = $post_type->labels->menu_name; // phpcs:ignore WordPress.WP.GlobalVariablesOverride
101	break;
102	}
103	}
104	}
105	add_action( 'admin_menu', 'gutenberg_fix_template_part_admin_menu_entry' );
106
107	// Customize the `wp_template` admin list.
108	add_filter( 'manage_wp_template_part_posts_columns', 'gutenberg_templates_lists_custom_columns' );
109	add_action( 'manage_wp_template_part_posts_custom_column', 'gutenberg_render_templates_lists_custom_column', 10, 2 );
110	add_filter( 'views_edit-wp_template_part', 'gutenberg_filter_templates_edit_views' );
111
112	/**
113	* Filter for adding and a `theme` parameter to `wp_template_part` queries.
114	*
115	* @param array $query_params The query parameters.
116	* @return array Filtered $query_params.
117	*/
118	function filter_rest_wp_template_part_collection_params( $query_params ) {
119	$query_params += array(
120	'theme' => array(
121	'description' => __( 'The theme slug for the theme that created the template part.', 'gutenberg' ),
122	'type' => 'string',
123	),
124	);
125	return $query_params;
126	}
127	add_filter( 'rest_wp_template_part_collection_params', 'filter_rest_wp_template_part_collection_params', 99, 1 );
128
129	/**
130	* Filter for supporting the `resolved`, `template`, and `theme` parameters in `wp_template_part` queries.
131	*
132	* @param array $args The query arguments.
133	* @param WP_REST_Request $request The request object.
134	* @return array Filtered $args.
135	*/
136	function filter_rest_wp_template_part_query( $args, $request ) {
137	if ( $request['theme'] ) {
138	$tax_query = isset( $args['tax_query'] ) ? $args['tax_query'] : array();
139	$tax_query[] = array(
140	'taxonomy' => 'wp_theme',
141	'field' => 'slug',
142	'terms' => $request['theme'],
143	);
144
145	$args['tax_query'] = $tax_query;
146	}
147
148	return $args;
149	}
150	add_filter( 'rest_wp_template_part_query', 'filter_rest_wp_template_part_query', 99, 2 );
151