d5d0a48b1bb965a14f46d58478ae2aa521f42520

Committed 05 Jun 2024 10:46AM UTC coverage: 52.695% (+0.03%) from 52.67%

Build # d5d0a48b1bb965a14f46d58478ae2aa521f42520

Build Type

push

github

Committed by

mhkuu

Commit Message

Merge branch 'trunk' of github.com:Yoast/wordpress-seo into feature/fix-assessments

Run Details

7438 of 13504 branches covered (55.08%)

Branch coverage included in aggregate %.

17 of 31 new or added lines in 5 files covered. (54.84%)

1 existing line in 1 file now uncovered.

28398 of 54503 relevant lines covered (52.1%)

41401.2 hits per line

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

0.0

/admin/menu/class-base-menu.php

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

use Yoast\WP\SEO\Promotions\Application\Promotion_Manager;

/**
 * Admin menu base class.
 */
abstract class WPSEO_Base_Menu implements WPSEO_WordPress_Integration {

        /**
         * A menu.
         *
         * @var WPSEO_Menu
         */
        protected $menu;

        /**
         * Constructs the Admin Menu.
         *
         * @param WPSEO_Menu $menu Menu to use.
         */
        public function __construct( WPSEO_Menu $menu ) {
                $this->menu = $menu;
        }

        /**
         * Returns the list of registered submenu pages.
         *
         * @return array List of registered submenu pages.
         */
        abstract public function get_submenu_pages();

        /**
         * Creates a submenu formatted array.
         *
         * @param string          $page_title Page title to use.
         * @param string          $page_slug  Page slug to use.
         * @param callable|null   $callback   Optional. Callback which handles the page request.
         * @param callable[]|null $hook       Optional. Hook to trigger when the page is registered.
         *
         * @return array Formatted submenu.
         */
        protected function get_submenu_page( $page_title, $page_slug, $callback = null, $hook = null ) {
                if ( $callback === null ) {
                        $callback = $this->get_admin_page_callback();
                }

                return [
                        $this->get_page_identifier(),
                        '',
                        $page_title,
                        $this->get_manage_capability(),
                        $page_slug,
                        $callback,
                        $hook,
                ];
        }

        /**
         * Registers submenu pages as menu pages.
         *
         * This method should only be used if the user does not have the required capabilities
         * to access the parent menu page.
         *
         * @param array $submenu_pages List of submenu pages to register.
         *
         * @return void
         */
        protected function register_menu_pages( $submenu_pages ) {
                if ( ! is_array( $submenu_pages ) || empty( $submenu_pages ) ) {
                        return;
                }

                // Loop through submenu pages and add them.
                array_walk( $submenu_pages, [ $this, 'register_menu_page' ] );
        }

        /**
         * Registers submenu pages.
         *
         * @param array $submenu_pages List of submenu pages to register.
         *
         * @return void
         */
        protected function register_submenu_pages( $submenu_pages ) {
                if ( ! is_array( $submenu_pages ) || empty( $submenu_pages ) ) {
                        return;
                }

                // Loop through submenu pages and add them.
                array_walk( $submenu_pages, [ $this, 'register_submenu_page' ] );
        }

        /**
         * Registers a submenu page as a menu page.
         *
         * This method should only be used if the user does not have the required capabilities
         * to access the parent menu page.
         *
         * @param array $submenu_page {
         *     Submenu page definition.
         *
         *     @type string   $0 Parent menu page slug.
         *     @type string   $1 Page title, currently unused.
         *     @type string   $2 Title to display in the menu.
         *     @type string   $3 Required capability to access the page.
         *     @type string   $4 Page slug.
         *     @type callable $5 Callback to run when the page is rendered.
         *     @type array    $6 Optional. List of callbacks to run when the page is loaded.
         * }
         *
         * @return void
         */
        protected function register_menu_page( $submenu_page ) {

                // If the submenu page requires the general manage capability, it must be added as an actual submenu page.
                if ( $submenu_page[3] === $this->get_manage_capability() ) {
                        return;
                }

                $page_title = 'Yoast SEO: ' . $submenu_page[2];

                // Register submenu page as menu page.
                $hook_suffix = add_menu_page(
                        $page_title,
                        $submenu_page[2],
                        $submenu_page[3],
                        $submenu_page[4],
                        $submenu_page[5],
                        $this->get_icon_svg(),
                        99
                );

                // If necessary, add hooks for the submenu page.
                if ( isset( $submenu_page[6] ) && ( is_array( $submenu_page[6] ) ) ) {
                        $this->add_page_hooks( $hook_suffix, $submenu_page[6] );
                }
        }

