682b128d0609cc9ef6a04b21c55e2e5826f99e83

Committed 17 Apr 2024 08:46AM UTC coverage: 52.369% (+0.1%) from 52.267%

Build # 682b128d0609cc9ef6a04b21c55e2e5826f99e83

Build Type

Pull #21161

github

Committed by

web-flow

Commit Message

Merge 689ad1ca1 into 75af0074a

Pull Request Pull Request #21161: 21141 decouple hidden fields for metabox

Run Details

7523 of 13843 branches covered (54.35%)

Branch coverage included in aggregate %.

75 of 270 new or added lines in 42 files covered. (27.78%)

536 existing lines in 12 files now uncovered.

28632 of 55196 relevant lines covered (51.87%)

40697.02 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

22.47

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

<?php
/**
 * WPSEO plugin file.
 *
 * @package WPSEO\Admin
 */

/**
 * Adds the UI to change the primary term for a post.
 */
class WPSEO_Primary_Term_Admin implements WPSEO_WordPress_Integration {

        /**
         * Constructor.
         *
         * @return void
         */
        public function register_hooks() {
                add_filter( 'wpseo_content_meta_section_content', [ $this, 'add_input_fields' ] );

                add_action( 'admin_footer', [ $this, 'wp_footer' ], 10 );

                add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
        }

        /**
         * Gets the current post ID.
         *
         * @return int The post ID.
         */
        protected function get_current_id() {
                // phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information, We are casting to an integer.
                $post_id = isset( $_GET['post'] ) && is_string( $_GET['post'] ) ? (int) wp_unslash( $_GET['post'] ) : 0;

                if ( $post_id === 0 && isset( $GLOBALS['post_ID'] ) ) {
                        $post_id = (int) $GLOBALS['post_ID'];
                }

                return $post_id;
        }

        /**
         * Adds hidden fields for primary taxonomies.
         *
         * @param string $content The metabox content.
         *
         * @return string The HTML content.
         */
        public function add_input_fields( $content ) {
                $taxonomies = $this->get_primary_term_taxonomies();

                foreach ( $taxonomies as $taxonomy ) {
                        $content .= $this->primary_term_field( $taxonomy->name );
                        $content .= wp_nonce_field( 'save-primary-term', WPSEO_Meta::$form_prefix . 'primary_' . $taxonomy->name . '_nonce', false, false );
                }
                return $content;
        }

        /**
         * Generates the HTML for a hidden field for a primary taxonomy.
         *
         * @param string $taxonomy_name The taxonomy's slug.
         *
         * @return string The HTML for a hidden primary taxonomy field.
         */
        protected function primary_term_field( $taxonomy_name ) {
                return sprintf(
                        '<input class="yoast-wpseo-primary-term" type="hidden" id="%1$s" name="%2$s" value="%3$s" />',
                        esc_attr( $this->generate_field_id( $taxonomy_name ) ),
                        esc_attr( $this->generate_field_name( $taxonomy_name ) ),
                        esc_attr( $this->get_primary_term( $taxonomy_name ) )
                );
        }

        /**
         * Generates an id for a primary taxonomy's hidden field.
         *
         * @param string $taxonomy_name The taxonomy's slug.
         *
         * @return string The field id.
         */
        protected function generate_field_id( $taxonomy_name ) {
                return 'yoast_wpseo_primary_' . $taxonomy_name;
        }

        /**
         * Generates a name for a primary taxonomy's hidden field.
         *
         * @param string $taxonomy_name The taxonomy's slug.
         *
         * @return string The field id.
         */
        protected function generate_field_name( $taxonomy_name ) {
                return WPSEO_Meta::$form_prefix . 'primary_' . $taxonomy_name . '_term';
        }

        /**
         * Adds primary term templates.
         *
         * @return void
         */
        public function wp_footer() {
                $taxonomies = $this->get_primary_term_taxonomies();

                if ( ! empty( $taxonomies ) ) {
                        $this->include_js_templates();
                }
        }

        /**
         * Enqueues all the assets needed for the primary term interface.
         *
         * @return void
         */
        public function enqueue_assets() {
                global $pagenow;

                if ( ! WPSEO_Metabox::is_post_edit( $pagenow ) ) {
                        return;
                }

                $taxonomies = $this->get_primary_term_taxonomies();

                // Only enqueue if there are taxonomies that need a primary term.
                if ( empty( $taxonomies ) ) {
                        return;
                }

                $asset_manager = new WPSEO_Admin_Asset_Manager();
                $asset_manager->enqueue_style( 'primary-category' );

                $mapped_taxonomies = $this->get_mapped_taxonomies_for_js( $taxonomies );

                $data = [
                        'taxonomies' => $mapped_taxonomies,
                ];

                $asset_manager->localize_script( 'post-edit', 'wpseoPrimaryCategoryL10n', $data );
                $asset_manager->localize_script( 'post-edit-classic', 'wpseoPrimaryCategoryL10n', $data );
        }

