6987097851

Committed 25 Nov 2023 04:49AM UTC coverage: 49.206% (-0.1%) from 49.302%

Build # 6987097851

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #20878 from Yoast/JRF/ghactions-minor-tweak

GH Actions: update a few links in inline comments

Run Details

15305 of 31104 relevant lines covered (49.21%)

4.03 hits per line

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

71.59

/src/integrations/watchers/indexable-permalink-watcher.php

<?php

namespace Yoast\WP\SEO\Integrations\Watchers;

use Yoast\WP\SEO\Conditionals\Migrations_Conditional;
use Yoast\WP\SEO\Config\Indexing_Reasons;
use Yoast\WP\SEO\Helpers\Indexable_Helper;
use Yoast\WP\SEO\Helpers\Options_Helper;
use Yoast\WP\SEO\Helpers\Post_Type_Helper;
use Yoast\WP\SEO\Helpers\Taxonomy_Helper;
use Yoast\WP\SEO\Integrations\Integration_Interface;

/**
 * WordPress Permalink structure watcher.
 *
 * Handles updates to the permalink_structure for the Indexables table.
 */
class Indexable_Permalink_Watcher implements Integration_Interface {

        /**
         * Represents the options helper.
         *
         * @var Options_Helper
         */
        protected $options_helper;

        /**
         * The taxonomy helper.
         *
         * @var Taxonomy_Helper
         */
        protected $taxonomy_helper;

        /**
         * The post type helper.
         *
         * @var Post_Type_Helper
         */
        private $post_type;

        /**
         * The indexable helper.
         *
         * @var Indexable_Helper
         */
        protected $indexable_helper;

        /**
         * Returns the conditionals based on which this loadable should be active.
         *
         * @return array
         */
        public static function get_conditionals() {
                return [ Migrations_Conditional::class ];
        }

        /**
         * Indexable_Permalink_Watcher constructor.
         *
         * @param Post_Type_Helper $post_type       The post type helper.
         * @param Options_Helper   $options         The options helper.
         * @param Indexable_Helper $indexable       The indexable helper.
         * @param Taxonomy_Helper  $taxonomy_helper The taxonomy helper.
         */
        public function __construct( Post_Type_Helper $post_type, Options_Helper $options, Indexable_Helper $indexable, Taxonomy_Helper $taxonomy_helper ) {
                $this->post_type        = $post_type;
                $this->options_helper   = $options;
                $this->indexable_helper = $indexable;
                $this->taxonomy_helper  = $taxonomy_helper;

                $this->schedule_cron();
        }

        /**
         * Registers the hooks.
         *
         * @return void
         */
        public function register_hooks() {
                \add_action( 'update_option_permalink_structure', [ $this, 'reset_permalinks' ] );
                \add_action( 'update_option_category_base', [ $this, 'reset_permalinks_term' ], 10, 3 );
                \add_action( 'update_option_tag_base', [ $this, 'reset_permalinks_term' ], 10, 3 );
                \add_action( 'wpseo_permalink_structure_check', [ $this, 'force_reset_permalinks' ] );
                \add_action( 'wpseo_deactivate', [ $this, 'unschedule_cron' ] );
        }

        /**
         * Resets the permalinks for everything that is related to the permalink structure.
         */
        public function reset_permalinks() {

                $post_types = $this->get_post_types();
                foreach ( $post_types as $post_type ) {
                        $this->reset_permalinks_post_type( $post_type );
                }

                $taxonomies = $this->get_taxonomies_for_post_types( $post_types );
                foreach ( $taxonomies as $taxonomy ) {
                        $this->indexable_helper->reset_permalink_indexables( 'term', $taxonomy );
                }

                $this->indexable_helper->reset_permalink_indexables( 'user' );
                $this->indexable_helper->reset_permalink_indexables( 'date-archive' );
                $this->indexable_helper->reset_permalink_indexables( 'system-page' );

                // Always update `permalink_structure` in the wpseo option.
                $this->options_helper->set( 'permalink_structure', \get_option( 'permalink_structure' ) );
        }

