5066322038

Build # 5066322038

Build Type

push

github

Committed by GitHub

Commit Message

Merge pull request #20316 from Yoast/JRF/ghactions-run-more-selectively

Run Details

2550 of 29012 relevant lines covered (8.79%)

0.32 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
 */

/**
 * 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 = __( 'Premium', 'wordpress-seo' );
                }

                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	/**
9	* Admin menu base class.
10	*/
11	abstract class WPSEO_Base_Menu implements WPSEO_WordPress_Integration {
12
13	/**
14	* A menu.
15	*
16	* @var WPSEO_Menu
17	*/
18	protected $menu;
19
20	/**
21	* Constructs the Admin Menu.
22	*
23	* @param WPSEO_Menu $menu Menu to use.
24	*/
25	public function __construct( WPSEO_Menu $menu ) {
26	$this->menu = $menu;	×
27	}
28
29	/**
30	* Returns the list of registered submenu pages.
31	*
32	* @return array List of registered submenu pages.
33	*/
34	abstract public function get_submenu_pages();
35
36	/**
37	* Creates a submenu formatted array.
38	*
39	* @param string $page_title Page title to use.
40	* @param string $page_slug Page slug to use.
41	* @param callable\|null $callback Optional. Callback which handles the page request.
42	* @param callable[]\|null $hook Optional. Hook to trigger when the page is registered.
43	*
44	* @return array Formatted submenu.
45	*/
46	protected function get_submenu_page( $page_title, $page_slug, $callback = null, $hook = null ) {
47	if ( $callback === null ) {	×
48	$callback = $this->get_admin_page_callback();	×
49	}
50
51	return [	×
52	$this->get_page_identifier(),	×
53	'',	×
54	$page_title,	×
55	$this->get_manage_capability(),	×
56	$page_slug,	×
57	$callback,	×
58	$hook,	×
59	];	×
60	}
61
62	/**
63	* Registers submenu pages as menu pages.
64	*
65	* This method should only be used if the user does not have the required capabilities
66	* to access the parent menu page.
67	*
68	* @param array $submenu_pages List of submenu pages to register.
69	*
70	* @return void
71	*/
72	protected function register_menu_pages( $submenu_pages ) {
73	if ( ! is_array( $submenu_pages ) \|\| empty( $submenu_pages ) ) {	×
74	return;	×
75	}
76
77	// Loop through submenu pages and add them.
78	array_walk( $submenu_pages, [ $this, 'register_menu_page' ] );	×
79	}
80
81	/**
82	* Registers submenu pages.
83	*
84	* @param array $submenu_pages List of submenu pages to register.
85	*
86	* @return void
87	*/
88	protected function register_submenu_pages( $submenu_pages ) {
89	if ( ! is_array( $submenu_pages ) \|\| empty( $submenu_pages ) ) {	×
90	return;	×
91	}
92
93	// Loop through submenu pages and add them.
94	array_walk( $submenu_pages, [ $this, 'register_submenu_page' ] );	×
95	}
96
97	/**
98	* Registers a submenu page as a menu page.
99	*
100	* This method should only be used if the user does not have the required capabilities
101	* to access the parent menu page.
102	*
103	* @param array $submenu_page {
104	* Submenu page definition.
105	*
106	* @type string $0 Parent menu page slug.
107	* @type string $1 Page title, currently unused.
108	* @type string $2 Title to display in the menu.
109	* @type string $3 Required capability to access the page.
110	* @type string $4 Page slug.
111	* @type callable $5 Callback to run when the page is rendered.
112	* @type array $6 Optional. List of callbacks to run when the page is loaded.
113	* }
114	*
115	* @return void
116	*/
117	protected function register_menu_page( $submenu_page ) {
118
119	// If the submenu page requires the general manage capability, it must be added as an actual submenu page.
120	if ( $submenu_page[3] === $this->get_manage_capability() ) {	×
121	return;	×
122	}
123
124	$page_title = 'Yoast SEO: ' . $submenu_page[2];	×
125
126	// Register submenu page as menu page.
127	$hook_suffix = add_menu_page(	×
128	$page_title,	×
129	$submenu_page[2],	×
130	$submenu_page[3],	×
131	$submenu_page[4],	×
132	$submenu_page[5],	×
133	$this->get_icon_svg(),	×
134	99	×
135	);	×
136
137	// If necessary, add hooks for the submenu page.
138	if ( isset( $submenu_page[6] ) && ( is_array( $submenu_page[6] ) ) ) {	×
139	$this->add_page_hooks( $hook_suffix, $submenu_page[6] );	×
140	}
141	}
142
143	/**
144	* Registers a submenu page.
145	*
146	* This method will override the capability of the page to automatically use the
147	* general manage capability. Use the `register_menu_page()` method if the submenu
148	* page should actually use a different capability.
149	*
150	* @param array $submenu_page {
151	* Submenu page definition.
152	*
153	* @type string $0 Parent menu page slug.
154	* @type string $1 Page title, currently unused.
155	* @type string $2 Title to display in the menu.
156	* @type string $3 Required capability to access the page.
157	* @type string $4 Page slug.
158	* @type callable $5 Callback to run when the page is rendered.
159	* @type array $6 Optional. List of callbacks to run when the page is loaded.
160	* }
161	*
162	* @return void
163	*/
164	protected function register_submenu_page( $submenu_page ) {
165	$page_title = $submenu_page[2];	×
166
167	// We cannot use $submenu_page[1] because add-ons define that, so hard-code this value.
168	if ( $submenu_page[4] === 'wpseo_licenses' ) {	×
169	$page_title = $this->get_license_page_title();	×
170	}
171
172	/*
173	* Handle the Google Search Console special case by passing a fake parent
174	* page slug. This way, the sub-page is stil registered and can be accessed
175	* directly. Its menu item won't be displayed.
176	*/
177	if ( $submenu_page[4] === 'wpseo_search_console' ) {	×
178	// Set the parent page slug to a non-existing one.
179	$submenu_page[0] = 'wpseo_fake_menu_parent_page_slug';	×
180	}
181
182	$page_title .= ' - Yoast SEO';	×
183
184	// Register submenu page.
185	$hook_suffix = add_submenu_page(	×
186	$submenu_page[0],	×
187	$page_title,	×
188	$submenu_page[2],	×
189	$submenu_page[3],	×
190	$submenu_page[4],	×
191	$submenu_page[5]	×
192	);	×
193
194	// If necessary, add hooks for the submenu page.
195	if ( isset( $submenu_page[6] ) && ( is_array( $submenu_page[6] ) ) ) {	×
196	$this->add_page_hooks( $hook_suffix, $submenu_page[6] );	×
197	}
198	}
199
200	/**
201	* Adds hook callbacks for a given admin page hook suffix.
202	*
203	* @param string $hook_suffix Admin page hook suffix, as returned by `add_menu_page()`
204	* or `add_submenu_page()`.
205	* @param array $callbacks Callbacks to add.
206	*
207	* @return void
208	*/
209	protected function add_page_hooks( $hook_suffix, array $callbacks ) {
210	foreach ( $callbacks as $callback ) {	×
211	add_action( 'load-' . $hook_suffix, $callback );	×
212	}
213	}
214
215	/**
216	* Gets the main admin page identifier.
217	*
218	* @return string Admin page identifier.
219	*/
220	protected function get_page_identifier() {
221	return $this->menu->get_page_identifier();	×
222	}
223
224	/**
225	* Checks whether the current user has capabilities to manage all options.
226	*
227	* @return bool True if capabilities are sufficient, false otherwise.
228	*/
229	protected function check_manage_capability() {
230	return WPSEO_Capability_Utils::current_user_can( $this->get_manage_capability() );	×
231	}
232
233	/**
234	* Returns the capability that is required to manage all options.
235	*
236	* @return string Capability to check against.
237	*/
238	abstract protected function get_manage_capability();
239
240	/**
241	* Returns the page handler callback.
242	*
243	* @return array Callback page handler.
244	*/
245	protected function get_admin_page_callback() {
246	return [ $this->menu, 'load_page' ];	×
247	}
248
249	/**
250	* Returns the page title to use for the licenses page.
251	*
252	* @return string The title for the license page.
253	*/
254	protected function get_license_page_title() {
255	static $title = null;	×
256
257	if ( $title === null ) {	×
258	$title = __( 'Premium', 'wordpress-seo' );	×
259	}
260
261	return $title;	×
262	}
263
264	/**
265	* Returns a base64 URL for the svg for use in the menu.
266	*
267	* @param bool $base64 Whether or not to return base64'd output.
268	*
269	* @return string SVG icon.
270	*/
271	public function get_icon_svg( $base64 = true ) {
272	$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>';	×
273
274	if ( $base64 ) {	×
275	//phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- This encoding is intended.
276	return 'data:image/svg+xml;base64,' . base64_encode( $svg );	×
277	}
278
279	return $svg;	×
280	}
281	}

Yoast / wordpress-seo / 5066322038

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