        /**
         * Registers a submenu page.
         *
         * This method will override the capability of the page to automatically use the
         * general manage capability. Use the `register_menu_page()` method if the submenu
         * page should actually use a different capability.
         *
         * @param array $submenu_page {
         *     Submenu page definition.
         *
         *     @type string   $0 Parent menu page slug.
         *     @type string   $1 Page title, currently unused.
         *     @type string   $2 Title to display in the menu.
         *     @type string   $3 Required capability to access the page.
         *     @type string   $4 Page slug.
         *     @type callable $5 Callback to run when the page is rendered.
         *     @type array    $6 Optional. List of callbacks to run when the page is loaded.
         * }
         *
         * @return void
         */
        protected function register_submenu_page( $submenu_page ) {
                $page_title = $submenu_page[2];

                // We cannot use $submenu_page[1] because add-ons define that, so hard-code this value.
                if ( $submenu_page[4] === 'wpseo_licenses' ) {
                        $page_title = $this->get_license_page_title();
                }

                /*
                 * Handle the Google Search Console special case by passing a fake parent
                 * page slug. This way, the sub-page is stil registered and can be accessed
                 * directly. Its menu item won't be displayed.
                 */
                if ( $submenu_page[4] === 'wpseo_search_console' ) {
                        // Set the parent page slug to a non-existing one.
                        $submenu_page[0] = 'wpseo_fake_menu_parent_page_slug';
                }

                $page_title .= ' - Yoast SEO';

                // Register submenu page.
                $hook_suffix = add_submenu_page(
                        $submenu_page[0],
                        $page_title,
                        $submenu_page[2],
                        $submenu_page[3],
                        $submenu_page[4],
                        $submenu_page[5]
                );

                // If necessary, add hooks for the submenu page.
                if ( isset( $submenu_page[6] ) && ( is_array( $submenu_page[6] ) ) ) {
                        $this->add_page_hooks( $hook_suffix, $submenu_page[6] );
                }
        }

        /**
         * Adds hook callbacks for a given admin page hook suffix.
         *
         * @param string $hook_suffix Admin page hook suffix, as returned by `add_menu_page()`
         *                            or `add_submenu_page()`.
         * @param array  $callbacks   Callbacks to add.
         *
         * @return void
         */
        protected function add_page_hooks( $hook_suffix, array $callbacks ) {
                foreach ( $callbacks as $callback ) {
                        add_action( 'load-' . $hook_suffix, $callback );
                }
        }

        /**
         * Gets the main admin page identifier.
         *
         * @return string Admin page identifier.
         */
        protected function get_page_identifier() {
                return $this->menu->get_page_identifier();
        }

        /**
         * Checks whether the current user has capabilities to manage all options.
         *
         * @return bool True if capabilities are sufficient, false otherwise.
         */
        protected function check_manage_capability() {
                return WPSEO_Capability_Utils::current_user_can( $this->get_manage_capability() );
        }

        /**
         * Returns the capability that is required to manage all options.
         *
         * @return string Capability to check against.
         */
        abstract protected function get_manage_capability();

        /**
         * Returns the page handler callback.
         *
         * @return array Callback page handler.
         */
        protected function get_admin_page_callback() {
                return [ $this->menu, 'load_page' ];
        }

        /**
         * Returns the page title to use for the licenses page.
         *
         * @return string The title for the license page.
         */
        protected function get_license_page_title() {
                static $title = null;

                if ( $title === null ) {
                        $title = __( 'Upgrades', 'wordpress-seo' );
                }

                if ( YoastSEO()->classes->get( Promotion_Manager::class )->is( 'black-friday-2023-promotion' ) && ! YoastSEO()->helpers->product->is_premium() ) {
                        $title = __( 'Upgrades', 'wordpress-seo' ) . '<span class="yoast-menu-bf-sale-badge">' . __( '30% OFF', 'wordpress-seo' ) . '</span>';
                }

                return $title;
        }