        /**
         * Resets the permalink for the given post type.
         *
         * @param string $post_type The post type to reset.
         */
        public function reset_permalinks_post_type( $post_type ) {
                $this->indexable_helper->reset_permalink_indexables( 'post', $post_type );
                $this->indexable_helper->reset_permalink_indexables( 'post-type-archive', $post_type );
        }

        /**
         * Resets the term indexables when the base has been changed.
         *
         * @param string $old_value Unused. The old option value.
         * @param string $new_value Unused. The new option value.
         * @param string $type      The option name.
         */
        public function reset_permalinks_term( $old_value, $new_value, $type ) {
                $subtype = $type;

                $reason = Indexing_Reasons::REASON_PERMALINK_SETTINGS;

                // When the subtype contains _base, just strip it.
                if ( \strstr( $subtype, '_base' ) ) {
                        $subtype = \substr( $type, 0, -5 );
                }

                if ( $subtype === 'tag' ) {
                        $subtype = 'post_tag';
                        $reason  = Indexing_Reasons::REASON_TAG_BASE_PREFIX;
                }

                if ( $subtype === 'category' ) {
                        $reason = Indexing_Reasons::REASON_CATEGORY_BASE_PREFIX;
                }

                $this->indexable_helper->reset_permalink_indexables( 'term', $subtype, $reason );
        }

        /**
         * Resets the permalink indexables automatically, if necessary.
         *
         * @return bool Whether the reset request ran.
         */
        public function force_reset_permalinks() {
                if ( \get_option( 'tag_base' ) !== $this->options_helper->get( 'tag_base_url' ) ) {
                        $this->reset_permalinks_term( null, null, 'tag_base' );
                        $this->options_helper->set( 'tag_base_url', \get_option( 'tag_base' ) );
                }
                if ( \get_option( 'category_base' ) !== $this->options_helper->get( 'category_base_url' ) ) {
                        $this->reset_permalinks_term( null, null, 'category_base' );
                        $this->options_helper->set( 'category_base_url', \get_option( 'category_base' ) );
                }

                if ( $this->should_reset_permalinks() ) {
                        $this->reset_permalinks();

                        return true;
                }

                $this->reset_altered_custom_taxonomies();

                return true;
        }

        /**
         * Checks whether the permalinks should be reset after `permalink_structure` has changed.
         *
         * @return bool Whether the permalinks should be reset.
         */
        public function should_reset_permalinks() {
                return \get_option( 'permalink_structure' ) !== $this->options_helper->get( 'permalink_structure' );
        }

        /**
         * Resets custom taxonomies if their slugs have changed.
         *
         * @return void
         */
        public function reset_altered_custom_taxonomies() {
                $taxonomies            = $this->taxonomy_helper->get_custom_taxonomies();
                $custom_taxonomy_bases = $this->options_helper->get( 'custom_taxonomy_slugs', [] );
                $new_taxonomy_bases    = [];

                foreach ( $taxonomies as $taxonomy ) {
                        $taxonomy_slug = $this->taxonomy_helper->get_taxonomy_slug( $taxonomy );

                        $new_taxonomy_bases[ $taxonomy ] = $taxonomy_slug;

                        if ( ! \array_key_exists( $taxonomy, $custom_taxonomy_bases ) ) {
                                continue;
                        }

                        if ( $taxonomy_slug !== $custom_taxonomy_bases[ $taxonomy ] ) {
                                $this->indexable_helper->reset_permalink_indexables( 'term', $taxonomy );
                        }
                }

                $this->options_helper->set( 'custom_taxonomy_slugs', $new_taxonomy_bases );
        }

        /**
         * Retrieves a list with the public post types.
         *
         * @return array The post types.
         */
        protected function get_post_types() {
                /**
                 * Filter: Gives the possibility to filter out post types.
                 *
                 * @param array $post_types The post type names.
                 *
                 * @return array The post types.
                 */
                $post_types = \apply_filters( 'wpseo_post_types_reset_permalinks', $this->post_type->get_public_post_types() );

                return $post_types;
        }

