* @package WooCommerce\Admin
use Automattic\WooCommerce\Admin\PageController;
use Automattic\WooCommerce\Internal\Admin\EmailPreview\EmailPreview;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
public function __construct() {
add_action( 'init', array( $this, 'includes' ) );
// Hook in early (priority 1) to make sure the PageController's hooks are added before any WC admin pages or
// menus logic is run, including the enqueuing of assets via \Automattic\WooCommerce\Internal\Admin\WCAdminAssets.
// While it may not sound like it, the admin_menu action is triggered quite early,
// before the admin_init or admin_enqueue_scripts action.
// @see https://developer.wordpress.org/apis/hooks/action-reference/#actions-run-during-an-admin-page-request.
add_action( 'admin_menu', array( $this, 'init_page_controller' ), 1 );
add_action( 'current_screen', array( $this, 'conditional_includes' ) );
add_action( 'admin_init', array( $this, 'buffer' ), 1 );
add_action( 'admin_init', array( $this, 'preview_emails' ) );
add_action( 'admin_init', array( $this, 'preview_email_editor_dummy_content' ) );
add_action( 'admin_init', array( $this, 'prevent_admin_access' ) );
add_action( 'admin_init', array( $this, 'admin_redirects' ) );
add_action( 'admin_footer', 'wc_print_js', 25 );
add_filter( 'admin_footer_text', array( $this, 'admin_footer_text' ), 1 );
// Disable WXR export of schedule action posts.
add_filter( 'action_scheduler_post_type_args', array( $this, 'disable_webhook_post_export' ) );
// Add body class for WP 5.3+ compatibility.
add_filter( 'admin_body_class', array( $this, 'include_admin_body_class' ), 9999 );
// Add body class for Marketplace and My Subscriptions pages.
if ( isset( $_GET['page'] ) && 'wc-addons' === $_GET['page'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
add_filter( 'admin_body_class', array( 'WC_Admin_Addons', 'filter_admin_body_classes' ) );
* Output buffering allows admin screens to make redirects later on.
public function buffer() {
* Include any classes we need within admin.
public function includes() {
include_once __DIR__ . '/wc-admin-functions.php';
include_once __DIR__ . '/wc-meta-box-functions.php';
include_once __DIR__ . '/class-wc-admin-post-types.php';
include_once __DIR__ . '/class-wc-admin-taxonomies.php';
include_once __DIR__ . '/class-wc-admin-menus.php';
include_once __DIR__ . '/class-wc-admin-customize.php';
include_once __DIR__ . '/class-wc-admin-notices.php';
include_once __DIR__ . '/class-wc-admin-assets.php';
include_once __DIR__ . '/class-wc-admin-api-keys.php';
include_once __DIR__ . '/class-wc-admin-webhooks.php';
include_once __DIR__ . '/class-wc-admin-pointers.php';
include_once __DIR__ . '/class-wc-admin-importers.php';
include_once __DIR__ . '/class-wc-admin-exporters.php';
* Filter to enable/disable admin help tab.
if ( apply_filters( 'woocommerce_enable_admin_help_tab', true ) ) {
include_once __DIR__ . '/class-wc-admin-help.php';
include_once __DIR__ . '/helper/class-wc-helper.php';
// Marketplace suggestions & related REST API.
include_once __DIR__ . '/marketplace-suggestions/class-wc-marketplace-suggestions.php';
include_once __DIR__ . '/marketplace-suggestions/class-wc-marketplace-updater.php';
* Initialize the admin page controller logic.
public function init_page_controller() {
// We only need to make sure the controller is instantiated since the hooking is done in the constructor.
PageController::get_instance();
* Include admin files conditionally.
public function conditional_includes() {
$screen = get_current_screen();
case 'dashboard-network':
include __DIR__ . '/class-wc-admin-dashboard-setup.php';
include __DIR__ . '/class-wc-admin-dashboard.php';
case 'options-permalink':
include __DIR__ . '/class-wc-admin-permalink-settings.php';
include __DIR__ . '/plugin-updates/class-wc-plugins-screen-updates.php';
include __DIR__ . '/plugin-updates/class-wc-updates-screen-updates.php';
include __DIR__ . '/class-wc-admin-profile.php';
* 1. Nonced plugin install redirects.
* The user must have access rights, and we must ignore the network/bulk plugin updaters.
public function admin_redirects() {
// Don't run this fn from Action Scheduler requests.
if ( wc_is_running_from_async_action_scheduler() ) {
// phpcs:disable WordPress.Security.NonceVerification.Recommended
// Nonced plugin install redirects.
if ( ! empty( $_GET['wc-install-plugin-redirect'] ) ) {
$plugin_slug = wc_clean( wp_unslash( $_GET['wc-install-plugin-redirect'] ) );
if ( current_user_can( 'install_plugins' ) && in_array( $plugin_slug, array( 'woocommerce-gateway-stripe' ), true ) ) {
$nonce = wp_create_nonce( 'install-plugin_' . $plugin_slug );
$url = self_admin_url( 'update.php?action=install-plugin&plugin=' . $plugin_slug . '&_wpnonce=' . $nonce );
$url = admin_url( 'plugin-install.php?tab=search&type=term&s=' . $plugin_slug );
wp_safe_redirect( $url );
// phpcs:enable WordPress.Security.NonceVerification.Recommended
* Prevent any user who cannot 'edit_posts' (subscribers, customers etc) from accessing admin.
public function prevent_admin_access() {
// Do not interfere with admin-post or admin-ajax requests.
$exempted_paths = array( 'admin-post.php', 'admin-ajax.php' );
* This filter is documented in ../wc-user-functions.php
apply_filters( 'woocommerce_disable_admin_bar', true )
&& isset( $_SERVER['SCRIPT_FILENAME'] )
&& ! in_array( basename( sanitize_text_field( wp_unslash( $_SERVER['SCRIPT_FILENAME'] ) ) ), $exempted_paths, true )
$access_caps = array( 'edit_posts', 'manage_woocommerce', 'view_admin_dashboard' );
foreach ( $access_caps as $access_cap ) {
if ( current_user_can( $access_cap ) ) {
* Filter to prevent admin access.
if ( apply_filters( 'woocommerce_prevent_admin_access', $prevent_access ) ) {
wp_safe_redirect( wc_get_page_permalink( 'myaccount' ) );
* Preview email template.
public function preview_emails() {
if ( isset( $_GET['preview_woocommerce_mail'] ) ) {
if ( ! ( isset( $_REQUEST['_wpnonce'] ) && wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_wpnonce'] ) ), 'preview-mail' ) ) ) {
$email_preview = wc_get_container()->get( EmailPreview::class );
if ( isset( $_GET['type'] ) ) {
$type_param = sanitize_text_field( wp_unslash( $_GET['type'] ) );
$email_preview->set_email_type( $type_param );
} catch ( InvalidArgumentException $e ) {
wp_die( esc_html__( 'Invalid email type.', 'woocommerce' ), 400 );
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
$message = $email_preview->render();
$message = $email_preview->ensure_links_open_in_new_tab( $message );
// Start output buffering to prevent partial renders with PHP notices or warnings.
$message = $email_preview->render();
$message = $email_preview->ensure_links_open_in_new_tab( $message );
} catch ( Throwable $e ) {
'There was an error rendering the email preview. This doesn\'t affect actual email delivery. Please contact the extension author for assistance.',
// print the preview email.
// phpcs:ignore WordPress.Security.EscapeOutput
* Preview email editor placeholder dummy content.
public function preview_email_editor_dummy_content() {
if ( ! isset( $_GET['preview_woocommerce_mail_editor_content'] ) ) {
if ( ! isset( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_wpnonce'] ) ), 'preview-mail' ) ) {
* Email preview instance for rendering dummy content.
* @var EmailPreview $email_preview - email preview instance
$email_preview = wc_get_container()->get( EmailPreview::class );
$type_param = EmailPreview::DEFAULT_EMAIL_TYPE;
if ( isset( $_GET['type'] ) ) {
$type_param = sanitize_text_field( wp_unslash( $_GET['type'] ) );
$message = $email_preview->generate_placeholder_content( $type_param );
} catch ( \Exception $e ) {
// Catch other potential errors during content generation.
wp_die( esc_html__( 'There was an error rendering the email preview.', 'woocommerce' ), 404 );
// Print the placeholder content.
// phpcs:ignore WordPress.Security.EscapeOutput
* Change the admin footer text on WooCommerce admin pages.
* @param string $footer_text text to be rendered in the footer.
public function admin_footer_text( $footer_text ) {
if ( ! current_user_can( 'manage_woocommerce' ) || ! function_exists( 'wc_get_screen_ids' ) ) {
$current_screen = get_current_screen();
$wc_pages = wc_get_screen_ids();
$wc_pages = array_diff( $wc_pages, array( 'profile', 'user-edit' ) );
// Check to make sure we're on a WooCommerce admin page.
* Filter to determine if admin footer text should be displayed.
if ( isset( $current_screen->id ) && apply_filters( 'woocommerce_display_admin_footer_text', in_array( $current_screen->id, $wc_pages, true ) ) ) {
// Change the footer text.
if ( ! get_option( 'woocommerce_admin_footer_text_rated' ) ) {
/* translators: 1: WooCommerce 2:: five stars */
__( 'If you like %1$s please leave us a %2$s rating. A huge thanks in advance!', 'woocommerce' ),
sprintf( '<strong>%s</strong>', esc_html__( 'WooCommerce', 'woocommerce' ) ),
'<a href="https://wordpress.org/support/plugin/woocommerce/reviews?rate=5#new-post" target="_blank" class="wc-rating-link" aria-label="' . esc_attr__( 'five star', 'woocommerce' ) . '" data-rated="' . esc_attr__( 'Thanks :)', 'woocommerce' ) . '">★★★★★</a>'
"jQuery( 'a.wc-rating-link' ).on( 'click', function() {
jQuery.post( '" . WC()->ajax_url() . "', { action: 'woocommerce_rated' } );
jQuery( this ).parent().text( jQuery( this ).data( 'rated' ) );
$footer_text = __( 'Thank you for selling with WooCommerce.', 'woocommerce' );
* Check on a Jetpack install queued by the Setup Wizard.
* See: WC_Admin_Setup_Wizard::install_jetpack()
public function setup_wizard_check_jetpack() {
$jetpack_active = class_exists( 'Jetpack' );
'is_active' => $jetpack_active ? 'yes' : 'no',
* Disable WXR export of scheduled action posts.
* @param array $args Scheduled action post type registration args.
public function disable_webhook_post_export( $args ) {
$args['can_export'] = false;
* @param string $classes Body classes string.
public function include_admin_body_class( $classes ) {
if ( in_array( array( 'wc-wp-version-gte-53', 'wc-wp-version-gte-55' ), explode( ' ', $classes ), true ) ) {
$raw_version = get_bloginfo( 'version' );
$version_parts = explode( '-', $raw_version );
$version = count( $version_parts ) > 1 ? $version_parts[0] : $raw_version;
// Add WP 5.3+ compatibility class.
if ( $raw_version && version_compare( $version, '5.3', '>=' ) ) {
$classes .= ' wc-wp-version-gte-53';
// Add WP 5.5+ compatibility class.
if ( $raw_version && version_compare( $version, '5.5', '>=' ) ) {
$classes .= ' wc-wp-version-gte-55';