Yoast\WP\SEO\General\User_Interface
General_Page_Integration{} │ Yoast 1.0└─ Integration_Interface
Class General_Page_Integration.
Хуков нет.
Использование
$General_Page_Integration = new General_Page_Integration(); // use class methods
Методы
- public __construct(
- public add_page( $pages )
- public display_page()
- public enqueue_assets()
- public static get_conditionals()
- public register_hooks()
- private get_script_data()
- private is_task_list_opt_in_notification_seen()
Код General_Page_Integration{} General Page Integration{} Yoast 26.9
class General_Page_Integration implements Integration_Interface {
/**
* The page name.
*/
public const PAGE = 'wpseo_dashboard';
/**
* The notification helper.
*
* @var Notification_Helper
*/
protected $notification_helper;
/**
* The dashboard configuration.
*
* @var Dashboard_Configuration
*/
private $dashboard_configuration;
/**
* The task list configuration.
*
* @var Task_List_Configuration
*/
private $task_list_configuration;
/**
* Holds the WPSEO_Admin_Asset_Manager.
*
* @var WPSEO_Admin_Asset_Manager
*/
private $asset_manager;
/**
* Holds the Current_Page_Helper.
*
* @var Current_Page_Helper
*/
private $current_page_helper;
/**
* Holds the Product_Helper.
*
* @var Product_Helper
*/
private $product_helper;
/**
* Holds the Short_Link_Helper.
*
* @var Short_Link_Helper
*/
private $shortlink_helper;
/**
* The promotion manager.
*
* @var Promotion_Manager
*/
private $promotion_manager;
/**
* The alert dismissal action.
*
* @var Alert_Dismissal_Action
*/
private $alert_dismissal_action;
/**
* Holds the user helper.
*
* @var User_Helper
*/
private $user_helper;
/**
* Holds the options helper.
*
* @var Options_Helper
*/
private $options_helper;
/**
* Holds the WooCommerce conditional.
*
* @var WooCommerce_Conditional
*/
private $woocommerce_conditional;
/**
* Holds the WPSEO_Addon_Manager.
*
* @var WPSEO_Addon_Manager
*/
private $addon_manager;
/**
* Constructs Academy_Integration.
*
* @param WPSEO_Admin_Asset_Manager $asset_manager The WPSEO_Admin_Asset_Manager.
* @param Current_Page_Helper $current_page_helper The Current_Page_Helper.
* @param Product_Helper $product_helper The Product_Helper.
* @param Short_Link_Helper $shortlink_helper The Short_Link_Helper.
* @param Notification_Helper $notification_helper The Notification_Helper.
* @param Alert_Dismissal_Action $alert_dismissal_action The alert dismissal action.
* @param Promotion_Manager $promotion_manager The promotion manager.
* @param Dashboard_Configuration $dashboard_configuration The dashboard configuration.
* @param User_Helper $user_helper The user helper.
* @param Options_Helper $options_helper The options helper.
* @param WooCommerce_Conditional $woocommerce_conditional The WooCommerce conditional.
* @param WPSEO_Addon_Manager $addon_manager The WPSEO_Addon_Manager.
* @param Task_List_Configuration $task_list_configuration The task list configuration.
*/
public function __construct(
WPSEO_Admin_Asset_Manager $asset_manager,
Current_Page_Helper $current_page_helper,
Product_Helper $product_helper,
Short_Link_Helper $shortlink_helper,
Notification_Helper $notification_helper,
Alert_Dismissal_Action $alert_dismissal_action,
Promotion_Manager $promotion_manager,
Dashboard_Configuration $dashboard_configuration,
User_Helper $user_helper,
Options_Helper $options_helper,
WooCommerce_Conditional $woocommerce_conditional,
WPSEO_Addon_Manager $addon_manager,
Task_List_Configuration $task_list_configuration
) {
$this->asset_manager = $asset_manager;
$this->current_page_helper = $current_page_helper;
$this->product_helper = $product_helper;
$this->shortlink_helper = $shortlink_helper;
$this->notification_helper = $notification_helper;
$this->alert_dismissal_action = $alert_dismissal_action;
$this->promotion_manager = $promotion_manager;
$this->dashboard_configuration = $dashboard_configuration;
$this->user_helper = $user_helper;
$this->options_helper = $options_helper;
$this->woocommerce_conditional = $woocommerce_conditional;
$this->addon_manager = $addon_manager;
$this->task_list_configuration = $task_list_configuration;
}
/**
* Returns the conditionals based on which this loadable should be active.
*
* @return array<string>
*/
public static function get_conditionals() {
return [ Admin_Conditional::class, Non_Network_Admin_Conditional::class ];
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
// Add page.
\add_filter( 'wpseo_submenu_pages', [ $this, 'add_page' ] );
// Are we on the dashboard page?
if ( $this->current_page_helper->get_current_yoast_seo_page() === self::PAGE ) {
\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
}
}
/**
* Adds the page.
*
* @param array<string, array<string>> $pages The pages.
*
* @return array<string, array<string>> The pages.
*/
public function add_page( $pages ) {
\array_splice(
$pages,
0,
0,
[
[
self::PAGE,
'',
\__( 'General', 'wordpress-seo' ),
'wpseo_manage_options',
self::PAGE,
[ $this, 'display_page' ],
],
]
);
return $pages;
}
/**
* Displays the page.
*
* @return void
*/
public function display_page() {
echo '<div id="yoast-seo-general"></div>';
}
/**
* Enqueues the assets.
*
* @return void
*/
public function enqueue_assets() {
// Remove the emoji script as it is incompatible with both React and any contenteditable fields.
\remove_action( 'admin_print_scripts', 'print_emoji_detection_script' );
\wp_enqueue_media();
$this->asset_manager->enqueue_script( 'general-page' );
$this->asset_manager->enqueue_style( 'general-page' );
if ( $this->promotion_manager->is( 'black-friday-promotion' ) ) {
$this->asset_manager->enqueue_style( 'black-friday-banner' );
}
$this->asset_manager->localize_script( 'general-page', 'wpseoScriptData', $this->get_script_data() );
}
/**
* Creates the script data.
*
* @return array The script data.
*/
private function get_script_data() {
return [
'preferences' => [
'isPremium' => $this->product_helper->is_premium(),
'isRtl' => \is_rtl(),
'pluginUrl' => \plugins_url( '', \WPSEO_FILE ),
'upsellSettings' => [
'actionId' => 'load-nfd-ctb',
'premiumCtbId' => 'f6a84663-465f-4cb5-8ba5-f7a6d72224b2',
],
'llmTxtEnabled' => $this->options_helper->get( 'enable_llms_txt', true ),
'isWooCommerceActive' => $this->woocommerce_conditional->is_met(),
'addonsStatus' => [
'isWooSeoActive' => \is_plugin_active( $this->addon_manager->get_plugin_file( WPSEO_Addon_Manager::WOOCOMMERCE_SLUG ) ),
'isLocalSEOActive' => \is_plugin_active( $this->addon_manager->get_plugin_file( WPSEO_Addon_Manager::LOCAL_SLUG ) ),
'isNewsSEOActive' => \is_plugin_active( $this->addon_manager->get_plugin_file( WPSEO_Addon_Manager::NEWS_SLUG ) ),
'isVideoSEOActive' => \is_plugin_active( $this->addon_manager->get_plugin_file( WPSEO_Addon_Manager::VIDEO_SLUG ) ),
'isDuplicatePostActive' => \defined( 'DUPLICATE_POST_FILE' ),
],
],
'adminUrl' => \admin_url( 'admin.php' ),
'linkParams' => $this->shortlink_helper->get_query_params(),
'userEditUrl' => \add_query_arg( 'user_id', '{user_id}', \admin_url( 'user-edit.php' ) ),
'alerts' => $this->notification_helper->get_alerts(),
'currentPromotions' => $this->promotion_manager->get_current_promotions(),
'dismissedAlerts' => $this->alert_dismissal_action->all_dismissed(),
'dashboard' => $this->dashboard_configuration->get_configuration(),
'optInNotificationSeen' => [
'task_list' => $this->is_task_list_opt_in_notification_seen(),
],
'taskListConfiguration' => $this->task_list_configuration->get_configuration(),
];
}
/**
* Gets if the llms.txt opt-in notification has been seen.
*
* @return bool True if the notification has been seen, false otherwise.
*/
private function is_task_list_opt_in_notification_seen(): bool {
$current_user_id = $this->user_helper->get_current_user_id();
return (bool) $this->user_helper->get_meta( $current_user_id, '_yoast_wpseo_task_list_opt_in_notification_seen', true );
}
}