        /**
         * Retrieves the taxonomies that belongs to the public post types.
         *
         * @param array $post_types The post types to get taxonomies for.
         *
         * @return array The retrieved taxonomies.
         */
        protected function get_taxonomies_for_post_types( $post_types ) {
                $taxonomies = [];
                foreach ( $post_types as $post_type ) {
                        $taxonomies[] = \get_object_taxonomies( $post_type, 'names' );
                }

                $taxonomies = \array_merge( [], ...$taxonomies );
                $taxonomies = \array_unique( $taxonomies );

                return $taxonomies;
        }

        /**
         * Schedules the WP-Cron job to check the permalink_structure status.
         *
         * @return void
         */
        protected function schedule_cron() {
                if ( \wp_next_scheduled( 'wpseo_permalink_structure_check' ) ) {
                        return;
                }

                \wp_schedule_event( \time(), 'daily', 'wpseo_permalink_structure_check' );
        }

        /**
         * Unschedules the WP-Cron job to check the permalink_structure status.
         *
         * @return void
         */
        public function unschedule_cron() {
                if ( ! \wp_next_scheduled( 'wpseo_permalink_structure_check' ) ) {
                        return;
                }

                \wp_clear_scheduled_hook( 'wpseo_permalink_structure_check' );
        }
}

