375 lines
12 KiB
PHP
Executable File
375 lines
12 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* Plugin Name: WooCommerce Admin
|
|
* Plugin URI: https://github.com/woocommerce/woocommerce-admin
|
|
* Description: A new JavaScript-driven interface for managing your store. The plugin includes new and improved reports, and a dashboard to monitor all the important key metrics of your site.
|
|
* Author: WooCommerce
|
|
* Author URI: https://woocommerce.com/
|
|
* Text Domain: woocommerce-admin
|
|
* Domain Path: /languages
|
|
* Version: 0.16.0
|
|
* Requires at least: 5.2.0
|
|
* Requires PHP: 5.6.20
|
|
*
|
|
* WC requires at least: 3.6.0
|
|
* WC tested up to: 3.6.4
|
|
*
|
|
* @package WC_Admin
|
|
*/
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
use Automattic\WooCommerce\Admin\Notes\WC_Admin_Notes;
|
|
use Automattic\WooCommerce\Admin\Notes\WC_Admin_Notes_Historical_Data;
|
|
use Automattic\WooCommerce\Admin\Notes\WC_Admin_Notes_Order_Milestones;
|
|
use Automattic\WooCommerce\Admin\Notes\WC_Admin_Notes_Welcome_Message;
|
|
use Automattic\WooCommerce\Admin\Notes\WC_Admin_Notes_Woo_Subscriptions_Notes;
|
|
use Automattic\WooCommerce\Admin\WC_Admin_Report_Exporter;
|
|
|
|
/**
|
|
* Autoload packages.
|
|
*
|
|
* We want to fail gracefully if `composer install` has not been executed yet, so we are checking for the autoloader.
|
|
* If the autoloader is not present, let's log the failure and display a nice admin notice.
|
|
*/
|
|
$autoloader = __DIR__ . '/vendor/autoload.php';
|
|
if ( is_readable( $autoloader ) ) {
|
|
require $autoloader;
|
|
} else {
|
|
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
|
|
error_log( // phpcs:ignore
|
|
sprintf(
|
|
/* translators: 1: composer command. 2: plugin directory */
|
|
esc_html__( 'Your installation of the WooCommerce Admin feature plugin is incomplete. Please run %1$s within the %2$s directory.', 'woocommerce-admin' ),
|
|
'`composer install`',
|
|
'`' . esc_html( str_replace( ABSPATH, '', __DIR__ ) ) . '`'
|
|
)
|
|
);
|
|
}
|
|
/**
|
|
* Outputs an admin notice if composer install has not been ran.
|
|
*/
|
|
add_action(
|
|
'admin_notices',
|
|
function() {
|
|
?>
|
|
<div class="notice notice-error">
|
|
<p>
|
|
<?php
|
|
printf(
|
|
/* translators: 1: composer command. 2: plugin directory */
|
|
esc_html__( 'Your installation of the WooCommerce Admin feature plugin is incomplete. Please run %1$s within the %2$s directory.', 'woocommerce-admin' ),
|
|
'<code>composer install</code>',
|
|
'<code>' . esc_html( str_replace( ABSPATH, '', __DIR__ ) ) . '</code>'
|
|
);
|
|
?>
|
|
</p>
|
|
</div>
|
|
<?php
|
|
}
|
|
);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Feature plugin main class.
|
|
*
|
|
* @internal This file will not be bundled with woo core, only the feature plugin.
|
|
* @internal Note this is not called WC_Admin due to a class already existing in core with that name.
|
|
*/
|
|
class WC_Admin_Feature_Plugin {
|
|
/**
|
|
* The single instance of the class.
|
|
*
|
|
* @var object
|
|
*/
|
|
protected static $instance = null;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function __construct() {}
|
|
|
|
/**
|
|
* Get class instance.
|
|
*
|
|
* @return object Instance.
|
|
*/
|
|
final public static function instance() {
|
|
if ( null === static::$instance ) {
|
|
static::$instance = new static();
|
|
}
|
|
return static::$instance;
|
|
}
|
|
|
|
/**
|
|
* Init the feature plugin, only if we can detect both Gutenberg and WooCommerce.
|
|
*/
|
|
public function init() {
|
|
$this->define_constants();
|
|
register_activation_hook( WC_ADMIN_PLUGIN_FILE, array( $this, 'on_activation' ) );
|
|
register_deactivation_hook( WC_ADMIN_PLUGIN_FILE, array( $this, 'on_deactivation' ) );
|
|
add_action( 'plugins_loaded', array( $this, 'on_plugins_loaded' ) );
|
|
add_filter( 'action_scheduler_store_class', array( $this, 'replace_actionscheduler_store_class' ) );
|
|
}
|
|
|
|
/**
|
|
* Install DB and create cron events when activated.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function on_activation() {
|
|
WC_Admin_Install::create_tables();
|
|
WC_Admin_Install::create_events();
|
|
}
|
|
|
|
/**
|
|
* Remove WooCommerce Admin scheduled actions on deactivate.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function on_deactivation() {
|
|
// Check if we are deactivating due to dependencies not being satisfied.
|
|
// If WooCommerce is disabled we can't include files that depend upon it.
|
|
if ( ! $this->check_dependencies() ) {
|
|
return;
|
|
}
|
|
|
|
$this->includes();
|
|
WC_Admin_Reports_Sync::clear_queued_actions();
|
|
WC_Admin_Notes::clear_queued_actions();
|
|
wp_clear_scheduled_hook( 'wc_admin_daily' );
|
|
}
|
|
|
|
/**
|
|
* Setup plugin once all other plugins are loaded.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function on_plugins_loaded() {
|
|
$this->load_plugin_textdomain();
|
|
|
|
if ( ! $this->check_dependencies() ) {
|
|
add_action( 'admin_init', array( $this, 'deactivate_self' ) );
|
|
add_action( 'admin_notices', array( $this, 'render_dependencies_notice' ) );
|
|
return;
|
|
}
|
|
|
|
if ( ! $this->check_build() ) {
|
|
add_action( 'admin_notices', array( $this, 'render_build_notice' ) );
|
|
}
|
|
|
|
$this->includes();
|
|
$this->hooks();
|
|
}
|
|
|
|
/**
|
|
* Define Constants.
|
|
*/
|
|
protected function define_constants() {
|
|
$this->define( 'WC_ADMIN_APP', 'wc-admin-app' );
|
|
$this->define( 'WC_ADMIN_ABSPATH', dirname( __FILE__ ) . '/' );
|
|
$this->define( 'WC_ADMIN_DIST_JS_FOLDER', 'dist/' );
|
|
$this->define( 'WC_ADMIN_DIST_CSS_FOLDER', 'dist/' );
|
|
$this->define( 'WC_ADMIN_FEATURES_PATH', WC_ADMIN_ABSPATH . 'includes/features/' );
|
|
$this->define( 'WC_ADMIN_PLUGIN_FILE', __FILE__ );
|
|
// WARNING: Do not directly edit this version number constant.
|
|
// It is updated as part of the prebuild process from the package.json value.
|
|
$this->define( 'WC_ADMIN_VERSION_NUMBER', '0.16.0' );
|
|
}
|
|
|
|
/**
|
|
* Load Localisation files.
|
|
*/
|
|
protected function load_plugin_textdomain() {
|
|
load_plugin_textdomain( 'woocommerce-admin', false, basename( dirname( __FILE__ ) ) . '/languages' );
|
|
}
|
|
|
|
/**
|
|
* Include WC Admin classes.
|
|
*/
|
|
public function includes() {
|
|
// Initialize the WC API extensions.
|
|
WC_Admin_Reports_Sync::init();
|
|
WC_Admin_Install::init();
|
|
WC_Admin_Events::instance()->init();
|
|
new WC_Admin_Api_Init();
|
|
WC_Admin_Report_Exporter::init();
|
|
|
|
// CRUD classes.
|
|
WC_Admin_Notes::init();
|
|
|
|
// Admin note providers.
|
|
// @todo These should be bundled in the features/ folder, but loading them from there currently has a load order issue.
|
|
new WC_Admin_Notes_Woo_Subscriptions_Notes();
|
|
new WC_Admin_Notes_Historical_Data();
|
|
new WC_Admin_Notes_Order_Milestones();
|
|
new WC_Admin_Notes_Welcome_Message();
|
|
}
|
|
|
|
/**
|
|
* Filter in our ActionScheduler Store class.
|
|
*
|
|
* @param string $store_class ActionScheduler Store class name.
|
|
* @return string ActionScheduler Store class name.
|
|
*/
|
|
public function replace_actionscheduler_store_class( $store_class ) {
|
|
// Don't override any other overrides.
|
|
if ( 'ActionScheduler_wpPostStore' !== $store_class ) {
|
|
return $store_class;
|
|
}
|
|
|
|
return 'WC_Admin_ActionScheduler_WPPostStore';
|
|
}
|
|
|
|
/**
|
|
* Removes core hooks in favor of our local feature plugin handlers.
|
|
*
|
|
* @see WC_Admin_Library::__construct()
|
|
*/
|
|
protected function hooks() {
|
|
remove_action( 'init', array( 'WC_Admin_Library', 'load_features' ) );
|
|
remove_action( 'admin_enqueue_scripts', array( 'WC_Admin_Library', 'register_scripts' ) );
|
|
remove_action( 'admin_enqueue_scripts', array( 'WC_Admin_Library', 'load_scripts' ), 15 );
|
|
remove_action( 'woocommerce_components_settings', array( 'WC_Admin_Library', 'add_component_settings' ) );
|
|
remove_filter( 'admin_body_class', array( 'WC_Admin_Library', 'add_admin_body_classes' ) );
|
|
remove_action( 'admin_menu', array( 'WC_Admin_Library', 'register_page_handler' ) );
|
|
remove_filter( 'admin_title', array( 'WC_Admin_Library', 'update_admin_title' ) );
|
|
|
|
remove_action( 'rest_api_init', array( 'WC_Admin_Library', 'register_user_data' ) );
|
|
remove_action( 'in_admin_header', array( 'WC_Admin_Library', 'embed_page_header' ) );
|
|
remove_filter( 'woocommerce_settings_groups', array( 'WC_Admin_Library', 'add_settings_group' ) );
|
|
remove_filter( 'woocommerce_settings-wc_admin', array( 'WC_Admin_Library', 'add_settings' ) );
|
|
|
|
remove_action( 'admin_head', array( 'WC_Admin_Library', 'update_link_structure' ), 20 );
|
|
|
|
new WC_Admin_Loader();
|
|
|
|
add_filter( 'woocommerce_admin_features', array( $this, 'replace_supported_features' ) );
|
|
add_action( 'admin_menu', array( $this, 'register_devdocs_page' ) );
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns true if all dependencies for the wc-admin plugin are loaded.
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function check_dependencies() {
|
|
$woocommerce_minimum_met = class_exists( 'WooCommerce' ) && version_compare( WC_VERSION, '3.6', '>=' );
|
|
if ( ! $woocommerce_minimum_met ) {
|
|
return false;
|
|
}
|
|
|
|
$wordpress_version = get_bloginfo( 'version' );
|
|
return version_compare( $wordpress_version, '5.2.0', '>=' );
|
|
}
|
|
|
|
/**
|
|
* Returns true if build file exists.
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function check_build() {
|
|
return file_exists( plugin_dir_path( __FILE__ ) . '/dist/app/index.js' );
|
|
}
|
|
|
|
/**
|
|
* Deactivates this plugin.
|
|
*/
|
|
public function deactivate_self() {
|
|
deactivate_plugins( plugin_basename( WC_ADMIN_PLUGIN_FILE ) );
|
|
unset( $_GET['activate'] );
|
|
}
|
|
|
|
/**
|
|
* Notify users of the plugin requirements.
|
|
*/
|
|
public function render_dependencies_notice() {
|
|
// The notice varies by WordPress version.
|
|
$wordpress_version = get_bloginfo( 'version' );
|
|
$has_valid_wp_version = version_compare( $wordpress_version, '5.2.0', '>=' );
|
|
|
|
if ( $has_valid_wp_version ) {
|
|
$message = sprintf(
|
|
/* translators: URL of WooCommerce plugin */
|
|
__( 'The WooCommerce Admin feature plugin requires <a href="%s">WooCommerce</a> 3.6 or greater to be installed and active.', 'woocommerce-admin' ),
|
|
'https://wordpress.org/plugins/woocommerce/'
|
|
);
|
|
} else {
|
|
$message = sprintf(
|
|
/* translators: 1: URL of WordPress.org, 2: URL of WooCommerce plugin */
|
|
__( 'The WooCommerce Admin feature plugin requires both <a href="%1$s">WordPress</a> 5.2 or greater and <a href="%2$s">WooCommerce</a> 3.6 or greater to be installed and active.', 'woocommerce-admin' ),
|
|
'https://wordpress.org/',
|
|
'https://wordpress.org/plugins/woocommerce/'
|
|
);
|
|
}
|
|
printf( '<div class="error"><p>%s</p></div>', $message ); /* WPCS: xss ok. */
|
|
}
|
|
|
|
/**
|
|
* Notify users that the plugin needs to be built.
|
|
*/
|
|
public function render_build_notice() {
|
|
$message_one = __( 'You have installed a development version of WooCommerce Admin which requires files to be built. From the plugin directory, run <code>npm install</code> to install dependencies, <code>npm run build</code> to build the files.', 'woocommerce-admin' );
|
|
$message_two = sprintf(
|
|
/* translators: 1: URL of GitHub Repository build page */
|
|
__( 'Or you can download a pre-built version of the plugin by visiting <a href="%1$s">the releases page in the repository</a>.', 'woocommerce-admin' ),
|
|
'https://github.com/woocommerce/woocommerce-admin/releases'
|
|
);
|
|
printf( '<div class="error"><p>%s %s</p></div>', $message_one, $message_two ); /* WPCS: xss ok. */
|
|
}
|
|
|
|
/**
|
|
* Overwrites the allowed features array using a local `feature-config.php` file.
|
|
*
|
|
* @param array $features Array of feature slugs.
|
|
*/
|
|
public function replace_supported_features( $features ) {
|
|
$feature_config = apply_filters( 'wc_admin_get_feature_config', wc_admin_get_feature_config() );
|
|
$features = array_keys( array_filter( $feature_config ) );
|
|
return $features;
|
|
}
|
|
|
|
/**
|
|
* Adds a menu item for the wc-admin devdocs.
|
|
*/
|
|
public function register_devdocs_page() {
|
|
if ( WC_Admin_Loader::is_feature_enabled( 'devdocs' ) && defined( 'WP_DEBUG' ) && WP_DEBUG && defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
|
|
wc_admin_register_page(
|
|
array(
|
|
'title' => 'DevDocs',
|
|
'parent' => 'woocommerce',
|
|
'path' => '/devdocs',
|
|
)
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Define constant if not already set.
|
|
*
|
|
* @param string $name Constant name.
|
|
* @param string|bool $value Constant value.
|
|
*/
|
|
protected function define( $name, $value ) {
|
|
if ( ! defined( $name ) ) {
|
|
define( $name, $value );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Prevent cloning.
|
|
*/
|
|
private function __clone() {}
|
|
|
|
/**
|
|
* Prevent unserializing.
|
|
*/
|
|
private function __wakeup() {}
|
|
}
|
|
|
|
WC_Admin_Feature_Plugin::instance()->init();
|