dd6e866a9e6d253114633104d9e3858d807178ba

Committed 19 Jun 2024 10:03AM UTC coverage: 48.628% (-4.3%) from 52.936%

Build # dd6e866a9e6d253114633104d9e3858d807178ba

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #21431 from Yoast/21429-update-copy-in-the-introduction-and-consent-modals

Updates the copy for the introduction and consent modals

Run Details

7441 of 13454 branches covered (55.31%)

Branch coverage included in aggregate %.

0 of 3 new or added lines in 2 files covered. (0.0%)

3718 existing lines in 107 files now uncovered.

25100 of 53464 relevant lines covered (46.95%)

62392.47 hits per line

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

73.68

/inc/class-yoast-dynamic-rewrites.php

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

/**
 * Class containing an alternative rewrite rules API for handling them dynamically without requiring flushing rules.
 */
class Yoast_Dynamic_Rewrites implements WPSEO_WordPress_Integration {

        /**
         * Additional rewrite rules with high priority.
         *
         * @var array
         */
        protected $extra_rules_top = [];

        /**
         * Additional rewrite rules with low priority.
         *
         * @var array
         */
        protected $extra_rules_bottom = [];

        /**
         * Main instance holder.
         *
         * @var self|null
         */
        protected static $instance = null;

        /**
         * WP_Rewrite instance to use.
         *
         * @var WP_Rewrite
         */
        public $wp_rewrite;

        /**
         * Gets the main instance of the class.
         *
         * @return self Dynamic rewrites main instance.
         */
        public static function instance() {
                if ( self::$instance === null ) {
                        self::$instance = new self();
                        self::$instance->register_hooks();
                }

                return self::$instance;
        }

        /**
         * Constructor.
         *
         * Sets the WP_Rewrite instance to use.
         *
         * @param WP_Rewrite|null $rewrite Optional. WP_Rewrite instance to use. Default is the $wp_rewrite global.
         * @throws RuntimeException Throws an exception if the $wp_rewrite global is not set.
         */
        public function __construct( $rewrite = null ) {
                if ( ! $rewrite ) {
                        if ( empty( $GLOBALS['wp_rewrite'] ) ) {
                                /* translators: 1: PHP class name, 2: PHP variable name */
                                throw new RuntimeException( sprintf( __( 'The %1$s class must not be instantiated before the %2$s global is set.', 'wordpress-seo' ), self::class, '$wp_rewrite' ) );
                        }

                        $rewrite = $GLOBALS['wp_rewrite'];
                }

                $this->wp_rewrite = $rewrite;
        }

        /**
         * Registers all necessary hooks with WordPress.
         *
         * @return void
         */
        public function register_hooks() {
                add_action( 'init', [ $this, 'trigger_dynamic_rewrite_rules_hook' ], 1 );
                add_filter( 'option_rewrite_rules', [ $this, 'filter_rewrite_rules_option' ] );
                add_filter( 'sanitize_option_rewrite_rules', [ $this, 'sanitize_rewrite_rules_option' ] );
        }

        /**
         * Adds a dynamic rewrite rule that transforms a URL structure to a set of query vars.
         *
         * Rules registered with this method are applied dynamically and do not require the rewrite rules
         * to be flushed in order to become active, which is a benefit over the regular WordPress core API.
         * Note however that the dynamic application only works for rules that correspond to index.php.
         * Non-WordPress rewrite rules still require flushing.
         *
         * Any value in the $after parameter that isn't 'bottom' will result in the rule
         * being placed at the top of the rewrite rules.
         *
         * @param string       $regex    Regular expression to match request against.
         * @param string|array $query    The corresponding query vars for this rewrite rule.
         * @param string       $priority Optional. Priority of the new rule. Accepts 'top'
         *                               or 'bottom'. Default 'bottom'.
         *
         * @return void
         */
        public function add_rule( $regex, $query, $priority = 'bottom' ) {
                if ( is_array( $query ) ) {
                        $query = add_query_arg( $query, 'index.php' );
                }

                $this->wp_rewrite->add_rule( $regex, $query, $priority );

                // Do not further handle external rules.
                if ( substr( $query, 0, strlen( $this->wp_rewrite->index . '?' ) ) !== $this->wp_rewrite->index . '?' ) {
                        return;
                }

                if ( $priority === 'bottom' ) {
                        $this->extra_rules_bottom[ $regex ] = $query;
                        return;
                }

                $this->extra_rules_top[ $regex ] = $query;
        }