1	<?php
2
3	namespace Yoast\WP\SEO\Integrations\Watchers;
4
5	use Yoast\WP\SEO\Conditionals\Migrations_Conditional;
6	use Yoast\WP\SEO\Config\Indexing_Reasons;
7	use Yoast\WP\SEO\Helpers\Indexable_Helper;
8	use Yoast\WP\SEO\Helpers\Options_Helper;
9	use Yoast\WP\SEO\Helpers\Post_Type_Helper;
10	use Yoast\WP\SEO\Helpers\Taxonomy_Helper;
11	use Yoast\WP\SEO\Integrations\Integration_Interface;
12
13	/**
14	* WordPress Permalink structure watcher.
15	*
16	* Handles updates to the permalink_structure for the Indexables table.
17	*/
18	class Indexable_Permalink_Watcher implements Integration_Interface {
19
20	/**
21	* Represents the options helper.
22	*
23	* @var Options_Helper
24	*/
25	protected $options_helper;
26
27	/**
28	* The taxonomy helper.
29	*
30	* @var Taxonomy_Helper
31	*/
32	protected $taxonomy_helper;
33
34	/**
35	* The post type helper.
36	*
37	* @var Post_Type_Helper
38	*/
39	private $post_type;
40
41	/**
42	* The indexable helper.
43	*
44	* @var Indexable_Helper
45	*/
46	protected $indexable_helper;
47
48	/**
49	* Returns the conditionals based on which this loadable should be active.
50	*
51	* @return array
52	*/
53	public static function get_conditionals() {	2✔
54	return [ Migrations_Conditional::class ];	2✔
55	}
56
57	/**
58	* Indexable_Permalink_Watcher constructor.
59	*
60	* @param Post_Type_Helper $post_type The post type helper.
61	* @param Options_Helper $options The options helper.
62	* @param Indexable_Helper $indexable The indexable helper.
63	* @param Taxonomy_Helper $taxonomy_helper The taxonomy helper.
64	*/
65	public function __construct( Post_Type_Helper $post_type, Options_Helper $options, Indexable_Helper $indexable, Taxonomy_Helper $taxonomy_helper ) {	×
66	$this->post_type = $post_type;	×
67	$this->options_helper = $options;	×
68	$this->indexable_helper = $indexable;	×
69	$this->taxonomy_helper = $taxonomy_helper;	×
70
71	$this->schedule_cron();	×
72	}
73
74	/**
75	* Registers the hooks.
76	*
77	* @return void
78	*/
79	public function register_hooks() {	2✔
80	\add_action( 'update_option_permalink_structure', [ $this, 'reset_permalinks' ] );	2✔
81	\add_action( 'update_option_category_base', [ $this, 'reset_permalinks_term' ], 10, 3 );	2✔
82	\add_action( 'update_option_tag_base', [ $this, 'reset_permalinks_term' ], 10, 3 );	2✔
83	\add_action( 'wpseo_permalink_structure_check', [ $this, 'force_reset_permalinks' ] );	2✔
84	\add_action( 'wpseo_deactivate', [ $this, 'unschedule_cron' ] );	2✔
85	}	1✔
86
87	/**
88	* Resets the permalinks for everything that is related to the permalink structure.
89	*/
90	public function reset_permalinks() {	2✔
91
92	$post_types = $this->get_post_types();	2✔
93	foreach ( $post_types as $post_type ) {	2✔
94	$this->reset_permalinks_post_type( $post_type );	2✔
95	}
96
97	$taxonomies = $this->get_taxonomies_for_post_types( $post_types );	2✔
98	foreach ( $taxonomies as $taxonomy ) {	2✔
99	$this->indexable_helper->reset_permalink_indexables( 'term', $taxonomy );	2✔
100	}
101
102	$this->indexable_helper->reset_permalink_indexables( 'user' );	2✔
103	$this->indexable_helper->reset_permalink_indexables( 'date-archive' );	2✔
104	$this->indexable_helper->reset_permalink_indexables( 'system-page' );	2✔
105
106	// Always update `permalink_structure` in the wpseo option.
107	$this->options_helper->set( 'permalink_structure', \get_option( 'permalink_structure' ) );	2✔
108	}	1✔
109
110	/**
111	* Resets the permalink for the given post type.
112	*
113	* @param string $post_type The post type to reset.
114	*/
115	public function reset_permalinks_post_type( $post_type ) {	2✔
116	$this->indexable_helper->reset_permalink_indexables( 'post', $post_type );	2✔
117	$this->indexable_helper->reset_permalink_indexables( 'post-type-archive', $post_type );	2✔
118	}	1✔
119
120	/**
121	* Resets the term indexables when the base has been changed.
122	*
123	* @param string $old_value Unused. The old option value.
124	* @param string $new_value Unused. The new option value.
125	* @param string $type The option name.
126	*/
127	public function reset_permalinks_term( $old_value, $new_value, $type ) {	4✔
128	$subtype = $type;	4✔
129
130	$reason = Indexing_Reasons::REASON_PERMALINK_SETTINGS;	4✔
131
132	// When the subtype contains _base, just strip it.
133	if ( \strstr( $subtype, '_base' ) ) {	4✔
134	$subtype = \substr( $type, 0, -5 );	4✔
135	}
136
137	if ( $subtype === 'tag' ) {	4✔
138	$subtype = 'post_tag';	2✔
139	$reason = Indexing_Reasons::REASON_TAG_BASE_PREFIX;	2✔
140	}
141
142	if ( $subtype === 'category' ) {	4✔
143	$reason = Indexing_Reasons::REASON_CATEGORY_BASE_PREFIX;	2✔
144	}
145
146	$this->indexable_helper->reset_permalink_indexables( 'term', $subtype, $reason );	4✔
147	}	2✔
148
149	/**
150	* Resets the permalink indexables automatically, if necessary.
151	*
152	* @return bool Whether the reset request ran.
153	*/
154	public function force_reset_permalinks() {	8✔
155	if ( \get_option( 'tag_base' ) !== $this->options_helper->get( 'tag_base_url' ) ) {	8✔
156	$this->reset_permalinks_term( null, null, 'tag_base' );	2✔
157	$this->options_helper->set( 'tag_base_url', \get_option( 'tag_base' ) );	2✔
158	}
159	if ( \get_option( 'category_base' ) !== $this->options_helper->get( 'category_base_url' ) ) {	8✔
160	$this->reset_permalinks_term( null, null, 'category_base' );	2✔
161	$this->options_helper->set( 'category_base_url', \get_option( 'category_base' ) );	2✔
162	}
163
164	if ( $this->should_reset_permalinks() ) {	8✔
165	$this->reset_permalinks();	2✔
166
167	return true;	2✔
168	}
169
170	$this->reset_altered_custom_taxonomies();	6✔
171
172	return true;	6✔
173	}
174
175	/**
176	* Checks whether the permalinks should be reset after `permalink_structure` has changed.
177	*
178	* @return bool Whether the permalinks should be reset.
179	*/
180	public function should_reset_permalinks() {	4✔
181	return \get_option( 'permalink_structure' ) !== $this->options_helper->get( 'permalink_structure' );	4✔
182	}
183
184	/**
185	* Resets custom taxonomies if their slugs have changed.
186	*
187	* @return void
188	*/
189	public function reset_altered_custom_taxonomies() {	4✔
190	$taxonomies = $this->taxonomy_helper->get_custom_taxonomies();	4✔
191	$custom_taxonomy_bases = $this->options_helper->get( 'custom_taxonomy_slugs', [] );	4✔
192	$new_taxonomy_bases = [];	4✔
193
194	foreach ( $taxonomies as $taxonomy ) {	4✔
195	$taxonomy_slug = $this->taxonomy_helper->get_taxonomy_slug( $taxonomy );	4✔
196
197	$new_taxonomy_bases[ $taxonomy ] = $taxonomy_slug;	4✔
198
199	if ( ! \array_key_exists( $taxonomy, $custom_taxonomy_bases ) ) {	4✔
200	continue;	×
201	}
202
203	if ( $taxonomy_slug !== $custom_taxonomy_bases[ $taxonomy ] ) {	4✔
204	$this->indexable_helper->reset_permalink_indexables( 'term', $taxonomy );	2✔
205	}
206	}
207
208	$this->options_helper->set( 'custom_taxonomy_slugs', $new_taxonomy_bases );	4✔
209	}	2✔
210
211	/**
212	* Retrieves a list with the public post types.
213	*
214	* @return array The post types.
215	*/
216	protected function get_post_types() {	×
217	/**
218	* Filter: Gives the possibility to filter out post types.
219	*
220	* @param array $post_types The post type names.
221	*
222	* @return array The post types.
223	*/
224	$post_types = \apply_filters( 'wpseo_post_types_reset_permalinks', $this->post_type->get_public_post_types() );	×
225
226	return $post_types;	×
227	}
228
229	/**
230	* Retrieves the taxonomies that belongs to the public post types.
231	*
232	* @param array $post_types The post types to get taxonomies for.
233	*
234	* @return array The retrieved taxonomies.
235	*/
236	protected function get_taxonomies_for_post_types( $post_types ) {	×
237	$taxonomies = [];	×
238	foreach ( $post_types as $post_type ) {	×
239	$taxonomies[] = \get_object_taxonomies( $post_type, 'names' );	×
240	}
241
242	$taxonomies = \array_merge( [], ...$taxonomies );	×
243	$taxonomies = \array_unique( $taxonomies );	×
244
245	return $taxonomies;	×
246	}
247
248	/**
249	* Schedules the WP-Cron job to check the permalink_structure status.
250	*
251	* @return void
252	*/
253	protected function schedule_cron() {	×
254	if ( \wp_next_scheduled( 'wpseo_permalink_structure_check' ) ) {	×
255	return;	×
256	}
257
258	\wp_schedule_event( \time(), 'daily', 'wpseo_permalink_structure_check' );	×
259	}
260
261	/**
262	* Unschedules the WP-Cron job to check the permalink_structure status.
263	*
264	* @return void
265	*/
266	public function unschedule_cron() {	×
267	if ( ! \wp_next_scheduled( 'wpseo_permalink_structure_check' ) ) {	×
268	return;	×
269	}
270
271	\wp_clear_scheduled_hook( 'wpseo_permalink_structure_check' );	×
272	}
273	}

Yoast / wordpress-seo / 6987097851

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