first
This commit is contained in:
133
wp-content/plugins/wordpress-seo/admin/menu/class-admin-menu.php
Normal file
133
wp-content/plugins/wordpress-seo/admin/menu/class-admin-menu.php
Normal file
@ -0,0 +1,133 @@
|
||||
<?php
|
||||
/**
|
||||
* WPSEO plugin file.
|
||||
*
|
||||
* @package WPSEO\Admin\Menu
|
||||
*/
|
||||
|
||||
/**
|
||||
* Registers the admin menu on the left of the admin area.
|
||||
*/
|
||||
class WPSEO_Admin_Menu extends WPSEO_Base_Menu {
|
||||
|
||||
/**
|
||||
* Registers all hooks to WordPress.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register_hooks() {
|
||||
// Needs the lower than default priority so other plugins can hook underneath it without issue.
|
||||
add_action( 'admin_menu', [ $this, 'register_settings_page' ], 5 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers the menu item submenus.
|
||||
*/
|
||||
public function register_settings_page() {
|
||||
$manage_capability = $this->get_manage_capability();
|
||||
$page_identifier = $this->get_page_identifier();
|
||||
$admin_page_callback = $this->get_admin_page_callback();
|
||||
|
||||
// Get all submenu pages.
|
||||
$submenu_pages = $this->get_submenu_pages();
|
||||
|
||||
foreach ( $submenu_pages as $submenu_page ) {
|
||||
if ( WPSEO_Capability_Utils::current_user_can( $submenu_page[3] ) ) {
|
||||
$manage_capability = $submenu_page[3];
|
||||
$page_identifier = $submenu_page[4];
|
||||
$admin_page_callback = $submenu_page[5];
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
foreach ( $submenu_pages as $index => $submenu_page ) {
|
||||
$submenu_pages[ $index ][0] = $page_identifier;
|
||||
}
|
||||
|
||||
/*
|
||||
* The current user has the capability to control anything.
|
||||
* This means that all submenus and dashboard can be shown.
|
||||
*/
|
||||
global $admin_page_hooks;
|
||||
|
||||
add_menu_page(
|
||||
'Yoast SEO: ' . __( 'Dashboard', 'wordpress-seo' ),
|
||||
'Yoast SEO ' . $this->get_notification_counter(),
|
||||
$manage_capability,
|
||||
$page_identifier,
|
||||
$admin_page_callback,
|
||||
$this->get_icon_svg(),
|
||||
99
|
||||
);
|
||||
|
||||
// Wipe notification bits from hooks.
|
||||
// phpcs:ignore WordPress.WP.GlobalVariablesOverride -- This is a deliberate action.
|
||||
$admin_page_hooks[ $page_identifier ] = 'seo';
|
||||
|
||||
// Add submenu items to the main menu if possible.
|
||||
$this->register_submenu_pages( $submenu_pages );
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the list of registered submenu pages.
|
||||
*
|
||||
* @return array List of registered submenu pages.
|
||||
*/
|
||||
public function get_submenu_pages() {
|
||||
global $wpseo_admin;
|
||||
|
||||
$search_console_callback = null;
|
||||
|
||||
// Account for when the available submenu pages are requested from outside the admin.
|
||||
if ( isset( $wpseo_admin ) ) {
|
||||
$google_search_console = new WPSEO_GSC();
|
||||
$search_console_callback = [ $google_search_console, 'display' ];
|
||||
}
|
||||
|
||||
// Submenu pages.
|
||||
$submenu_pages = [
|
||||
$this->get_submenu_page( __( 'General', 'wordpress-seo' ), $this->get_page_identifier() ),
|
||||
$this->get_submenu_page(
|
||||
__( 'Search Console', 'wordpress-seo' ),
|
||||
'wpseo_search_console',
|
||||
$search_console_callback
|
||||
),
|
||||
$this->get_submenu_page( __( 'Tools', 'wordpress-seo' ), 'wpseo_tools' ),
|
||||
$this->get_submenu_page( $this->get_license_page_title(), 'wpseo_licenses' ),
|
||||
];
|
||||
|
||||
/**
|
||||
* Filter: 'wpseo_submenu_pages' - Collects all submenus that need to be shown.
|
||||
*
|
||||
* @api array $submenu_pages List with all submenu pages.
|
||||
*/
|
||||
return (array) apply_filters( 'wpseo_submenu_pages', $submenu_pages );
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the notification count in HTML format.
|
||||
*
|
||||
* @return string The notification count in HTML format.
|
||||
*/
|
||||
protected function get_notification_counter() {
|
||||
$notification_center = Yoast_Notification_Center::get();
|
||||
$notification_count = $notification_center->get_notification_count();
|
||||
|
||||
// Add main page.
|
||||
/* translators: %s: number of notifications */
|
||||
$notifications = sprintf( _n( '%s notification', '%s notifications', $notification_count, 'wordpress-seo' ), number_format_i18n( $notification_count ) );
|
||||
|
||||
$counter = sprintf( '<span class="update-plugins count-%1$d"><span class="plugin-count" aria-hidden="true">%1$d</span><span class="screen-reader-text">%2$s</span></span>', $notification_count, $notifications );
|
||||
|
||||
return $counter;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the capability that is required to manage all options.
|
||||
*
|
||||
* @return string Capability to check against.
|
||||
*/
|
||||
protected function get_manage_capability() {
|
||||
return 'wpseo_manage_options';
|
||||
}
|
||||
}
|
281
wp-content/plugins/wordpress-seo/admin/menu/class-base-menu.php
Normal file
281
wp-content/plugins/wordpress-seo/admin/menu/class-base-menu.php
Normal file
@ -0,0 +1,281 @@
|
||||
<?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;
|
||||
}
|
||||
}
|
96
wp-content/plugins/wordpress-seo/admin/menu/class-menu.php
Normal file
96
wp-content/plugins/wordpress-seo/admin/menu/class-menu.php
Normal file
@ -0,0 +1,96 @@
|
||||
<?php
|
||||
/**
|
||||
* WPSEO plugin file.
|
||||
*
|
||||
* @package WPSEO\Admin\Menu
|
||||
*/
|
||||
|
||||
/**
|
||||
* Registers the regular admin menu and network admin menu implementations.
|
||||
*/
|
||||
class WPSEO_Menu implements WPSEO_WordPress_Integration {
|
||||
|
||||
/**
|
||||
* The page identifier used in WordPress to register the admin page.
|
||||
*
|
||||
* !DO NOT CHANGE THIS!
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
const PAGE_IDENTIFIER = 'wpseo_dashboard';
|
||||
|
||||
/**
|
||||
* List of classes that add admin functionality.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $admin_features;
|
||||
|
||||
/**
|
||||
* Registers all hooks to WordPress.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register_hooks() {
|
||||
$admin_menu = new WPSEO_Admin_Menu( $this );
|
||||
$admin_menu->register_hooks();
|
||||
|
||||
if ( WPSEO_Utils::is_plugin_network_active() ) {
|
||||
$network_admin_menu = new WPSEO_Network_Admin_Menu( $this );
|
||||
$network_admin_menu->register_hooks();
|
||||
}
|
||||
|
||||
$capability_normalizer = new WPSEO_Submenu_Capability_Normalize();
|
||||
$capability_normalizer->register_hooks();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the main menu page identifier.
|
||||
*
|
||||
* @return string Page identifier to use.
|
||||
*/
|
||||
public function get_page_identifier() {
|
||||
return self::PAGE_IDENTIFIER;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the requested admin settings page.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function load_page() {
|
||||
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
|
||||
if ( isset( $_GET['page'] ) && is_string( $_GET['page'] ) ) {
|
||||
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
|
||||
$page = sanitize_text_field( wp_unslash( $_GET['page'] ) );
|
||||
$this->show_page( $page );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows an admin settings page.
|
||||
*
|
||||
* @param string $page Page to display.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function show_page( $page ) {
|
||||
switch ( $page ) {
|
||||
case 'wpseo_tools':
|
||||
require_once WPSEO_PATH . 'admin/pages/tools.php';
|
||||
break;
|
||||
|
||||
case 'wpseo_licenses':
|
||||
require_once WPSEO_PATH . 'admin/pages/licenses.php';
|
||||
break;
|
||||
|
||||
case 'wpseo_files':
|
||||
require_once WPSEO_PATH . 'admin/views/tool-file-editor.php';
|
||||
break;
|
||||
|
||||
default:
|
||||
require_once WPSEO_PATH . 'admin/pages/dashboard.php';
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
@ -0,0 +1,97 @@
|
||||
<?php
|
||||
/**
|
||||
* WPSEO plugin file.
|
||||
*
|
||||
* @package WPSEO\Admin\Menu
|
||||
*/
|
||||
|
||||
/**
|
||||
* Network Admin Menu handler.
|
||||
*/
|
||||
class WPSEO_Network_Admin_Menu extends WPSEO_Base_Menu {
|
||||
|
||||
/**
|
||||
* Registers all hooks to WordPress.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register_hooks() {
|
||||
// Needs the lower than default priority so other plugins can hook underneath it without issue.
|
||||
add_action( 'network_admin_menu', [ $this, 'register_settings_page' ], 5 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register the settings page for the Network settings.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register_settings_page() {
|
||||
if ( ! $this->check_manage_capability() ) {
|
||||
return;
|
||||
}
|
||||
|
||||
add_menu_page(
|
||||
__( 'Network Settings', 'wordpress-seo' ) . ' - Yoast SEO',
|
||||
'Yoast SEO',
|
||||
$this->get_manage_capability(),
|
||||
$this->get_page_identifier(),
|
||||
[ $this, 'network_config_page' ],
|
||||
$this->get_icon_svg()
|
||||
);
|
||||
|
||||
$submenu_pages = $this->get_submenu_pages();
|
||||
$this->register_submenu_pages( $submenu_pages );
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the list of registered submenu pages.
|
||||
*
|
||||
* @return array List of registered submenu pages.
|
||||
*/
|
||||
public function get_submenu_pages() {
|
||||
|
||||
// Submenu pages.
|
||||
$submenu_pages = [
|
||||
$this->get_submenu_page(
|
||||
__( 'General', 'wordpress-seo' ),
|
||||
$this->get_page_identifier(),
|
||||
[ $this, 'network_config_page' ]
|
||||
),
|
||||
];
|
||||
|
||||
if ( WPSEO_Utils::allow_system_file_edit() === true ) {
|
||||
$submenu_pages[] = $this->get_submenu_page( __( 'Edit Files', 'wordpress-seo' ), 'wpseo_files' );
|
||||
}
|
||||
|
||||
$submenu_pages[] = $this->get_submenu_page( __( 'Extensions', 'wordpress-seo' ), 'wpseo_licenses' );
|
||||
|
||||
return $submenu_pages;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the form for the network configuration page.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function network_config_page() {
|
||||
require_once WPSEO_PATH . 'admin/pages/network.php';
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 current_user_can( $this->get_manage_capability() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the capability that is required to manage all options.
|
||||
*
|
||||
* @return string Capability to check against.
|
||||
*/
|
||||
protected function get_manage_capability() {
|
||||
return 'wpseo_manage_network_options';
|
||||
}
|
||||
}
|
@ -0,0 +1,157 @@
|
||||
<?php
|
||||
/**
|
||||
* WPSEO plugin file.
|
||||
*
|
||||
* @package WPSEO\Admin\Menu
|
||||
*/
|
||||
|
||||
/**
|
||||
* Renders a replacement variable editor.
|
||||
*/
|
||||
class WPSEO_Replacevar_Editor {
|
||||
|
||||
/**
|
||||
* Yoast Forms instance.
|
||||
*
|
||||
* @var Yoast_Form
|
||||
*/
|
||||
private $yform;
|
||||
|
||||
/**
|
||||
* The arguments required for the div to render.
|
||||
*
|
||||
* @var array {
|
||||
* @type string $title The title field id.
|
||||
* @type string $description The description field id.
|
||||
* @type string $page_type_recommended The page type for the context of the recommended replace vars.
|
||||
* @type string $page_type_specific The page type for the context of the editor specific replace vars.
|
||||
* @type bool $paper_style Optional. Whether the editor has paper style.
|
||||
* @type string $label_title Optional. The label to use for the title field.
|
||||
* @type string $label_description Optional. The label to use for the description field.
|
||||
* @type string $description_placeholder Optional. The placeholder text to use for the description field.
|
||||
* @type bool $has_new_badge Optional. Whether to show the "New" badge.
|
||||
* @type bool $has_premium_badge Optional. Whether to show the "Premium" badge.
|
||||
* }
|
||||
*/
|
||||
private $arguments;
|
||||
|
||||
/**
|
||||
* Constructs the object.
|
||||
*
|
||||
* @param Yoast_Form $yform Yoast forms.
|
||||
* @param array $arguments {
|
||||
* The arguments that can be given.
|
||||
*
|
||||
* @type string $title The title field id.
|
||||
* @type string $description The description field id.
|
||||
* @type string $page_type_recommended The page type for the context of the recommended replace vars.
|
||||
* @type string $page_type_specific The page type for the context of the editor specific replace vars.
|
||||
* @type bool $paper_style Optional. Whether the editor has paper style.
|
||||
* @type string $label_title Optional. The label to use for the title field.
|
||||
* @type string $label_description Optional. The label to use for the description field.
|
||||
* @type string $description_placeholder Optional. The placeholder text to use for the description field.
|
||||
* @type bool $has_new_badge Optional. Whether to show the "New" badge.
|
||||
* @type bool $has_premium_badge Optional. Whether to show the "Premium" badge.
|
||||
* }
|
||||
*/
|
||||
public function __construct( Yoast_Form $yform, $arguments ) {
|
||||
$arguments = wp_parse_args(
|
||||
$arguments,
|
||||
[
|
||||
'paper_style' => true,
|
||||
'label_title' => '',
|
||||
'label_description' => '',
|
||||
'description_placeholder' => '',
|
||||
'has_new_badge' => false,
|
||||
'is_disabled' => false,
|
||||
'has_premium_badge' => false,
|
||||
]
|
||||
);
|
||||
|
||||
$this->validate_arguments( $arguments );
|
||||
|
||||
$this->yform = $yform;
|
||||
$this->arguments = [
|
||||
'title' => (string) $arguments['title'],
|
||||
'description' => (string) $arguments['description'],
|
||||
'page_type_recommended' => (string) $arguments['page_type_recommended'],
|
||||
'page_type_specific' => (string) $arguments['page_type_specific'],
|
||||
'paper_style' => (bool) $arguments['paper_style'],
|
||||
'label_title' => (string) $arguments['label_title'],
|
||||
'label_description' => (string) $arguments['label_description'],
|
||||
'description_placeholder' => (string) $arguments['description_placeholder'],
|
||||
'has_new_badge' => (bool) $arguments['has_new_badge'],
|
||||
'is_disabled' => (bool) $arguments['is_disabled'],
|
||||
'has_premium_badge' => (bool) $arguments['has_premium_badge'],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Renders a div for the react application to mount to, and hidden inputs where
|
||||
* the app should store it's value so they will be properly saved when the form
|
||||
* is submitted.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function render() {
|
||||
$this->yform->hidden( $this->arguments['title'], $this->arguments['title'] );
|
||||
$this->yform->hidden( $this->arguments['description'], $this->arguments['description'] );
|
||||
|
||||
printf(
|
||||
'<div
|
||||
data-react-replacevar-editor
|
||||
data-react-replacevar-title-field-id="%1$s"
|
||||
data-react-replacevar-metadesc-field-id="%2$s"
|
||||
data-react-replacevar-page-type-recommended="%3$s"
|
||||
data-react-replacevar-page-type-specific="%4$s"
|
||||
data-react-replacevar-paper-style="%5$s"
|
||||
data-react-replacevar-label-title="%6$s"
|
||||
data-react-replacevar-label-description="%7$s"
|
||||
data-react-replacevar-description-placeholder="%8$s"
|
||||
data-react-replacevar-has-new-badge="%9$s"
|
||||
data-react-replacevar-is-disabled="%10$s"
|
||||
data-react-replacevar-has-premium-badge="%11$s"
|
||||
></div>',
|
||||
esc_attr( $this->arguments['title'] ),
|
||||
esc_attr( $this->arguments['description'] ),
|
||||
esc_attr( $this->arguments['page_type_recommended'] ),
|
||||
esc_attr( $this->arguments['page_type_specific'] ),
|
||||
esc_attr( $this->arguments['paper_style'] ),
|
||||
esc_attr( $this->arguments['label_title'] ),
|
||||
esc_attr( $this->arguments['label_description'] ),
|
||||
esc_attr( $this->arguments['description_placeholder'] ),
|
||||
esc_attr( $this->arguments['has_new_badge'] ),
|
||||
esc_attr( $this->arguments['is_disabled'] ),
|
||||
esc_attr( $this->arguments['has_premium_badge'] )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the replacement variable editor arguments.
|
||||
*
|
||||
* @param array $arguments The arguments to validate.
|
||||
*
|
||||
* @throws InvalidArgumentException Thrown when not all required arguments are present.
|
||||
*/
|
||||
protected function validate_arguments( array $arguments ) {
|
||||
$required_arguments = [
|
||||
'title',
|
||||
'description',
|
||||
'page_type_recommended',
|
||||
'page_type_specific',
|
||||
'paper_style',
|
||||
];
|
||||
|
||||
foreach ( $required_arguments as $field_name ) {
|
||||
if ( ! array_key_exists( $field_name, $arguments ) ) {
|
||||
throw new InvalidArgumentException(
|
||||
sprintf(
|
||||
/* translators: %1$s expands to the missing field name. */
|
||||
__( 'Not all required fields are given. Missing field %1$s', 'wordpress-seo' ),
|
||||
$field_name
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
@ -0,0 +1,88 @@
|
||||
<?php
|
||||
/**
|
||||
* WPSEO plugin file.
|
||||
*
|
||||
* @package WPSEO\Admin\Menu
|
||||
*/
|
||||
|
||||
/**
|
||||
* Renders a single replacement variable field.
|
||||
*/
|
||||
class WPSEO_Replacevar_Field {
|
||||
|
||||
/**
|
||||
* Forms instance.
|
||||
*
|
||||
* @var Yoast_Form Yoast
|
||||
*/
|
||||
private $yform;
|
||||
|
||||
/**
|
||||
* The id for the hidden field.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $field_id;
|
||||
|
||||
/**
|
||||
* The label for the field.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $label;
|
||||
|
||||
/**
|
||||
* The page type for the context of the recommended replace vars.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $page_type_recommended;
|
||||
|
||||
/**
|
||||
* The page type for the context of the editor specific replace vars.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $page_type_specific;
|
||||
|
||||
/**
|
||||
* Constructs the object.
|
||||
*
|
||||
* @param Yoast_Form $yform Yoast forms.
|
||||
* @param string $field_id The field id.
|
||||
* @param string $label The field label.
|
||||
* @param string $page_type_recommended The page type for the context of the recommended replace vars.
|
||||
* @param string $page_type_specific The page type for the context of the editor specific replace vars.
|
||||
*/
|
||||
public function __construct( Yoast_Form $yform, $field_id, $label, $page_type_recommended, $page_type_specific ) {
|
||||
$this->yform = $yform;
|
||||
$this->field_id = $field_id;
|
||||
$this->label = $label;
|
||||
$this->page_type_recommended = $page_type_recommended;
|
||||
$this->page_type_specific = $page_type_specific;
|
||||
}
|
||||
|
||||
/**
|
||||
* Renders a div for the react application to mount to, and hidden inputs where
|
||||
* the app should store it's value so they will be properly saved when the form
|
||||
* is submitted.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function render() {
|
||||
$this->yform->hidden( $this->field_id, $this->field_id );
|
||||
|
||||
printf(
|
||||
'<div
|
||||
data-react-replacevar-field
|
||||
data-react-replacevar-field-id="%1$s"
|
||||
data-react-replacevar-field-label="%2$s"
|
||||
data-react-replacevar-page-type-recommended="%3$s"
|
||||
data-react-replacevar-page-type-specific="%4$s"></div>',
|
||||
esc_attr( $this->field_id ),
|
||||
esc_attr( $this->label ),
|
||||
esc_attr( $this->page_type_recommended ),
|
||||
esc_attr( $this->page_type_specific )
|
||||
);
|
||||
}
|
||||
}
|
@ -0,0 +1,41 @@
|
||||
<?php
|
||||
/**
|
||||
* WPSEO plugin file.
|
||||
*
|
||||
* @package WPSEO\Admin\Menu
|
||||
*/
|
||||
|
||||
/**
|
||||
* Normalize submenu capabilities to `wpseo_manage_options`.
|
||||
*/
|
||||
class WPSEO_Submenu_Capability_Normalize implements WPSEO_WordPress_Integration {
|
||||
|
||||
/**
|
||||
* Registers all hooks to WordPress.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register_hooks() {
|
||||
add_filter( 'wpseo_submenu_pages', [ $this, 'normalize_submenus_capability' ] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalizes any `manage_options` to `wpseo_manage_options`.
|
||||
*
|
||||
* This is needed as the module plugins are not updated with the new capabilities directly,
|
||||
* but they should not be shown as main menu items.
|
||||
*
|
||||
* @param array $submenu_pages List of subpages to convert.
|
||||
*
|
||||
* @return array Converted subpages.
|
||||
*/
|
||||
public function normalize_submenus_capability( $submenu_pages ) {
|
||||
foreach ( $submenu_pages as $index => $submenu_page ) {
|
||||
if ( $submenu_page[3] === 'manage_options' ) {
|
||||
$submenu_pages[ $index ][3] = 'wpseo_manage_options';
|
||||
}
|
||||
}
|
||||
|
||||
return $submenu_pages;
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user