9f70c0278dfa8a47317c8094b5259465fbcd3325

Committed 25 Nov 2025 01:51PM UTC coverage: 52.323% (-0.7%) from 52.975%

Build # 9f70c0278dfa8a47317c8094b5259465fbcd3325

Build Type

Pull #22675

github

Committed by

web-flow

Commit Message

Merge b03ff5b95 into 130f1448f

Pull Request Pull Request #22675: 804 add caching

Run Details

8197 of 15362 branches covered (53.36%)

Branch coverage included in aggregate %.

0 of 187 new or added lines in 7 files covered. (0.0%)

376 existing lines in 10 files now uncovered.

31700 of 60889 relevant lines covered (52.06%)

39221.69 hits per line

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

55.77

/admin/class-yoast-notification.php

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

/**
 * Implements individual notification.
 */
class Yoast_Notification {

        /**
         * Type of capability check.
         *
         * @var string
         */
        public const MATCH_ALL = 'all';

        /**
         * Type of capability check.
         *
         * @var string
         */
        public const MATCH_ANY = 'any';

        /**
         * Notification type.
         *
         * @var string
         */
        public const ERROR = 'error';

        /**
         * Notification type.
         *
         * @var string
         */
        public const WARNING = 'warning';

        /**
         * Notification type.
         *
         * @var string
         */
        public const UPDATED = 'updated';

        /**
         * Options of this Notification.
         *
         * Contains optional arguments:
         *
         * -             type: The notification type, i.e. 'updated' or 'error'
         * -               id: The ID of the notification
         * -            nonce: Security nonce to use in case of dismissible notice.
         * -         priority: From 0 to 1, determines the order of Notifications.
         * -    dismissal_key: Option name to save dismissal information in, ID will be used if not supplied.
         * -     capabilities: Capabilities that a user must have for this Notification to show.
         * - capability_check: How to check capability pass: all or any.
         * -  wpseo_page_only: Only display on wpseo page or on every page.
         * -   yoast_branding: Whether to show the Yoast SEO branding in the notification.
         * -    resolve_nonce: Security nonce to use in case of resolving the notification.
         *
         * @var array
         */
        private $options = [];

        /**
         * Contains default values for the optional arguments.
         *
         * @var array
         */
        private $defaults = [
                'type'             => self::UPDATED,
                'id'               => '',
                'user_id'          => null,
                'nonce'            => null,
                'priority'         => 0.5,
                'data_json'        => [],
                'dismissal_key'    => null,
                'capabilities'     => [],
                'capability_check' => self::MATCH_ALL,
                'yoast_branding'   => false,
                'resolve_nonce'    => '',
        ];

        /**
         * The message for the notification.
         *
         * @var string
         */
        private $message;

        /**
         * Notification class constructor.
         *
         * @param string $message Message string.
         * @param array  $options Set of options.
         */
        public function __construct( $message, $options = [] ) {
                $this->message = $message;
                $this->options = $this->normalize_options( $options );
        }

        /**
         * Retrieve notification ID string.
         *
         * @return string
         */
        public function get_id() {
                return $this->options['id'];
        }

        /**
         * Retrieve the user to show the notification for.
         *
         * @deprecated 21.6
         * @codeCoverageIgnore
         *
         * @return WP_User|null The user to show this notification for.
         */
        public function get_user() {
                _deprecated_function( __METHOD__, 'Yoast SEO 21.6' );
                return null;
        }

        /**
         * Retrieve the id of the user to show the notification for.
         *
         * Returns the id of the current user if not user has been sent.
         *
         * @return int The user id
         */
        public function get_user_id() {
                return ( $this->options['user_id'] ?? get_current_user_id() );
        }

        /**
         * Retrieve nonce identifier.
         *
         * @return string|null Nonce for this Notification.
         */
        public function get_nonce() {
                if ( $this->options['id'] && empty( $this->options['nonce'] ) ) {
                        $this->options['nonce'] = wp_create_nonce( $this->options['id'] );
                }

                return $this->options['nonce'];
        }

        /**
         * Make sure the nonce is up to date.
         *
         * @return void
         */
        public function refresh_nonce() {
                if ( $this->options['id'] ) {
                        $this->options['nonce'] = wp_create_nonce( $this->options['id'] );
                }
        }

        /**
         * Get the type of the notification.
         *
         * @return string
         */
        public function get_type() {
                return $this->options['type'];
        }

        /**
         * Priority of the notification.
         *
         * Relative to the type.
         *
         * @return float Returns the priority between 0 and 1.
         */
        public function get_priority() {
                return $this->options['priority'];
        }

        /**
         * Get the nonce to resolve the alert.
         *
         * @return string
         */
        public function get_resolve_nonce() {
                return $this->options['resolve_nonce'];
        }

        /**
         * Get the User Meta key to check for dismissal of notification.
         *
         * @return string User Meta Option key that registers dismissal.
         */
        public function get_dismissal_key() {
                if ( empty( $this->options['dismissal_key'] ) ) {
                        return $this->options['id'];
                }

                return $this->options['dismissal_key'];
        }

        /**
         * Is this Notification persistent.
         *
         * @return bool True if persistent, False if fire and forget.
         */
        public function is_persistent() {
                $id = $this->get_id();

                return ! empty( $id );
        }

        /**
         * Check if the notification is relevant for the current user.
         *
         * @return bool True if a user needs to see this notification, false if not.
         */
        public function display_for_current_user() {
                // If the notification is for the current page only, always show.
                if ( ! $this->is_persistent() ) {
                        return true;
                }

                // If the current user doesn't match capabilities.
                return $this->match_capabilities();
        }

        /**
         * Does the current user match required capabilities.
         *
         * @return bool
         */
        public function match_capabilities() {
                // Super Admin can do anything.
                if ( is_multisite() && is_super_admin( $this->options['user_id'] ) ) {
                        return true;
                }

                /**
                 * Filter capabilities that enable the displaying of this notification.
                 *
                 * @param array              $capabilities The capabilities that must be present for this notification.
                 * @param Yoast_Notification $notification The notification object.
                 *
                 * @return array Array of capabilities or empty for no restrictions.
                 *
                 * @since 3.2
                 */
                $capabilities = apply_filters( 'wpseo_notification_capabilities', $this->options['capabilities'], $this );

                // Should be an array.
                if ( ! is_array( $capabilities ) ) {
                        $capabilities = (array) $capabilities;
                }

                /**
                 * Filter capability check to enable all or any capabilities.
                 *
                 * @param string             $capability_check The type of check that will be used to determine if an capability is present.
                 * @param Yoast_Notification $notification     The notification object.
                 *
                 * @return string self::MATCH_ALL or self::MATCH_ANY.
                 *
                 * @since 3.2
                 */
                $capability_check = apply_filters( 'wpseo_notification_capability_check', $this->options['capability_check'], $this );

                if ( ! in_array( $capability_check, [ self::MATCH_ALL, self::MATCH_ANY ], true ) ) {
                        $capability_check = self::MATCH_ALL;
                }

                if ( ! empty( $capabilities ) ) {

                        $has_capabilities = array_filter( $capabilities, [ $this, 'has_capability' ] );

                        switch ( $capability_check ) {
                                case self::MATCH_ALL:
                                        return $has_capabilities === $capabilities;
                                case self::MATCH_ANY:
                                        return ! empty( $has_capabilities );
                        }
                }

                return true;
        }

        /**
         * Array filter function to find matched capabilities.
         *
         * @param string $capability Capability to test.
         *
         * @return bool
         */
        private function has_capability( $capability ) {
                $user_id = $this->options['user_id'];
                if ( ! is_numeric( $user_id ) ) {
                        return false;
                }
                $user = get_user_by( 'id', $user_id );
                if ( ! $user ) {
                        return false;
                }

                return $user->has_cap( $capability );
        }

        /**
         * Return the object properties as an array.
         *
         * @return array
         */
        public function to_array() {
                return [
                        'message' => $this->message,
                        'options' => $this->options,
                ];
        }

        /**
         * Adds string (view) behaviour to the notification.
         *
         * @return string
         */
        public function __toString() {
                return $this->render();
        }

        /**
         * Renders the notification as a string.
         *
         * @return string The rendered notification.
         */
        public function render() {
                $attributes = [];

                // Default notification classes.
                $classes = [
                        'yoast-notification',
                ];

                // Maintain WordPress visualisation of notifications when they are not persistent.
                if ( ! $this->is_persistent() ) {
                        $classes[] = 'notice';
                        $classes[] = $this->get_type();
                }

                if ( ! empty( $classes ) ) {
                        $attributes['class'] = implode( ' ', $classes );
                }

                // Combined attribute key and value into a string.
                array_walk( $attributes, [ $this, 'parse_attributes' ] );

                $message = null;
                if ( $this->options['yoast_branding'] ) {
                        $message = $this->wrap_yoast_seo_icon( $this->message );
                }

                if ( $message === null ) {
                        $message = wpautop( $this->message );
                }

                // Build the output DIV.
                return '<div ' . implode( ' ', $attributes ) . '>' . $message . '</div>' . PHP_EOL;
        }

        /**
         * Get the message for the notification.
         *
         * @return string The message.
         */
        public function get_message() {
                return wpautop( $this->message );
        }

        /**
         * Wraps the message with a Yoast SEO icon.
         *
         * @param string $message The message to wrap.
         *
         * @return string The wrapped message.
         */
        private function wrap_yoast_seo_icon( $message ) {
                $out  = sprintf(
                        '<img src="%1$s" height="%2$d" width="%3$d" class="yoast-seo-icon" />',
                        esc_url( plugin_dir_url( WPSEO_FILE ) . 'packages/js/images/Yoast_SEO_Icon.svg' ),
                        60,
                        60
                );
                $out .= '<div class="yoast-seo-icon-wrap">';
                $out .= $message;
                $out .= '</div>';

                return $out;
        }

        /**
         * Get the JSON if provided.
         *
         * @return string|false
         */
        public function get_json() {
                if ( empty( $this->options['data_json'] ) ) {
                        return '';
                }

                return WPSEO_Utils::format_json_encode( $this->options['data_json'] );
        }

        /**
         * Make sure we only have values that we can work with.
         *
         * @param array $options Options to normalize.
         *
         * @return array
         */
        private function normalize_options( $options ) {
                $options = wp_parse_args( $options, $this->defaults );

                // Should not exceed 0 or 1.
                $options['priority'] = min( 1, max( 0, $options['priority'] ) );

                // Set default capabilities when not supplied.
                if ( empty( $options['capabilities'] ) || $options['capabilities'] === [] ) {
                        $options['capabilities'] = [ 'wpseo_manage_options' ];
                }

                // Set to the id of the current user if not supplied.
                if ( $options['user_id'] === null ) {
                        $options['user_id'] = get_current_user_id();
                }

                return $options;
        }

        /**
         * Format HTML element attributes.
         *
         * @param string $value Attribute value.
         * @param string $key   Attribute name.
         *
         * @return void
         */
        private function parse_attributes( &$value, $key ) {
                $value = sprintf( '%s="%s"', sanitize_key( $key ), esc_attr( $value ) );
        }
}

1	<?php
2	/**
3	* WPSEO plugin file.
4	*
5	* @package WPSEO\Admin\Notifications
6	* @since 1.5.3
7	*/
8
9	/**
10	* Implements individual notification.
11	*/
12	class Yoast_Notification {
13
14	/**
15	* Type of capability check.
16	*
17	* @var string
18	*/
19	public const MATCH_ALL = 'all';
20
21	/**
22	* Type of capability check.
23	*
24	* @var string
25	*/
26	public const MATCH_ANY = 'any';
27
28	/**
29	* Notification type.
30	*
31	* @var string
32	*/
33	public const ERROR = 'error';
34
35	/**
36	* Notification type.
37	*
38	* @var string
39	*/
40	public const WARNING = 'warning';
41
42	/**
43	* Notification type.
44	*
45	* @var string
46	*/
47	public const UPDATED = 'updated';
48
49	/**
50	* Options of this Notification.
51	*
52	* Contains optional arguments:
53	*
54	* - type: The notification type, i.e. 'updated' or 'error'
55	* - id: The ID of the notification
56	* - nonce: Security nonce to use in case of dismissible notice.
57	* - priority: From 0 to 1, determines the order of Notifications.
58	* - dismissal_key: Option name to save dismissal information in, ID will be used if not supplied.
59	* - capabilities: Capabilities that a user must have for this Notification to show.
60	* - capability_check: How to check capability pass: all or any.
61	* - wpseo_page_only: Only display on wpseo page or on every page.
62	* - yoast_branding: Whether to show the Yoast SEO branding in the notification.
63	* - resolve_nonce: Security nonce to use in case of resolving the notification.
64	*
65	* @var array
66	*/
67	private $options = [];
68
69	/**
70	* Contains default values for the optional arguments.
71	*
72	* @var array
73	*/
74	private $defaults = [
75	'type' => self::UPDATED,
76	'id' => '',
77	'user_id' => null,
78	'nonce' => null,
79	'priority' => 0.5,
80	'data_json' => [],
81	'dismissal_key' => null,
82	'capabilities' => [],
83	'capability_check' => self::MATCH_ALL,
84	'yoast_branding' => false,
85	'resolve_nonce' => '',
86	];
87
88	/**
89	* The message for the notification.
90	*
91	* @var string
92	*/
93	private $message;
94
95	/**
96	* Notification class constructor.
97	*
98	* @param string $message Message string.
99	* @param array $options Set of options.
100	*/
101	public function __construct( $message, $options = [] ) {	64✔
102	$this->message = $message;	64✔
103	$this->options = $this->normalize_options( $options );	64✔
104	}
105
106	/**
107	* Retrieve notification ID string.
108	*
109	* @return string
110	*/
111	public function get_id() {	28✔
112	return $this->options['id'];	28✔
113	}
114
115	/**
116	* Retrieve the user to show the notification for.
117	*
118	* @deprecated 21.6
119	* @codeCoverageIgnore
120	*
121	* @return WP_User\|null The user to show this notification for.
122	*/
123	public function get_user() {
124	_deprecated_function( __METHOD__, 'Yoast SEO 21.6' );
125	return null;
126	}
127
128	/**
129	* Retrieve the id of the user to show the notification for.
130	*
131	* Returns the id of the current user if not user has been sent.
132	*
133	* @return int The user id
134	*/
UNCOV 135	public function get_user_id() {	×
UNCOV 136	return ( $this->options['user_id'] ?? get_current_user_id() );	×
137	}
138
139	/**
140	* Retrieve nonce identifier.
141	*
142	* @return string\|null Nonce for this Notification.
143	*/
144	public function get_nonce() {	8✔
145	if ( $this->options['id'] && empty( $this->options['nonce'] ) ) {	8✔
146	$this->options['nonce'] = wp_create_nonce( $this->options['id'] );	4✔
147	}
148
149	return $this->options['nonce'];	8✔
150	}
151
152	/**
153	* Make sure the nonce is up to date.
154	*
155	* @return void
156	*/
UNCOV 157	public function refresh_nonce() {	×
UNCOV 158	if ( $this->options['id'] ) {	×
UNCOV 159	$this->options['nonce'] = wp_create_nonce( $this->options['id'] );	×
160	}
161	}
162
163	/**
164	* Get the type of the notification.
165	*
166	* @return string
167	*/
168	public function get_type() {	8✔
169	return $this->options['type'];	8✔
170	}
171
172	/**
173	* Priority of the notification.
174	*
175	* Relative to the type.
176	*
177	* @return float Returns the priority between 0 and 1.
178	*/
179	public function get_priority() {	4✔
180	return $this->options['priority'];	4✔
181	}
182
183	/**
184	* Get the nonce to resolve the alert.
185	*
186	* @return string
187	*/
UNCOV 188	public function get_resolve_nonce() {	×
UNCOV 189	return $this->options['resolve_nonce'];	×
190	}
191
192	/**
193	* Get the User Meta key to check for dismissal of notification.
194	*
195	* @return string User Meta Option key that registers dismissal.
196	*/
197	public function get_dismissal_key() {	8✔
198	if ( empty( $this->options['dismissal_key'] ) ) {	8✔
199	return $this->options['id'];	4✔
200	}
201
202	return $this->options['dismissal_key'];	4✔
203	}
204
205	/**
206	* Is this Notification persistent.
207	*
208	* @return bool True if persistent, False if fire and forget.
209	*/
210	public function is_persistent() {	28✔
211	$id = $this->get_id();	28✔
212
213	return ! empty( $id );	28✔
214	}
215
216	/**
217	* Check if the notification is relevant for the current user.
218	*
219	* @return bool True if a user needs to see this notification, false if not.
220	*/
221	public function display_for_current_user() {	24✔
222	// If the notification is for the current page only, always show.
223	if ( ! $this->is_persistent() ) {	24✔
224	return true;	4✔
225	}
226
227	// If the current user doesn't match capabilities.
228	return $this->match_capabilities();	20✔
229	}
230
231	/**
232	* Does the current user match required capabilities.
233	*
234	* @return bool
235	*/
236	public function match_capabilities() {	20✔
237	// Super Admin can do anything.
238	if ( is_multisite() && is_super_admin( $this->options['user_id'] ) ) {	20✔
UNCOV 239	return true;	×
240	}
241
242	/**
243	* Filter capabilities that enable the displaying of this notification.
244	*
245	* @param array $capabilities The capabilities that must be present for this notification.
246	* @param Yoast_Notification $notification The notification object.
247	*
248	* @return array Array of capabilities or empty for no restrictions.
249	*
250	* @since 3.2
251	*/
252	$capabilities = apply_filters( 'wpseo_notification_capabilities', $this->options['capabilities'], $this );	20✔
253
254	// Should be an array.
255	if ( ! is_array( $capabilities ) ) {	20✔
256	$capabilities = (array) $capabilities;	4✔
257	}
258
259	/**
260	* Filter capability check to enable all or any capabilities.
261	*
262	* @param string $capability_check The type of check that will be used to determine if an capability is present.
263	* @param Yoast_Notification $notification The notification object.
264	*
265	* @return string self::MATCH_ALL or self::MATCH_ANY.
266	*
267	* @since 3.2
268	*/
269	$capability_check = apply_filters( 'wpseo_notification_capability_check', $this->options['capability_check'], $this );	20✔
270
271	if ( ! in_array( $capability_check, [ self::MATCH_ALL, self::MATCH_ANY ], true ) ) {	20✔
UNCOV 272	$capability_check = self::MATCH_ALL;	×
273	}
274
275	if ( ! empty( $capabilities ) ) {	20✔
276
277	$has_capabilities = array_filter( $capabilities, [ $this, 'has_capability' ] );	20✔
278
279	switch ( $capability_check ) {
280	case self::MATCH_ALL:
281	return $has_capabilities === $capabilities;	12✔
282	case self::MATCH_ANY:
283	return ! empty( $has_capabilities );	8✔
284	}
285	}
286
UNCOV 287	return true;	×
288	}
289
290	/**
291	* Array filter function to find matched capabilities.
292	*
293	* @param string $capability Capability to test.
294	*
295	* @return bool
296	*/
297	private function has_capability( $capability ) {	20✔
298	$user_id = $this->options['user_id'];	20✔
299	if ( ! is_numeric( $user_id ) ) {	20✔
UNCOV 300	return false;	×
301	}
302	$user = get_user_by( 'id', $user_id );	20✔
303	if ( ! $user ) {	20✔
UNCOV 304	return false;	×
305	}
306
307	return $user->has_cap( $capability );	20✔
308	}
309
310	/**
311	* Return the object properties as an array.
312	*
313	* @return array
314	*/
315	public function to_array() {	8✔
316	return [	8✔
317	'message' => $this->message,	8✔
318	'options' => $this->options,	8✔
319	];	8✔
320	}
321
322	/**
323	* Adds string (view) behaviour to the notification.
324	*
325	* @return string
326	*/
UNCOV 327	public function __toString() {	×
328	return $this->render();	×
329	}
330
331	/**
332	* Renders the notification as a string.
333	*
334	* @return string The rendered notification.
335	*/
UNCOV 336	public function render() {	×
UNCOV 337	$attributes = [];	×
338
339	// Default notification classes.
UNCOV 340	$classes = [	×
UNCOV 341	'yoast-notification',	×
UNCOV 342	];	×
343
344	// Maintain WordPress visualisation of notifications when they are not persistent.
345	if ( ! $this->is_persistent() ) {	×
346	$classes[] = 'notice';	×
347	$classes[] = $this->get_type();	×
348	}
349
350	if ( ! empty( $classes ) ) {	×
351	$attributes['class'] = implode( ' ', $classes );	×
352	}
353
354	// Combined attribute key and value into a string.
355	array_walk( $attributes, [ $this, 'parse_attributes' ] );	×
356
UNCOV 357	$message = null;	×
UNCOV 358	if ( $this->options['yoast_branding'] ) {	×
UNCOV 359	$message = $this->wrap_yoast_seo_icon( $this->message );	×
360	}
361
UNCOV 362	if ( $message === null ) {	×
363	$message = wpautop( $this->message );	×
364	}
365
366	// Build the output DIV.
UNCOV 367	return '<div ' . implode( ' ', $attributes ) . '>' . $message . '</div>' . PHP_EOL;	×
368	}
369
370	/**
371	* Get the message for the notification.
372	*
373	* @return string The message.
374	*/
375	public function get_message() {	×
376	return wpautop( $this->message );	×
377	}
378
379	/**
380	* Wraps the message with a Yoast SEO icon.
381	*
382	* @param string $message The message to wrap.
383	*
384	* @return string The wrapped message.
385	*/
UNCOV 386	private function wrap_yoast_seo_icon( $message ) {	×
UNCOV 387	$out = sprintf(	×
UNCOV 388	'<img src="%1$s" height="%2$d" width="%3$d" class="yoast-seo-icon" />',	×
UNCOV 389	esc_url( plugin_dir_url( WPSEO_FILE ) . 'packages/js/images/Yoast_SEO_Icon.svg' ),	×
UNCOV 390	60,	×
UNCOV 391	60	×
UNCOV 392	);	×
UNCOV 393	$out .= '<div class="yoast-seo-icon-wrap">';	×
UNCOV 394	$out .= $message;	×
UNCOV 395	$out .= '</div>';	×
396
UNCOV 397	return $out;	×
398	}
399
400	/**
401	* Get the JSON if provided.
402	*
403	* @return string\|false
404	*/
405	public function get_json() {	4✔
406	if ( empty( $this->options['data_json'] ) ) {	4✔
407	return '';	4✔
408	}
409
410	return WPSEO_Utils::format_json_encode( $this->options['data_json'] );	4✔
411	}
412
413	/**
414	* Make sure we only have values that we can work with.
415	*
416	* @param array $options Options to normalize.
417	*
418	* @return array
419	*/
420	private function normalize_options( $options ) {	64✔
421	$options = wp_parse_args( $options, $this->defaults );	64✔
422
423	// Should not exceed 0 or 1.
424	$options['priority'] = min( 1, max( 0, $options['priority'] ) );	64✔
425
426	// Set default capabilities when not supplied.
427	if ( empty( $options['capabilities'] ) \|\| $options['capabilities'] === [] ) {	64✔
428	$options['capabilities'] = [ 'wpseo_manage_options' ];	44✔
429	}
430
431	// Set to the id of the current user if not supplied.
432	if ( $options['user_id'] === null ) {	64✔
433	$options['user_id'] = get_current_user_id();	64✔
434	}
435
436	return $options;	64✔
437	}
438
439	/**
440	* Format HTML element attributes.
441	*
442	* @param string $value Attribute value.
443	* @param string $key Attribute name.
444	*
445	* @return void
446	*/
UNCOV 447	private function parse_attributes( &$value, $key ) {	×
UNCOV 448	$value = sprintf( '%s="%s"', sanitize_key( $key ), esc_attr( $value ) );	×
449	}
450	}

Yoast / wordpress-seo / 9f70c0278dfa8a47317c8094b5259465fbcd3325

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