        /**
         * Gets the id of the primary term.
         *
         * @param string $taxonomy_name Taxonomy name for the term.
         *
         * @return int primary term id
         */
        protected function get_primary_term( $taxonomy_name ) {
                $primary_term = new WPSEO_Primary_Term( $taxonomy_name, $this->get_current_id() );

                return $primary_term->get_primary_term();
        }

        /**
         * Returns all the taxonomies for which the primary term selection is enabled.
         *
         * @param int|null $post_id Default current post ID.
         * @return array<WP_Taxonomy> The primary term taxonomies.
         */
        protected function get_primary_term_taxonomies( $post_id = null ) {
                if ( $post_id === null ) {
                        $post_id = $this->get_current_id();
                }

                $taxonomies = wp_cache_get( 'primary_term_taxonomies_' . $post_id, 'wpseo' );
                if ( $taxonomies !== false ) {
                        return $taxonomies;
                }

                $taxonomies = $this->generate_primary_term_taxonomies( $post_id );

                wp_cache_set( 'primary_term_taxonomies_' . $post_id, $taxonomies, 'wpseo' );

                return $taxonomies;
        }

        /**
         * Includes templates file.
         *
         * @return void
         */
        protected function include_js_templates() {
                include_once WPSEO_PATH . 'admin/views/js-templates-primary-term.php';
        }

        /**
         * Generates the primary term taxonomies.
         *
         * @param int $post_id ID of the post.
         *
         * @return array<WP_Taxonomy> The primary term taxonomies.
         */
        protected function generate_primary_term_taxonomies( $post_id ) {
                $post_type      = get_post_type( $post_id );
                $all_taxonomies = get_object_taxonomies( $post_type, 'objects' );
                $all_taxonomies = array_filter( $all_taxonomies, [ $this, 'filter_hierarchical_taxonomies' ] );

                /**
                 * Filters which taxonomies for which the user can choose the primary term.
                 *
                 * @param array  $taxonomies     An array of taxonomy objects that are primary_term enabled.
                 * @param string $post_type      The post type for which to filter the taxonomies.
                 * @param array  $all_taxonomies All taxonomies for this post types, even ones that don't have primary term
                 *                               enabled.
                 */
                $taxonomies = (array) apply_filters( 'wpseo_primary_term_taxonomies', $all_taxonomies, $post_type, $all_taxonomies );

                return $taxonomies;
        }

        /**
         * Creates a map of taxonomies for localization.
         *
         * @param array<WP_Taxonomy> $taxonomies The taxononmies that should be mapped.
         *
         * @return array<string> The mapped taxonomies.
         */
        protected function get_mapped_taxonomies_for_js( $taxonomies ) {
                return array_map( [ $this, 'map_taxonomies_for_js' ], $taxonomies );
        }