        /**
         * Triggers the hook on which rewrite rules should be added.
         *
         * This allows for a more specific point in time from the generic `init` hook where this is
         * otherwise handled.
         *
         * @return void
         */
        public function trigger_dynamic_rewrite_rules_hook() {

                /**
                 * Fires when the plugin's dynamic rewrite rules should be added.
                 *
                 * @param self $dynamic_rewrites Dynamic rewrites handler instance. Use its `add_rule()` method
                 *                               to add dynamic rewrite rules.
                 */
                do_action( 'yoast_add_dynamic_rewrite_rules', $this );
        }

        /**
         * Filters the rewrite rules option to dynamically add additional rewrite rules.
         *
         * @param array|string $rewrite_rules Array of rewrite rule $regex => $query pairs, or empty string
         *                                    if currently not set.
         *
         * @return array|string Filtered value of $rewrite_rules.
         */
        public function filter_rewrite_rules_option( $rewrite_rules ) {
                // Do not add extra rewrite rules if the rules need to be flushed.
                if ( empty( $rewrite_rules ) ) {
                        return $rewrite_rules;
                }

                return array_merge( $this->extra_rules_top, $rewrite_rules, $this->extra_rules_bottom );
        }

        /**
         * Sanitizes the rewrite rules option prior to writing it to the database.
         *
         * This method ensures that the dynamic rewrite rules do not become part of the actual option.
         *
         * @param array|string $rewrite_rules Array pf rewrite rule $regex => $query pairs, or empty string
         *                                    in order to unset.
         *
         * @return array|string Filtered value of $rewrite_rules before writing the option.
         */
        public function sanitize_rewrite_rules_option( $rewrite_rules ) {
                if ( empty( $rewrite_rules ) ) {
                        return $rewrite_rules;
                }

                return array_diff_key( $rewrite_rules, $this->extra_rules_top, $this->extra_rules_bottom );
        }
}

1	<?php
2	/**
3	* WPSEO plugin file.
4	*
5	* @package WPSEO\Internals
6	*/
7
8	/**
9	* Class containing an alternative rewrite rules API for handling them dynamically without requiring flushing rules.
10	*/
11	class Yoast_Dynamic_Rewrites implements WPSEO_WordPress_Integration {
12
13	/**
14	* Additional rewrite rules with high priority.
15	*
16	* @var array
17	*/
18	protected $extra_rules_top = [];
19
20	/**
21	* Additional rewrite rules with low priority.
22	*
23	* @var array
24	*/
25	protected $extra_rules_bottom = [];
26
27	/**
28	* Main instance holder.
29	*
30	* @var self\|null
31	*/
32	protected static $instance = null;
33
34	/**
35	* WP_Rewrite instance to use.
36	*
37	* @var WP_Rewrite
38	*/
39	public $wp_rewrite;
40
41	/**
42	* Gets the main instance of the class.
43	*
44	* @return self Dynamic rewrites main instance.
45	*/
46	public static function instance() {	2✔
47	if ( self::$instance === null ) {	2✔
48	self::$instance = new self();	2✔
49	self::$instance->register_hooks();	2✔
50	}
51
52	return self::$instance;	2✔
53	}
54
55	/**
56	* Constructor.
57	*
58	* Sets the WP_Rewrite instance to use.
59	*
60	* @param WP_Rewrite\|null $rewrite Optional. WP_Rewrite instance to use. Default is the $wp_rewrite global.
61	* @throws RuntimeException Throws an exception if the $wp_rewrite global is not set.
62	*/
63	public function __construct( $rewrite = null ) {	4✔
64	if ( ! $rewrite ) {	4✔
65	if ( empty( $GLOBALS['wp_rewrite'] ) ) {	4✔
66	/* translators: 1: PHP class name, 2: PHP variable name */
67	throw new RuntimeException( sprintf( __( 'The %1$s class must not be instantiated before the %2$s global is set.', 'wordpress-seo' ), self::class, '$wp_rewrite' ) );	2✔
68	}
69
70	$rewrite = $GLOBALS['wp_rewrite'];	2✔
71	}
72
73	$this->wp_rewrite = $rewrite;	4✔
74	}	2✔
75
76	/**
77	* Registers all necessary hooks with WordPress.
78	*
79	* @return void
80	*/
81	public function register_hooks() {	2✔
82	add_action( 'init', [ $this, 'trigger_dynamic_rewrite_rules_hook' ], 1 );	2✔
83	add_filter( 'option_rewrite_rules', [ $this, 'filter_rewrite_rules_option' ] );	2✔
84	add_filter( 'sanitize_option_rewrite_rules', [ $this, 'sanitize_rewrite_rules_option' ] );	2✔
85	}	1✔
86
87	/**
88	* Adds a dynamic rewrite rule that transforms a URL structure to a set of query vars.
89	*
90	* Rules registered with this method are applied dynamically and do not require the rewrite rules
91	* to be flushed in order to become active, which is a benefit over the regular WordPress core API.
92	* Note however that the dynamic application only works for rules that correspond to index.php.
93	* Non-WordPress rewrite rules still require flushing.
94	*
95	* Any value in the $after parameter that isn't 'bottom' will result in the rule
96	* being placed at the top of the rewrite rules.
97	*
98	* @param string $regex Regular expression to match request against.
99	* @param string\|array $query The corresponding query vars for this rewrite rule.
100	* @param string $priority Optional. Priority of the new rule. Accepts 'top'
101	* or 'bottom'. Default 'bottom'.
102	*
103	* @return void
104	*/
UNCOV 105	public function add_rule( $regex, $query, $priority = 'bottom' ) {	×
UNCOV 106	if ( is_array( $query ) ) {	×
UNCOV 107	$query = add_query_arg( $query, 'index.php' );	×
108	}
109
UNCOV 110	$this->wp_rewrite->add_rule( $regex, $query, $priority );	×
111
112	// Do not further handle external rules.
UNCOV 113	if ( substr( $query, 0, strlen( $this->wp_rewrite->index . '?' ) ) !== $this->wp_rewrite->index . '?' ) {	×
UNCOV 114	return;	×
115	}
116
UNCOV 117	if ( $priority === 'bottom' ) {	×
UNCOV 118	$this->extra_rules_bottom[ $regex ] = $query;	×
UNCOV 119	return;	×
120	}
121
UNCOV 122	$this->extra_rules_top[ $regex ] = $query;	×
123	}
124
125	/**
126	* Triggers the hook on which rewrite rules should be added.
127	*
128	* This allows for a more specific point in time from the generic `init` hook where this is
129	* otherwise handled.
130	*
131	* @return void
132	*/
133	public function trigger_dynamic_rewrite_rules_hook() {	2✔
134
135	/**
136	* Fires when the plugin's dynamic rewrite rules should be added.
137	*
138	* @param self $dynamic_rewrites Dynamic rewrites handler instance. Use its `add_rule()` method
139	* to add dynamic rewrite rules.
140	*/
141	do_action( 'yoast_add_dynamic_rewrite_rules', $this );	2✔
142	}	1✔
143
144	/**
145	* Filters the rewrite rules option to dynamically add additional rewrite rules.
146	*
147	* @param array\|string $rewrite_rules Array of rewrite rule $regex => $query pairs, or empty string
148	* if currently not set.
149	*
150	* @return array\|string Filtered value of $rewrite_rules.
151	*/
152	public function filter_rewrite_rules_option( $rewrite_rules ) {	4✔
153	// Do not add extra rewrite rules if the rules need to be flushed.
154	if ( empty( $rewrite_rules ) ) {	4✔
155	return $rewrite_rules;	2✔
156	}
157
158	return array_merge( $this->extra_rules_top, $rewrite_rules, $this->extra_rules_bottom );	2✔
159	}
160
161	/**
162	* Sanitizes the rewrite rules option prior to writing it to the database.
163	*
164	* This method ensures that the dynamic rewrite rules do not become part of the actual option.
165	*
166	* @param array\|string $rewrite_rules Array pf rewrite rule $regex => $query pairs, or empty string
167	* in order to unset.
168	*
169	* @return array\|string Filtered value of $rewrite_rules before writing the option.
170	*/
171	public function sanitize_rewrite_rules_option( $rewrite_rules ) {	4✔
172	if ( empty( $rewrite_rules ) ) {	4✔
173	return $rewrite_rules;	2✔
174	}
175
176	return array_diff_key( $rewrite_rules, $this->extra_rules_top, $this->extra_rules_bottom );	2✔
177	}
178	}

Yoast / wordpress-seo / dd6e866a9e6d253114633104d9e3858d807178ba

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