class-primary-term-admin.php — Yoast SEO – Advanced SEO with real-time guidance and built-in AI 27.5

wordpress-seo / admin / class-primary-term-admin.php

wordpress-seo / admin Last commit date

class-primary-term-admin.php

273 lines

1	<?php
2	/**
3	* WPSEO plugin file.
4	*
5	* @package WPSEO\Admin
6	*/
7
8	/**
9	* Adds the UI to change the primary term for a post.
10	*/
11	class WPSEO_Primary_Term_Admin implements WPSEO_WordPress_Integration {
12
13	/**
14	* Constructor.
15	*
16	* @return void
17	*/
18	public function register_hooks() {
19	add_filter( 'wpseo_content_meta_section_content', [ $this, 'add_input_fields' ] );
20
21	add_action( 'admin_footer', [ $this, 'wp_footer' ], 10 );
22
23	add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
24	}
25
26	/**
27	* Gets the current post ID.
28	*
29	* @return int The post ID.
30	*/
31	protected function get_current_id() {
32	// phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information, We are casting to an integer.
33	$post_id = isset( $_GET['post'] ) && is_string( $_GET['post'] ) ? (int) wp_unslash( $_GET['post'] ) : 0;
34
35	if ( $post_id === 0 && isset( $GLOBALS['post_ID'] ) ) {
36	$post_id = (int) $GLOBALS['post_ID'];
37	}
38
39	return $post_id;
40	}
41
42	/**
43	* Adds hidden fields for primary taxonomies.
44	*
45	* @param string $content The metabox content.
46	*
47	* @return string The HTML content.
48	*/
49	public function add_input_fields( $content ) {
50	$taxonomies = $this->get_primary_term_taxonomies();
51
52	foreach ( $taxonomies as $taxonomy ) {
53	$content .= $this->primary_term_field( $taxonomy->name );
54	$content .= wp_nonce_field( 'save-primary-term', WPSEO_Meta::$form_prefix . 'primary_' . $taxonomy->name . '_nonce', false, false );
55	}
56	return $content;
57	}
58
59	/**
60	* Generates the HTML for a hidden field for a primary taxonomy.
61	*
62	* @param string $taxonomy_name The taxonomy's slug.
63	*
64	* @return string The HTML for a hidden primary taxonomy field.
65	*/
66	protected function primary_term_field( $taxonomy_name ) {
67	return sprintf(
68	'<input class="yoast-wpseo-primary-term" type="hidden" id="%1$s" name="%2$s" value="%3$s" />',
69	esc_attr( $this->generate_field_id( $taxonomy_name ) ),
70	esc_attr( $this->generate_field_name( $taxonomy_name ) ),
71	esc_attr( $this->get_primary_term( $taxonomy_name ) ),
72	);
73	}
74
75	/**
76	* Generates an id for a primary taxonomy's hidden field.
77	*
78	* @param string $taxonomy_name The taxonomy's slug.
79	*
80	* @return string The field id.
81	*/
82	protected function generate_field_id( $taxonomy_name ) {
83	return 'yoast-wpseo-primary-' . $taxonomy_name;
84	}
85
86	/**
87	* Generates a name for a primary taxonomy's hidden field.
88	*
89	* @param string $taxonomy_name The taxonomy's slug.
90	*
91	* @return string The field id.
92	*/
93	protected function generate_field_name( $taxonomy_name ) {
94	return WPSEO_Meta::$form_prefix . 'primary_' . $taxonomy_name . '_term';
95	}
96
97	/**
98	* Adds primary term templates.
99	*
100	* @return void
101	*/
102	public function wp_footer() {
103	$taxonomies = $this->get_primary_term_taxonomies();
104
105	if ( ! empty( $taxonomies ) ) {
106	$this->include_js_templates();
107	}
108	}
109
110	/**
111	* Enqueues all the assets needed for the primary term interface.
112	*
113	* @return void
114	*/
115	public function enqueue_assets() {
116	global $pagenow;
117
118	if ( ! WPSEO_Metabox::is_post_edit( $pagenow ) ) {
119	return;
120	}
121
122	$taxonomies = $this->get_primary_term_taxonomies();
123
124	// Only enqueue if there are taxonomies that need a primary term.
125	if ( empty( $taxonomies ) ) {
126	return;
127	}
128
129	$asset_manager = new WPSEO_Admin_Asset_Manager();
130	$asset_manager->enqueue_style( 'primary-category' );
131
132	$mapped_taxonomies = $this->get_mapped_taxonomies_for_js( $taxonomies );
133
134	$data = [
135	'taxonomies' => $mapped_taxonomies,
136	];
137
138	$asset_manager->localize_script( 'post-edit', 'wpseoPrimaryCategoryL10n', $data );
139	$asset_manager->localize_script( 'post-edit-classic', 'wpseoPrimaryCategoryL10n', $data );
140	}
141
142	/**
143	* Gets the id of the primary term.
144	*
145	* @param string $taxonomy_name Taxonomy name for the term.
146	*
147	* @return int primary term id
148	*/
149	protected function get_primary_term( $taxonomy_name ) {
150	$primary_term = new WPSEO_Primary_Term( $taxonomy_name, $this->get_current_id() );
151
152	return $primary_term->get_primary_term();
153	}
154
155	/**
156	* Returns all the taxonomies for which the primary term selection is enabled.
157	*
158	* @param int\|null $post_id Default current post ID.
159	* @return array
160	*/
161	protected function get_primary_term_taxonomies( $post_id = null ) {
162	$post_id ??= $this->get_current_id();
163
164	$taxonomies = wp_cache_get( 'primary_term_taxonomies_' . $post_id, 'wpseo' );
165	if ( $taxonomies !== false ) {
166	return $taxonomies;
167	}
168
169	$taxonomies = $this->generate_primary_term_taxonomies( $post_id );
170
171	wp_cache_set( 'primary_term_taxonomies_' . $post_id, $taxonomies, 'wpseo' );
172
173	return $taxonomies;
174	}
175
176	/**
177	* Includes templates file.
178	*
179	* @return void
180	*/
181	protected function include_js_templates() {
182	include_once WPSEO_PATH . 'admin/views/js-templates-primary-term.php';
183	}
184
185	/**
186	* Generates the primary term taxonomies.
187	*
188	* @param int $post_id ID of the post.
189	*
190	* @return array
191	*/
192	protected function generate_primary_term_taxonomies( $post_id ) {
193	$post_type = get_post_type( $post_id );
194	$all_taxonomies = get_object_taxonomies( $post_type, 'objects' );
195	$all_taxonomies = array_filter( $all_taxonomies, [ $this, 'filter_hierarchical_taxonomies' ] );
196
197	/**
198	* Filters which taxonomies for which the user can choose the primary term.
199	*
200	* @param array $taxonomies An array of taxonomy objects that are primary_term enabled.
201	* @param string $post_type The post type for which to filter the taxonomies.
202	* @param array $all_taxonomies All taxonomies for this post types, even ones that don't have primary term
203	* enabled.
204	*/
205	$taxonomies = (array) apply_filters( 'wpseo_primary_term_taxonomies', $all_taxonomies, $post_type, $all_taxonomies );
206
207	return $taxonomies;
208	}
209
210	/**
211	* Creates a map of taxonomies for localization.
212	*
213	* @param array $taxonomies The taxononmies that should be mapped.
214	*
215	* @return array The mapped taxonomies.
216	*/
217	protected function get_mapped_taxonomies_for_js( $taxonomies ) {
218	return array_map( [ $this, 'map_taxonomies_for_js' ], $taxonomies );
219	}
220
221	/**
222	* Returns an array suitable for use in the javascript.
223	*
224	* @param stdClass $taxonomy The taxonomy to map.
225	*
226	* @return array The mapped taxonomy.
227	*/
228	private function map_taxonomies_for_js( $taxonomy ) {
229	$primary_term = $this->get_primary_term( $taxonomy->name );
230
231	if ( empty( $primary_term ) ) {
232	$primary_term = '';
233	}
234
235	$terms = get_terms(
236	[
237	'taxonomy' => $taxonomy->name,
238	'update_term_meta_cache' => false,
239	'fields' => 'id=>name',
240	],
241	);
242
243	$mapped_terms_for_js = [];
244	foreach ( $terms as $id => $name ) {
245	$mapped_terms_for_js[] = [
246	'id' => $id,
247	'name' => $name,
248	];
249	}
250
251	return [
252	'title' => $taxonomy->labels->singular_name,
253	'name' => $taxonomy->name,
254	'primary' => $primary_term,
255	'singularLabel' => $taxonomy->labels->singular_name,
256	'fieldId' => $this->generate_field_id( $taxonomy->name ),
257	'restBase' => ( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name,
258	'terms' => $mapped_terms_for_js,
259	];
260	}
261
262	/**
263	* Returns whether or not a taxonomy is hierarchical.
264	*
265	* @param stdClass $taxonomy Taxonomy object.
266	*
267	* @return bool
268	*/
269	private function filter_hierarchical_taxonomies( $taxonomy ) {
270	return (bool) $taxonomy->hierarchical;
271	}
272	}
273