        /**
         * Returns an array suitable for use in the javascript.
         *
         * @param stdClass $taxonomy The taxonomy to map.
         *
         * @return array<string> The mapped taxonomy.
         */
        private function map_taxonomies_for_js( $taxonomy ) {
                $primary_term = $this->get_primary_term( $taxonomy->name );

                if ( empty( $primary_term ) ) {
                        $primary_term = '';
                }

                $terms = get_terms(
                        [
                                'taxonomy'               => $taxonomy->name,
                                'update_term_meta_cache' => false,
                                'fields'                 => 'id=>name',
                        ]
                );

                $mapped_terms_for_js = [];
                foreach ( $terms as $id => $name ) {
                        $mapped_terms_for_js[] = [
                                'id'   => $id,
                                'name' => $name,
                        ];
                }

                return [
                        'title'         => $taxonomy->labels->singular_name,
                        'name'          => $taxonomy->name,
                        'primary'       => $primary_term,
                        'singularLabel' => $taxonomy->labels->singular_name,
                        'fieldId'       => $this->generate_field_id( $taxonomy->name ),
                        'restBase'      => ( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name,
                        'terms'         => $mapped_terms_for_js,
                ];
        }

        /**
         * Returns whether or not a taxonomy is hierarchical.
         *
         * @param stdClass $taxonomy Taxonomy object.
         *
         * @return bool
         */
        private function filter_hierarchical_taxonomies( $taxonomy ) {
                return (bool) $taxonomy->hierarchical;
        }
}

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 ) {	×
NEW 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() {	8✔
103	$taxonomies = $this->get_primary_term_taxonomies();	8✔
104
105	if ( ! empty( $taxonomies ) ) {	8✔
106	$this->include_js_templates();	4✔
107	}
108	}	4✔
109
110	/**
111	* Enqueues all the assets needed for the primary term interface.
112	*
113	* @return void
114	*/
115	public function enqueue_assets() {	12✔
116	global $pagenow;	12✔
117
118	if ( ! WPSEO_Metabox::is_post_edit( $pagenow ) ) {	12✔
119	return;	8✔
120	}
121
122	$taxonomies = $this->get_primary_term_taxonomies();	4✔
123
124	// Only enqueue if there are taxonomies that need a primary term.
125	if ( empty( $taxonomies ) ) {	4✔
126	return;	×
127	}
128
129	$asset_manager = new WPSEO_Admin_Asset_Manager();	4✔
130	$asset_manager->enqueue_style( 'primary-category' );	4✔
131
132	$mapped_taxonomies = $this->get_mapped_taxonomies_for_js( $taxonomies );	4✔
133
134	$data = [	2✔
135	'taxonomies' => $mapped_taxonomies,	4✔
136	];	2✔
137
138	$asset_manager->localize_script( 'post-edit', 'wpseoPrimaryCategoryL10n', $data );	4✔
139	$asset_manager->localize_script( 'post-edit-classic', 'wpseoPrimaryCategoryL10n', $data );	4✔
140	}	2✔
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<WP_Taxonomy> The primary term taxonomies.
160	*/
161	protected function get_primary_term_taxonomies( $post_id = null ) {	×
162	if ( $post_id === null ) {	×
163	$post_id = $this->get_current_id();	×
164	}
165
166	$taxonomies = wp_cache_get( 'primary_term_taxonomies_' . $post_id, 'wpseo' );	×
167	if ( $taxonomies !== false ) {	×
168	return $taxonomies;	×
169	}
170
171	$taxonomies = $this->generate_primary_term_taxonomies( $post_id );	×
172
173	wp_cache_set( 'primary_term_taxonomies_' . $post_id, $taxonomies, 'wpseo' );	×
174
175	return $taxonomies;	×
176	}
177
178	/**
179	* Includes templates file.
180	*
181	* @return void
182	*/
183	protected function include_js_templates() {	×
184	include_once WPSEO_PATH . 'admin/views/js-templates-primary-term.php';	×
185	}
186
187	/**
188	* Generates the primary term taxonomies.
189	*
190	* @param int $post_id ID of the post.
191	*
192	* @return array<WP_Taxonomy> The primary term taxonomies.
193	*/
194	protected function generate_primary_term_taxonomies( $post_id ) {	×
195	$post_type = get_post_type( $post_id );	×
196	$all_taxonomies = get_object_taxonomies( $post_type, 'objects' );	×
197	$all_taxonomies = array_filter( $all_taxonomies, [ $this, 'filter_hierarchical_taxonomies' ] );	×
198
199	/**
200	* Filters which taxonomies for which the user can choose the primary term.
201	*
202	* @param array $taxonomies An array of taxonomy objects that are primary_term enabled.
203	* @param string $post_type The post type for which to filter the taxonomies.
204	* @param array $all_taxonomies All taxonomies for this post types, even ones that don't have primary term
205	* enabled.
206	*/
207	$taxonomies = (array) apply_filters( 'wpseo_primary_term_taxonomies', $all_taxonomies, $post_type, $all_taxonomies );	×
208
209	return $taxonomies;	×
210	}
211
212	/**
213	* Creates a map of taxonomies for localization.
214	*
215	* @param array<WP_Taxonomy> $taxonomies The taxononmies that should be mapped.
216	*
217	* @return array<string> The mapped taxonomies.
218	*/
219	protected function get_mapped_taxonomies_for_js( $taxonomies ) {	×
220	return array_map( [ $this, 'map_taxonomies_for_js' ], $taxonomies );	×
221	}
222
223	/**
224	* Returns an array suitable for use in the javascript.
225	*
226	* @param stdClass $taxonomy The taxonomy to map.
227	*
228	* @return array<string> The mapped taxonomy.
229	*/
230	private function map_taxonomies_for_js( $taxonomy ) {	×
231	$primary_term = $this->get_primary_term( $taxonomy->name );	×
232
233	if ( empty( $primary_term ) ) {	×
234	$primary_term = '';	×
235	}
236
237	$terms = get_terms(	×
238	[
239	'taxonomy' => $taxonomy->name,	×
240	'update_term_meta_cache' => false,
241	'fields' => 'id=>name',	×
242	]
243	);
244
245	$mapped_terms_for_js = [];	×
246	foreach ( $terms as $id => $name ) {	×
247	$mapped_terms_for_js[] = [	×
248	'id' => $id,	×
249	'name' => $name,	×
250	];
251	}
252
253	return [
254	'title' => $taxonomy->labels->singular_name,	×
255	'name' => $taxonomy->name,	×
256	'primary' => $primary_term,	×
257	'singularLabel' => $taxonomy->labels->singular_name,	×
258	'fieldId' => $this->generate_field_id( $taxonomy->name ),	×
259	'restBase' => ( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name,	×
260	'terms' => $mapped_terms_for_js,	×
261	];
262	}
263
264	/**
265	* Returns whether or not a taxonomy is hierarchical.
266	*
267	* @param stdClass $taxonomy Taxonomy object.
268	*
269	* @return bool
270	*/
271	private function filter_hierarchical_taxonomies( $taxonomy ) {	×
272	return (bool) $taxonomy->hierarchical;	×
273	}
274	}

Yoast / wordpress-seo / 682b128d0609cc9ef6a04b21c55e2e5826f99e83

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous