<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WPSEO\Admin\Menu

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

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

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Admin menu base class.

[10] Fix | Delete

*/

[11] Fix | Delete

abstract class WPSEO_Base_Menu implements WPSEO_WordPress_Integration {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* A menu.

[15] Fix | Delete

*

[16] Fix | Delete

* @var WPSEO_Menu

[17] Fix | Delete

*/

[18] Fix | Delete

protected $menu;

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Constructs the Admin Menu.

[22] Fix | Delete

*

[23] Fix | Delete

* @param WPSEO_Menu $menu Menu to use.

[24] Fix | Delete

*/

[25] Fix | Delete

public function __construct( WPSEO_Menu $menu ) {

[26] Fix | Delete

$this->menu = $menu;

[27] Fix | Delete

}

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Returns the list of registered submenu pages.

[31] Fix | Delete

*

[32] Fix | Delete

* @return array List of registered submenu pages.

[33] Fix | Delete

*/

[34] Fix | Delete

abstract public function get_submenu_pages();

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Creates a submenu formatted array.

[38] Fix | Delete

*

[39] Fix | Delete

* @param string $page_title Page title to use.

[40] Fix | Delete

* @param string $page_slug Page slug to use.

[41] Fix | Delete

* @param callable|null $callback Optional. Callback which handles the page request.

[42] Fix | Delete

* @param callable[]|null $hook Optional. Hook to trigger when the page is registered.

[43] Fix | Delete

*

[44] Fix | Delete

* @return array Formatted submenu.

[45] Fix | Delete

*/

[46] Fix | Delete

protected function get_submenu_page( $page_title, $page_slug, $callback = null, $hook = null ) {

[47] Fix | Delete

if ( $callback === null ) {

[48] Fix | Delete

$callback = $this->get_admin_page_callback();

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

return [

[52] Fix | Delete

$this->get_page_identifier(),

[53] Fix | Delete

'',

[54] Fix | Delete

$page_title,

[55] Fix | Delete

$this->get_manage_capability(),

[56] Fix | Delete

$page_slug,

[57] Fix | Delete

$callback,

[58] Fix | Delete

$hook,

[59] Fix | Delete

];

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Registers submenu pages as menu pages.

[64] Fix | Delete

*

[65] Fix | Delete

* This method should only be used if the user does not have the required capabilities

[66] Fix | Delete

* to access the parent menu page.

[67] Fix | Delete

*

[68] Fix | Delete

* @param array $submenu_pages List of submenu pages to register.

[69] Fix | Delete

*

[70] Fix | Delete

* @return void

[71] Fix | Delete

*/

[72] Fix | Delete

protected function register_menu_pages( $submenu_pages ) {

[73] Fix | Delete

if ( ! is_array( $submenu_pages ) || empty( $submenu_pages ) ) {

[74] Fix | Delete

return;

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

// Loop through submenu pages and add them.

[78] Fix | Delete

array_walk( $submenu_pages, [ $this, 'register_menu_page' ] );

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Registers submenu pages.

[83] Fix | Delete

*

[84] Fix | Delete

* @param array $submenu_pages List of submenu pages to register.

[85] Fix | Delete

*

[86] Fix | Delete

* @return void

[87] Fix | Delete

*/

[88] Fix | Delete

protected function register_submenu_pages( $submenu_pages ) {

[89] Fix | Delete

if ( ! is_array( $submenu_pages ) || empty( $submenu_pages ) ) {

[90] Fix | Delete

return;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

// Loop through submenu pages and add them.

[94] Fix | Delete

array_walk( $submenu_pages, [ $this, 'register_submenu_page' ] );

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Registers a submenu page as a menu page.

[99] Fix | Delete

*

[100] Fix | Delete

* This method should only be used if the user does not have the required capabilities

[101] Fix | Delete

* to access the parent menu page.

[102] Fix | Delete

*

[103] Fix | Delete

* @param array $submenu_page {

[104] Fix | Delete

* Submenu page definition.

[105] Fix | Delete

*

[106] Fix | Delete

* @type string $0 Parent menu page slug.

[107] Fix | Delete

* @type string $1 Page title, currently unused.

[108] Fix | Delete

* @type string $2 Title to display in the menu.

[109] Fix | Delete

* @type string $3 Required capability to access the page.

[110] Fix | Delete

* @type string $4 Page slug.

[111] Fix | Delete

* @type callable $5 Callback to run when the page is rendered.

[112] Fix | Delete

* @type array $6 Optional. List of callbacks to run when the page is loaded.

[113] Fix | Delete

* }

[114] Fix | Delete

*

[115] Fix | Delete

* @return void

[116] Fix | Delete

*/

[117] Fix | Delete

protected function register_menu_page( $submenu_page ) {

[118] Fix | Delete

[119] Fix | Delete

// If the submenu page requires the general manage capability, it must be added as an actual submenu page.

[120] Fix | Delete

if ( $submenu_page[3] === $this->get_manage_capability() ) {

[121] Fix | Delete

return;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

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

[125] Fix | Delete

[126] Fix | Delete

// Register submenu page as menu page.

[127] Fix | Delete

$hook_suffix = add_menu_page(

[128] Fix | Delete

$page_title,

[129] Fix | Delete

$submenu_page[2],

[130] Fix | Delete

$submenu_page[3],

[131] Fix | Delete

$submenu_page[4],

[132] Fix | Delete

$submenu_page[5],

[133] Fix | Delete

$this->get_icon_svg(),

[134] Fix | Delete

99

[135] Fix | Delete

);

[136] Fix | Delete

[137] Fix | Delete

// If necessary, add hooks for the submenu page.

[138] Fix | Delete

if ( isset( $submenu_page[6] ) && ( is_array( $submenu_page[6] ) ) ) {

[139] Fix | Delete

$this->add_page_hooks( $hook_suffix, $submenu_page[6] );

[140] Fix | Delete

}

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

/**

[144] Fix | Delete

* Registers a submenu page.

[145] Fix | Delete

*

[146] Fix | Delete

* This method will override the capability of the page to automatically use the

[147] Fix | Delete

* general manage capability. Use the `register_menu_page()` method if the submenu

[148] Fix | Delete

* page should actually use a different capability.

[149] Fix | Delete

*

[150] Fix | Delete

* @param array $submenu_page {

[151] Fix | Delete

* Submenu page definition.

[152] Fix | Delete

*

[153] Fix | Delete

* @type string $0 Parent menu page slug.

[154] Fix | Delete

* @type string $1 Page title, currently unused.

[155] Fix | Delete

* @type string $2 Title to display in the menu.

[156] Fix | Delete

* @type string $3 Required capability to access the page.

[157] Fix | Delete

* @type string $4 Page slug.

[158] Fix | Delete

* @type callable $5 Callback to run when the page is rendered.

[159] Fix | Delete

* @type array $6 Optional. List of callbacks to run when the page is loaded.

[160] Fix | Delete

* }

[161] Fix | Delete

*

[162] Fix | Delete

* @return void

[163] Fix | Delete

*/

[164] Fix | Delete

protected function register_submenu_page( $submenu_page ) {

[165] Fix | Delete

$page_title = $submenu_page[2];

[166] Fix | Delete

[167] Fix | Delete

// We cannot use $submenu_page[1] because add-ons define that, so hard-code this value.

[168] Fix | Delete

if ( $submenu_page[4] === 'wpseo_licenses' ) {

[169] Fix | Delete

$page_title = $this->get_license_page_title();

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

/*

[173] Fix | Delete

* Handle the Google Search Console special case by passing a fake parent

[174] Fix | Delete

* page slug. This way, the sub-page is stil registered and can be accessed

[175] Fix | Delete

* directly. Its menu item won't be displayed.

[176] Fix | Delete

*/

[177] Fix | Delete

if ( $submenu_page[4] === 'wpseo_search_console' ) {

[178] Fix | Delete

// Set the parent page slug to a non-existing one.

[179] Fix | Delete

$submenu_page[0] = 'wpseo_fake_menu_parent_page_slug';

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

$page_title .= ' - Yoast SEO';

[183] Fix | Delete

[184] Fix | Delete

// Register submenu page.

[185] Fix | Delete

$hook_suffix = add_submenu_page(

[186] Fix | Delete

$submenu_page[0],

[187] Fix | Delete

$page_title,

[188] Fix | Delete

$submenu_page[2],

[189] Fix | Delete

$submenu_page[3],

[190] Fix | Delete

$submenu_page[4],

[191] Fix | Delete

$submenu_page[5]

[192] Fix | Delete

);

[193] Fix | Delete

[194] Fix | Delete

// If necessary, add hooks for the submenu page.

[195] Fix | Delete

if ( isset( $submenu_page[6] ) && ( is_array( $submenu_page[6] ) ) ) {

[196] Fix | Delete

$this->add_page_hooks( $hook_suffix, $submenu_page[6] );

[197] Fix | Delete

}

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

/**

[201] Fix | Delete

* Adds hook callbacks for a given admin page hook suffix.

[202] Fix | Delete

*

[203] Fix | Delete

* @param string $hook_suffix Admin page hook suffix, as returned by `add_menu_page()`

[204] Fix | Delete

* or `add_submenu_page()`.

[205] Fix | Delete

* @param array $callbacks Callbacks to add.

[206] Fix | Delete

*

[207] Fix | Delete

* @return void

[208] Fix | Delete

*/

[209] Fix | Delete

protected function add_page_hooks( $hook_suffix, array $callbacks ) {

[210] Fix | Delete

foreach ( $callbacks as $callback ) {

[211] Fix | Delete

add_action( 'load-' . $hook_suffix, $callback );

[212] Fix | Delete

}

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

/**

[216] Fix | Delete

* Gets the main admin page identifier.

[217] Fix | Delete

*

[218] Fix | Delete

* @return string Admin page identifier.

[219] Fix | Delete

*/

[220] Fix | Delete

protected function get_page_identifier() {

[221] Fix | Delete

return $this->menu->get_page_identifier();

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

/**

[225] Fix | Delete

* Checks whether the current user has capabilities to manage all options.

[226] Fix | Delete

*

[227] Fix | Delete

* @return bool True if capabilities are sufficient, false otherwise.

[228] Fix | Delete

*/

[229] Fix | Delete

protected function check_manage_capability() {

[230] Fix | Delete

return WPSEO_Capability_Utils::current_user_can( $this->get_manage_capability() );

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Returns the capability that is required to manage all options.

[235] Fix | Delete

*

[236] Fix | Delete

* @return string Capability to check against.

[237] Fix | Delete

*/

[238] Fix | Delete

abstract protected function get_manage_capability();

[239] Fix | Delete

[240] Fix | Delete

/**

[241] Fix | Delete

* Returns the page handler callback.

[242] Fix | Delete

*

[243] Fix | Delete

* @return array Callback page handler.

[244] Fix | Delete

*/

[245] Fix | Delete

protected function get_admin_page_callback() {

[246] Fix | Delete

return [ $this->menu, 'load_page' ];

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

/**

[250] Fix | Delete

* Returns the page title to use for the licenses page.

[251] Fix | Delete

*

[252] Fix | Delete

* @return string The title for the license page.

[253] Fix | Delete

*/

[254] Fix | Delete

protected function get_license_page_title() {

[255] Fix | Delete

static $title = null;

[256] Fix | Delete

[257] Fix | Delete

if ( $title === null ) {

[258] Fix | Delete

$title = __( 'Upgrades', 'wordpress-seo' );

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

if ( YoastSEO()->classes->get( Promotion_Manager::class )->is( 'black-friday-2023-promotion' ) && ! YoastSEO()->helpers->product->is_premium() ) {

[262] Fix | Delete

$title = __( 'Upgrades', 'wordpress-seo' ) . '<span class="yoast-menu-bf-sale-badge">' . __( '30% OFF', 'wordpress-seo' ) . '</span>';

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

return $title;

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

/**

[269] Fix | Delete

* Returns a base64 URL for the svg for use in the menu.

[270] Fix | Delete

*

[271] Fix | Delete

* @param bool $base64 Whether or not to return base64'd output.

[272] Fix | Delete

*

[273] Fix | Delete

* @return string SVG icon.

[274] Fix | Delete

*/

[275] Fix | Delete

public function get_icon_svg( $base64 = true ) {

[276] Fix | Delete

$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>';

[277] Fix | Delete

[278] Fix | Delete

if ( $base64 ) {

[279] Fix | Delete

//phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- This encoding is intended.

[280] Fix | Delete

return 'data:image/svg+xml;base64,' . base64_encode( $svg );

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

return $svg;

[284] Fix | Delete

}

[285] Fix | Delete

}

[286] Fix | Delete

[287] Fix | Delete