        /**
         * Returns a base64 URL for the svg for use in the menu.
         *
         * @param bool $base64 Whether or not to return base64'd output.
         *
         * @return string SVG icon.
         */
        public function get_icon_svg( $base64 = true ) {
                $svg = '<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="100%" height="100%" style="fill:#82878c" viewBox="0 0 512 512" role="img" aria-hidden="true" focusable="false"><g><g><g><g><path d="M203.6,395c6.8-17.4,6.8-36.6,0-54l-79.4-204h70.9l47.7,149.4l74.8-207.6H116.4c-41.8,0-76,34.2-76,76V357c0,41.8,34.2,76,76,76H173C189,424.1,197.6,410.3,203.6,395z"/></g><g><path d="M471.6,154.8c0-41.8-34.2-76-76-76h-3L285.7,365c-9.6,26.7-19.4,49.3-30.3,68h216.2V154.8z"/></g></g><path stroke-width="2.974" stroke-miterlimit="10" d="M338,1.3l-93.3,259.1l-42.1-131.9h-89.1l83.8,215.2c6,15.5,6,32.5,0,48c-7.4,19-19,37.3-53,41.9l-7.2,1v76h8.3c81.7,0,118.9-57.2,149.6-142.9L431.6,1.3H338z M279.4,362c-32.9,92-67.6,128.7-125.7,131.8v-45c37.5-7.5,51.3-31,59.1-51.1c7.5-19.3,7.5-40.7,0-60l-75-192.7h52.8l53.3,166.8l105.9-294h58.1L279.4,362z"/></g></g></svg>';

                if ( $base64 ) {
                        //phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- This encoding is intended.
                        return 'data:image/svg+xml;base64,' . base64_encode( $svg );
                }

                return $svg;
        }
}

