318 lines
9.2 KiB
PHP
318 lines
9.2 KiB
PHP
<?php
|
|
/**
|
|
* Display notices in admin
|
|
*
|
|
* @author WooThemes
|
|
* @category Admin
|
|
* @package WooCommerce/Admin
|
|
* @version 2.3.0
|
|
*/
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* WC_Admin_Notices Class.
|
|
*/
|
|
class WC_Admin_Notices {
|
|
|
|
/**
|
|
* Stores notices.
|
|
* @var array
|
|
*/
|
|
private static $notices = array();
|
|
|
|
/**
|
|
* Array of notices - name => callback.
|
|
* @var array
|
|
*/
|
|
private static $core_notices = array(
|
|
'install' => 'install_notice',
|
|
'update' => 'update_notice',
|
|
'template_files' => 'template_file_check_notice',
|
|
'theme_support' => 'theme_check_notice',
|
|
'legacy_shipping' => 'legacy_shipping_notice',
|
|
'no_shipping_methods' => 'no_shipping_methods_notice',
|
|
'simplify_commerce' => 'simplify_commerce_notice',
|
|
);
|
|
|
|
/**
|
|
* Constructor.
|
|
*/
|
|
public static function init() {
|
|
self::$notices = get_option( 'woocommerce_admin_notices', array() );
|
|
|
|
add_action( 'switch_theme', array( __CLASS__, 'reset_admin_notices' ) );
|
|
add_action( 'woocommerce_installed', array( __CLASS__, 'reset_admin_notices' ) );
|
|
add_action( 'wp_loaded', array( __CLASS__, 'hide_notices' ) );
|
|
add_action( 'shutdown', array( __CLASS__, 'store_notices' ) );
|
|
|
|
if ( current_user_can( 'manage_woocommerce' ) ) {
|
|
add_action( 'admin_print_styles', array( __CLASS__, 'add_notices' ) );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Store notices to DB
|
|
*/
|
|
public static function store_notices() {
|
|
update_option( 'woocommerce_admin_notices', self::get_notices() );
|
|
}
|
|
|
|
/**
|
|
* Get notices
|
|
* @return array
|
|
*/
|
|
public static function get_notices() {
|
|
return self::$notices;
|
|
}
|
|
|
|
/**
|
|
* Remove all notices.
|
|
*/
|
|
public static function remove_all_notices() {
|
|
self::$notices = array();
|
|
}
|
|
|
|
/**
|
|
* Reset notices for themes when switched or a new version of WC is installed.
|
|
*/
|
|
public static function reset_admin_notices() {
|
|
if ( ! current_theme_supports( 'woocommerce' ) && ! in_array( get_option( 'template' ), wc_get_core_supported_themes() ) ) {
|
|
self::add_notice( 'theme_support' );
|
|
}
|
|
|
|
$simplify_options = get_option( 'woocommerce_simplify_commerce_settings', array() );
|
|
$location = wc_get_base_location();
|
|
|
|
if ( ! class_exists( 'WC_Gateway_Simplify_Commerce_Loader' ) && ! empty( $simplify_options['enabled'] ) && 'yes' === $simplify_options['enabled'] && in_array( $location['country'], apply_filters( 'woocommerce_gateway_simplify_commerce_supported_countries', array( 'US', 'IE' ) ) ) ) {
|
|
WC_Admin_Notices::add_notice( 'simplify_commerce' );
|
|
}
|
|
|
|
self::add_notice( 'template_files' );
|
|
}
|
|
|
|
/**
|
|
* Show a notice.
|
|
* @param string $name
|
|
*/
|
|
public static function add_notice( $name ) {
|
|
self::$notices = array_unique( array_merge( self::get_notices(), array( $name ) ) );
|
|
}
|
|
|
|
/**
|
|
* Remove a notice from being displayed.
|
|
* @param string $name
|
|
*/
|
|
public static function remove_notice( $name ) {
|
|
self::$notices = array_diff( self::get_notices(), array( $name ) );
|
|
delete_option( 'woocommerce_admin_notice_' . $name );
|
|
}
|
|
|
|
/**
|
|
* See if a notice is being shown.
|
|
* @param string $name
|
|
* @return boolean
|
|
*/
|
|
public static function has_notice( $name ) {
|
|
return in_array( $name, self::get_notices() );
|
|
}
|
|
|
|
/**
|
|
* Hide a notice if the GET variable is set.
|
|
*/
|
|
public static function hide_notices() {
|
|
if ( isset( $_GET['wc-hide-notice'] ) && isset( $_GET['_wc_notice_nonce'] ) ) {
|
|
if ( ! wp_verify_nonce( $_GET['_wc_notice_nonce'], 'woocommerce_hide_notices_nonce' ) ) {
|
|
wp_die( __( 'Action failed. Please refresh the page and retry.', 'woocommerce' ) );
|
|
}
|
|
|
|
if ( ! current_user_can( 'manage_woocommerce' ) ) {
|
|
wp_die( __( 'Cheatin’ huh?', 'woocommerce' ) );
|
|
}
|
|
|
|
$hide_notice = sanitize_text_field( $_GET['wc-hide-notice'] );
|
|
self::remove_notice( $hide_notice );
|
|
do_action( 'woocommerce_hide_' . $hide_notice . '_notice' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add notices + styles if needed.
|
|
*/
|
|
public static function add_notices() {
|
|
$notices = self::get_notices();
|
|
|
|
if ( ! empty( $notices ) ) {
|
|
wp_enqueue_style( 'woocommerce-activation', plugins_url( '/assets/css/activation.css', WC_PLUGIN_FILE ) );
|
|
foreach ( $notices as $notice ) {
|
|
if ( ! empty( self::$core_notices[ $notice ] ) && apply_filters( 'woocommerce_show_admin_notice', true, $notice ) ) {
|
|
add_action( 'admin_notices', array( __CLASS__, self::$core_notices[ $notice ] ) );
|
|
} else {
|
|
add_action( 'admin_notices', array( __CLASS__, 'output_custom_notices' ) );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add a custom notice.
|
|
* @param string $name
|
|
* @param string $notice_html
|
|
*/
|
|
public static function add_custom_notice( $name, $notice_html ) {
|
|
self::add_notice( $name );
|
|
update_option( 'woocommerce_admin_notice_' . $name, wp_kses_post( $notice_html ) );
|
|
}
|
|
|
|
/**
|
|
* Output any stored custom notices.
|
|
*/
|
|
public static function output_custom_notices() {
|
|
$notices = self::get_notices();
|
|
|
|
if ( ! empty( $notices ) ) {
|
|
foreach ( $notices as $notice ) {
|
|
if ( empty( self::$core_notices[ $notice ] ) ) {
|
|
$notice_html = get_option( 'woocommerce_admin_notice_' . $notice );
|
|
|
|
if ( $notice_html ) {
|
|
include( 'views/html-notice-custom.php' );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If we need to update, include a message with the update button.
|
|
*/
|
|
public static function update_notice() {
|
|
if ( version_compare( get_option( 'woocommerce_db_version' ), WC_VERSION, '<' ) ) {
|
|
$updater = new WC_Background_Updater();
|
|
if ( $updater->is_updating() || ! empty( $_GET['do_update_woocommerce'] ) ) {
|
|
include( 'views/html-notice-updating.php' );
|
|
} else {
|
|
include( 'views/html-notice-update.php' );
|
|
}
|
|
} else {
|
|
include( 'views/html-notice-updated.php' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If we have just installed, show a message with the install pages button.
|
|
*/
|
|
public static function install_notice() {
|
|
include( 'views/html-notice-install.php' );
|
|
}
|
|
|
|
/**
|
|
* Show the Theme Check notice.
|
|
*/
|
|
public static function theme_check_notice() {
|
|
if ( ! current_theme_supports( 'woocommerce' ) && ! in_array( get_option( 'template' ), wc_get_core_supported_themes() ) ) {
|
|
include( 'views/html-notice-theme-support.php' );
|
|
} else {
|
|
self::remove_notice( 'theme_support' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Show a notice highlighting bad template files.
|
|
*/
|
|
public static function template_file_check_notice() {
|
|
$core_templates = WC_Admin_Status::scan_template_files( WC()->plugin_path() . '/templates' );
|
|
$outdated = false;
|
|
|
|
foreach ( $core_templates as $file ) {
|
|
|
|
$theme_file = false;
|
|
if ( file_exists( get_stylesheet_directory() . '/' . $file ) ) {
|
|
$theme_file = get_stylesheet_directory() . '/' . $file;
|
|
} elseif ( file_exists( get_stylesheet_directory() . '/woocommerce/' . $file ) ) {
|
|
$theme_file = get_stylesheet_directory() . '/woocommerce/' . $file;
|
|
} elseif ( file_exists( get_template_directory() . '/' . $file ) ) {
|
|
$theme_file = get_template_directory() . '/' . $file;
|
|
} elseif ( file_exists( get_template_directory() . '/woocommerce/' . $file ) ) {
|
|
$theme_file = get_template_directory() . '/woocommerce/' . $file;
|
|
}
|
|
|
|
if ( false !== $theme_file ) {
|
|
$core_version = WC_Admin_Status::get_file_version( WC()->plugin_path() . '/templates/' . $file );
|
|
$theme_version = WC_Admin_Status::get_file_version( $theme_file );
|
|
|
|
if ( $core_version && $theme_version && version_compare( $theme_version, $core_version, '<' ) ) {
|
|
$outdated = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $outdated ) {
|
|
include( 'views/html-notice-template-check.php' );
|
|
} else {
|
|
self::remove_notice( 'template_files' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Show a notice asking users to convert to shipping zones.
|
|
*/
|
|
public static function legacy_shipping_notice() {
|
|
$maybe_load_legacy_methods = array( 'flat_rate', 'free_shipping', 'international_delivery', 'local_delivery', 'local_pickup' );
|
|
$enabled = false;
|
|
|
|
foreach ( $maybe_load_legacy_methods as $method ) {
|
|
$options = get_option( 'woocommerce_' . $method . '_settings' );
|
|
if ( $options && isset( $options['enabled'] ) && 'yes' === $options['enabled'] ) {
|
|
$enabled = true;
|
|
}
|
|
}
|
|
|
|
if ( $enabled ) {
|
|
include( 'views/html-notice-legacy-shipping.php' );
|
|
} else {
|
|
self::remove_notice( 'template_files' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* No shipping methods.
|
|
*/
|
|
public static function no_shipping_methods_notice() {
|
|
if ( wc_shipping_enabled() && ( empty( $_GET['page'] ) || empty( $_GET['tab'] ) || 'wc-settings' !== $_GET['page'] || 'shipping' !== $_GET['tab'] ) ) {
|
|
global $wpdb;
|
|
|
|
$product_count = wp_count_posts( 'product' );
|
|
$method_count = wc_get_shipping_method_count();
|
|
|
|
if ( $product_count->publish > 0 && 0 === $method_count ) {
|
|
include( 'views/html-notice-no-shipping-methods.php' );
|
|
}
|
|
|
|
if ( $method_count > 0 ) {
|
|
self::remove_notice( 'no_shipping_methods' );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Simplify Commerce is being removed from core.
|
|
*/
|
|
public static function simplify_commerce_notice() {
|
|
$location = wc_get_base_location();
|
|
|
|
if ( class_exists( 'WC_Gateway_Simplify_Commerce_Loader' ) || ! in_array( $location['country'], apply_filters( 'woocommerce_gateway_simplify_commerce_supported_countries', array( 'US', 'IE' ) ) ) ) {
|
|
self::remove_notice( 'simplify_commerce' );
|
|
return;
|
|
}
|
|
if ( empty( $_GET['action'] ) ) {
|
|
include( 'views/html-notice-simplify-commerce.php' );
|
|
}
|
|
}
|
|
}
|
|
|
|
WC_Admin_Notices::init();
|