1	<?php
2	/**
3	* WPSEO plugin file.
4	*
5	* @package WPSEO\Admin\Menu
6	*/
7
8	use Yoast\WP\SEO\Promotions\Application\Promotion_Manager;
9
10	/**
11	* Admin menu base class.
12	*/
13	abstract class WPSEO_Base_Menu implements WPSEO_WordPress_Integration {
14
15	/**
16	* A menu.
17	*
18	* @var WPSEO_Menu
19	*/
20	protected $menu;
21
22	/**
23	* Constructs the Admin Menu.
24	*
25	* @param WPSEO_Menu $menu Menu to use.
26	*/
27	public function __construct( WPSEO_Menu $menu ) {	×
28	$this->menu = $menu;	×
29	}
30
31	/**
32	* Returns the list of registered submenu pages.
33	*
34	* @return array List of registered submenu pages.
35	*/
36	abstract public function get_submenu_pages();
37
38	/**
39	* Creates a submenu formatted array.
40	*
41	* @param string $page_title Page title to use.
42	* @param string $page_slug Page slug to use.
43	* @param callable\|null $callback Optional. Callback which handles the page request.
44	* @param callable[]\|null $hook Optional. Hook to trigger when the page is registered.
45	*
46	* @return array Formatted submenu.
47	*/
48	protected function get_submenu_page( $page_title, $page_slug, $callback = null, $hook = null ) {	×
49	if ( $callback === null ) {	×
50	$callback = $this->get_admin_page_callback();	×
51	}
52
53	return [
54	$this->get_page_identifier(),	×
55	'',	×
56	$page_title,	×
57	$this->get_manage_capability(),	×
58	$page_slug,	×
59	$callback,	×
60	$hook,	×
61	];
62	}
63
64	/**
65	* Registers submenu pages as menu pages.
66	*
67	* This method should only be used if the user does not have the required capabilities
68	* to access the parent menu page.
69	*
70	* @param array $submenu_pages List of submenu pages to register.
71	*
72	* @return void
73	*/
74	protected function register_menu_pages( $submenu_pages ) {	×
75	if ( ! is_array( $submenu_pages ) \|\| empty( $submenu_pages ) ) {	×
76	return;	×
77	}
78
79	// Loop through submenu pages and add them.
80	array_walk( $submenu_pages, [ $this, 'register_menu_page' ] );	×
81	}
82
83	/**
84	* Registers submenu pages.
85	*
86	* @param array $submenu_pages List of submenu pages to register.
87	*
88	* @return void
89	*/
90	protected function register_submenu_pages( $submenu_pages ) {	×
91	if ( ! is_array( $submenu_pages ) \|\| empty( $submenu_pages ) ) {	×
92	return;	×
93	}
94
95	// Loop through submenu pages and add them.
96	array_walk( $submenu_pages, [ $this, 'register_submenu_page' ] );	×
97	}
98
99	/**
100	* Registers a submenu page as a menu page.
101	*
102	* This method should only be used if the user does not have the required capabilities
103	* to access the parent menu page.
104	*
105	* @param array $submenu_page {
106	* Submenu page definition.
107	*
108	* @type string $0 Parent menu page slug.
109	* @type string $1 Page title, currently unused.
110	* @type string $2 Title to display in the menu.
111	* @type string $3 Required capability to access the page.
112	* @type string $4 Page slug.
113	* @type callable $5 Callback to run when the page is rendered.
114	* @type array $6 Optional. List of callbacks to run when the page is loaded.
115	* }
116	*
117	* @return void
118	*/
119	protected function register_menu_page( $submenu_page ) {	×
120
121	// If the submenu page requires the general manage capability, it must be added as an actual submenu page.
122	if ( $submenu_page[3] === $this->get_manage_capability() ) {	×
123	return;	×
124	}
125
126	$page_title = 'Yoast SEO: ' . $submenu_page[2];	×
127
128	// Register submenu page as menu page.
129	$hook_suffix = add_menu_page(	×
130	$page_title,	×
131	$submenu_page[2],	×
132	$submenu_page[3],	×
133	$submenu_page[4],	×
134	$submenu_page[5],	×
135	$this->get_icon_svg(),	×
136	99	×
137	);
138
139	// If necessary, add hooks for the submenu page.
140	if ( isset( $submenu_page[6] ) && ( is_array( $submenu_page[6] ) ) ) {	×
141	$this->add_page_hooks( $hook_suffix, $submenu_page[6] );	×
142	}
143	}
144
145	/**
146	* Registers a submenu page.
147	*
148	* This method will override the capability of the page to automatically use the
149	* general manage capability. Use the `register_menu_page()` method if the submenu
150	* page should actually use a different capability.
151	*
152	* @param array $submenu_page {
153	* Submenu page definition.
154	*
155	* @type string $0 Parent menu page slug.
156	* @type string $1 Page title, currently unused.
157	* @type string $2 Title to display in the menu.
158	* @type string $3 Required capability to access the page.
159	* @type string $4 Page slug.
160	* @type callable $5 Callback to run when the page is rendered.
161	* @type array $6 Optional. List of callbacks to run when the page is loaded.
162	* }
163	*
164	* @return void
165	*/
166	protected function register_submenu_page( $submenu_page ) {	×
167	$page_title = $submenu_page[2];	×
168
169	// We cannot use $submenu_page[1] because add-ons define that, so hard-code this value.
170	if ( $submenu_page[4] === 'wpseo_licenses' ) {	×
171	$page_title = $this->get_license_page_title();	×
172	}
173
174	/*
175	* Handle the Google Search Console special case by passing a fake parent
176	* page slug. This way, the sub-page is stil registered and can be accessed
177	* directly. Its menu item won't be displayed.
178	*/
179	if ( $submenu_page[4] === 'wpseo_search_console' ) {	×
180	// Set the parent page slug to a non-existing one.
181	$submenu_page[0] = 'wpseo_fake_menu_parent_page_slug';	×
182	}
183
184	$page_title .= ' - Yoast SEO';	×
185
186	// Register submenu page.
187	$hook_suffix = add_submenu_page(	×
188	$submenu_page[0],	×
189	$page_title,	×
190	$submenu_page[2],	×
191	$submenu_page[3],	×
192	$submenu_page[4],	×
193	$submenu_page[5]	×
194	);
195
196	// If necessary, add hooks for the submenu page.
197	if ( isset( $submenu_page[6] ) && ( is_array( $submenu_page[6] ) ) ) {	×
198	$this->add_page_hooks( $hook_suffix, $submenu_page[6] );	×
199	}
200	}
201
202	/**
203	* Adds hook callbacks for a given admin page hook suffix.
204	*
205	* @param string $hook_suffix Admin page hook suffix, as returned by `add_menu_page()`
206	* or `add_submenu_page()`.
207	* @param array $callbacks Callbacks to add.
208	*
209	* @return void
210	*/
211	protected function add_page_hooks( $hook_suffix, array $callbacks ) {	×
212	foreach ( $callbacks as $callback ) {	×
213	add_action( 'load-' . $hook_suffix, $callback );	×
214	}
215	}
216
217	/**
218	* Gets the main admin page identifier.
219	*
220	* @return string Admin page identifier.
221	*/
222	protected function get_page_identifier() {	×
223	return $this->menu->get_page_identifier();	×
224	}
225
226	/**
227	* Checks whether the current user has capabilities to manage all options.
228	*
229	* @return bool True if capabilities are sufficient, false otherwise.
230	*/
231	protected function check_manage_capability() {	×
232	return WPSEO_Capability_Utils::current_user_can( $this->get_manage_capability() );	×
233	}
234
235	/**
236	* Returns the capability that is required to manage all options.
237	*
238	* @return string Capability to check against.
239	*/
240	abstract protected function get_manage_capability();
241
242	/**
243	* Returns the page handler callback.
244	*
245	* @return array Callback page handler.
246	*/
247	protected function get_admin_page_callback() {	×
248	return [ $this->menu, 'load_page' ];	×
249	}
250
251	/**
252	* Returns the page title to use for the licenses page.
253	*
254	* @return string The title for the license page.
255	*/
256	protected function get_license_page_title() {	×
257	static $title = null;	×
258
259	if ( $title === null ) {	×
NEW 260	$title = __( 'Upgrades', 'wordpress-seo' );	×
261	}
262
263	if ( YoastSEO()->classes->get( Promotion_Manager::class )->is( 'black-friday-2023-promotion' ) && ! YoastSEO()->helpers->product->is_premium() ) {	×
NEW 264	$title = __( 'Upgrades', 'wordpress-seo' ) . '<span class="yoast-menu-bf-sale-badge">' . __( '30% OFF', 'wordpress-seo' ) . '</span>';	×
265	}
266
267	return $title;	×
268	}
269
270	/**
271	* Returns a base64 URL for the svg for use in the menu.
272	*
273	* @param bool $base64 Whether or not to return base64'd output.
274	*
275	* @return string SVG icon.
276	*/
277	public function get_icon_svg( $base64 = true ) {	×
278	$svg = '<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="100%" height="100%" style="fill:#82878c" viewBox="0 0 512 512" role="img" aria-hidden="true" focusable="false"><g><g><g><g><path d="M203.6,395c6.8-17.4,6.8-36.6,0-54l-79.4-204h70.9l47.7,149.4l74.8-207.6H116.4c-41.8,0-76,34.2-76,76V357c0,41.8,34.2,76,76,76H173C189,424.1,197.6,410.3,203.6,395z"/></g><g><path d="M471.6,154.8c0-41.8-34.2-76-76-76h-3L285.7,365c-9.6,26.7-19.4,49.3-30.3,68h216.2V154.8z"/></g></g><path stroke-width="2.974" stroke-miterlimit="10" d="M338,1.3l-93.3,259.1l-42.1-131.9h-89.1l83.8,215.2c6,15.5,6,32.5,0,48c-7.4,19-19,37.3-53,41.9l-7.2,1v76h8.3c81.7,0,118.9-57.2,149.6-142.9L431.6,1.3H338z M279.4,362c-32.9,92-67.6,128.7-125.7,131.8v-45c37.5-7.5,51.3-31,59.1-51.1c7.5-19.3,7.5-40.7,0-60l-75-192.7h52.8l53.3,166.8l105.9-294h58.1L279.4,362z"/></g></g></svg>';	×
279
280	if ( $base64 ) {	×
281	//phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- This encoding is intended.
282	return 'data:image/svg+xml;base64,' . base64_encode( $svg );	×
283	}
284
285	return $svg;	×
286	}
287	}

Yoast / wordpress-seo / d5d0a48b1bb965a14f46d58478ae2aa521f42520

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