Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/includes/class-woocommerce.php

660 lines
22 KiB
PHP
Raw Blame History

<?php
/**
* WooCommerce setup
*
* @author Automattic
* @category API
* @package WooCommerce
* @since 3.2.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* Main WooCommerce Class.
*
* @class WooCommerce
* @version 3.2.0
*/
final class WooCommerce {
/**
* WooCommerce version.
*
* @var string
*/
public $version = '3.2.0';
/**
* The single instance of the class.
*
* @var WooCommerce
* @since 2.1
*/
protected static $_instance = null;
/**
* Session instance.
*
* @var WC_Session|WC_Session_Handler
*/
public $session = null;
/**
* Query instance.
*
* @var WC_Query
*/
public $query = null;
/**
* Product factory instance.
*
* @var WC_Product_Factory
*/
public $product_factory = null;
/**
* Countries instance.
*
* @var WC_Countries
*/
public $countries = null;
/**
* Integrations instance.
*
* @var WC_Integrations
*/
public $integrations = null;
/**
* Cart instance.
*
* @var WC_Cart
*/
public $cart = null;
/**
* Customer instance.
*
* @var WC_Customer
*/
public $customer = null;
/**
* Order factory instance.
*
* @var WC_Order_Factory
*/
public $order_factory = null;
/**
* Structured data instance.
*
* @var WC_Structured_Data
*/
public $structured_data = null;
/**
* Array of deprecated hook handlers.
*
* @var array of WC_Deprecated_Hooks
*/
public $deprecated_hook_handlers = array();
/**
* Main WooCommerce Instance.
*
* Ensures only one instance of WooCommerce is loaded or can be loaded.
*
* @since 2.1
* @static
* @see WC()
* @return WooCommerce - Main instance.
*/
public static function instance() {
if ( is_null( self::$_instance ) ) {
self::$_instance = new self();
}
return self::$_instance;
}
/**
* Cloning is forbidden.
*
* @since 2.1
*/
public function __clone() {
wc_doing_it_wrong( __FUNCTION__, __( 'Cheatin&#8217; huh?', 'woocommerce' ), '2.1' );
}
/**
* Unserializing instances of this class is forbidden.
*
* @since 2.1
*/
public function __wakeup() {
wc_doing_it_wrong( __FUNCTION__, __( 'Cheatin&#8217; huh?', 'woocommerce' ), '2.1' );
}
/**
* Auto-load in-accessible properties on demand.
*
* @param mixed $key Key name.
* @return mixed
*/
public function __get( $key ) {
if ( in_array( $key, array( 'payment_gateways', 'shipping', 'mailer', 'checkout' ), true ) ) {
return $this->$key();
}
}
/**
* WooCommerce Constructor.
*/
public function __construct() {
$this->define_constants();
$this->includes();
$this->init_hooks();
do_action( 'woocommerce_loaded' );
}
/**
* Hook into actions and filters.
*
* @since 2.3
*/
private function init_hooks() {
register_activation_hook( WC_PLUGIN_FILE, array( 'WC_Install', 'install' ) );
register_shutdown_function( array( $this, 'log_errors' ) );
add_action( 'after_setup_theme', array( $this, 'setup_environment' ) );
add_action( 'after_setup_theme', array( $this, 'include_template_functions' ), 11 );
add_action( 'init', array( $this, 'init' ), 0 );
add_action( 'init', array( 'WC_Shortcodes', 'init' ) );
add_action( 'init', array( 'WC_Emails', 'init_transactional_emails' ) );
add_action( 'init', array( $this, 'wpdb_table_fix' ), 0 );
add_action( 'switch_blog', array( $this, 'wpdb_table_fix' ), 0 );
}
/**
* Ensures fatal errors are logged so they can be picked up in the status report.
*
* @since 3.2.0
*/
public function log_errors() {
$error = error_get_last();
if ( E_ERROR === $error['type'] ) {
$logger = wc_get_logger();
$logger->critical(
$error['message'] . PHP_EOL,
array(
'source' => 'fatal-errors',
)
);
}
}
/**
* Define WC Constants.
*/
private function define_constants() {
$upload_dir = wp_upload_dir();
$this->define( 'WC_ABSPATH', dirname( WC_PLUGIN_FILE ) . '/' );
$this->define( 'WC_PLUGIN_BASENAME', plugin_basename( WC_PLUGIN_FILE ) );
$this->define( 'WC_VERSION', $this->version );
$this->define( 'WOOCOMMERCE_VERSION', $this->version );
$this->define( 'WC_ROUNDING_PRECISION', 4 );
$this->define( 'WC_DISCOUNT_ROUNDING_MODE', 2 );
$this->define( 'WC_TAX_ROUNDING_MODE', 'yes' === get_option( 'woocommerce_prices_include_tax', 'no' ) ? 2 : 1 );
$this->define( 'WC_DELIMITER', '|' );
$this->define( 'WC_LOG_DIR', $upload_dir['basedir'] . '/wc-logs/' );
$this->define( 'WC_SESSION_CACHE_GROUP', 'wc_session_id' );
$this->define( 'WC_TEMPLATE_DEBUG_MODE', false );
}
/**
* Define constant if not already set.
*
* @param string $name Constant name.
* @param string|bool $value Constant value.
*/
private function define( $name, $value ) {
if ( ! defined( $name ) ) {
define( $name, $value );
}
}
/**
* What type of request is this?
*
* @param string $type admin, ajax, cron or frontend.
* @return bool
*/
private function is_request( $type ) {
switch ( $type ) {
case 'admin' :
return is_admin();
case 'ajax' :
return defined( 'DOING_AJAX' );
case 'cron' :
return defined( 'DOING_CRON' );
case 'frontend' :
return ( ! is_admin() || defined( 'DOING_AJAX' ) ) && ! defined( 'DOING_CRON' );
}
}
/**
* Check the active theme.
*
* @since 2.6.9
* @param string $theme Theme slug to check.
* @return bool
*/
private function is_active_theme( $theme ) {
return get_template() === $theme;
}
/**
* Include required core files used in admin and on the frontend.
*/
public function includes() {
/**
* Class autoloader.
*/
include_once( WC_ABSPATH . 'includes/class-wc-autoloader.php' );
/**
* Interfaces.
*/
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-abstract-order-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-coupon-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-customer-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-customer-download-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-object-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-order-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-order-item-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-order-item-product-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-order-item-type-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-order-refund-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-payment-token-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-product-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-product-variable-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-shipping-zone-data-store-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-logger-interface.php' );
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-log-handler-interface.php' );
/**
* Abstract classes.
*/
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-data.php' ); // WC_Data for CRUD.
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-object-query.php' ); // WC_Object_Query for CRUD.
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-payment-token.php' ); // Payment Tokens.
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-product.php' ); // Products.
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-order.php' ); // Orders.
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-settings-api.php' ); // Settings API (for gateways, shipping, and integrations).
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-shipping-method.php' ); // A Shipping method.
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-payment-gateway.php' ); // A Payment gateway.
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-integration.php' ); // An integration with a service.
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-log-handler.php' );
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-deprecated-hooks.php' );
include_once( WC_ABSPATH . 'includes/abstracts/abstract-wc-session.php' );
/**
* Core classes.
*/
include_once( WC_ABSPATH . 'includes/wc-core-functions.php' );
include_once( WC_ABSPATH . 'includes/class-wc-datetime.php' );
include_once( WC_ABSPATH . 'includes/class-wc-post-types.php' ); // Registers post types.
include_once( WC_ABSPATH . 'includes/class-wc-install.php' );
include_once( WC_ABSPATH . 'includes/class-wc-geolocation.php' );
include_once( WC_ABSPATH . 'includes/class-wc-download-handler.php' );
include_once( WC_ABSPATH . 'includes/class-wc-comments.php' );
include_once( WC_ABSPATH . 'includes/class-wc-post-data.php' );
include_once( WC_ABSPATH . 'includes/class-wc-ajax.php' );
include_once( WC_ABSPATH . 'includes/class-wc-emails.php' );
include_once( WC_ABSPATH . 'includes/class-wc-data-exception.php' );
include_once( WC_ABSPATH . 'includes/class-wc-query.php' );
include_once( WC_ABSPATH . 'includes/class-wc-order-factory.php' ); // Order factory.
include_once( WC_ABSPATH . 'includes/class-wc-order-query.php' ); // Order query.
include_once( WC_ABSPATH . 'includes/class-wc-product-factory.php' ); // Product factory.
include_once( WC_ABSPATH . 'includes/class-wc-payment-tokens.php' ); // Payment tokens controller.
include_once( WC_ABSPATH . 'includes/class-wc-shipping-zone.php' );
include_once( WC_ABSPATH . 'includes/gateways/class-wc-payment-gateway-cc.php' ); // CC Payment Gateway.
include_once( WC_ABSPATH . 'includes/gateways/class-wc-payment-gateway-echeck.php' ); // eCheck Payment Gateway.
include_once( WC_ABSPATH . 'includes/class-wc-countries.php' ); // Defines countries and states.
include_once( WC_ABSPATH . 'includes/class-wc-integrations.php' ); // Loads integrations.
include_once( WC_ABSPATH . 'includes/class-wc-cache-helper.php' ); // Cache Helper.
include_once( WC_ABSPATH . 'includes/class-wc-https.php' ); // https Helper.
include_once( WC_ABSPATH . 'includes/class-wc-deprecated-action-hooks.php' );
include_once( WC_ABSPATH . 'includes/class-wc-deprecated-filter-hooks.php' );
include_once( WC_ABSPATH . 'includes/class-wc-background-emailer.php' );
include_once( WC_ABSPATH . 'includes/class-wc-discounts.php' );
/**
* Data stores - used to store and retrieve CRUD object data from the database.
*/
include_once( WC_ABSPATH . 'includes/class-wc-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-data-store-wp.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-coupon-data-store-cpt.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-product-data-store-cpt.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-product-grouped-data-store-cpt.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-product-variable-data-store-cpt.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-product-variation-data-store-cpt.php' );
include_once( WC_ABSPATH . 'includes/data-stores/abstract-wc-order-item-type-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-order-item-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-order-item-coupon-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-order-item-fee-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-order-item-product-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-order-item-shipping-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-order-item-tax-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-payment-token-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-customer-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-customer-data-store-session.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-customer-download-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-shipping-zone-data-store.php' );
include_once( WC_ABSPATH . 'includes/data-stores/abstract-wc-order-data-store-cpt.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-order-data-store-cpt.php' );
include_once( WC_ABSPATH . 'includes/data-stores/class-wc-order-refund-data-store-cpt.php' );
/**
* REST API.
*/
include_once( WC_ABSPATH . 'includes/class-wc-legacy-api.php' );
include_once( WC_ABSPATH . 'includes/class-wc-api.php' ); // API Class.
include_once( WC_ABSPATH . 'includes/class-wc-auth.php' ); // Auth Class.
include_once( WC_ABSPATH . 'includes/class-wc-register-wp-admin-settings.php' );
if ( defined( 'WP_CLI' ) && WP_CLI ) {
include_once( WC_ABSPATH . 'includes/class-wc-cli.php' );
}
if ( $this->is_request( 'admin' ) ) {
include_once( WC_ABSPATH . 'includes/admin/class-wc-admin.php' );
}
if ( $this->is_request( 'frontend' ) ) {
$this->frontend_includes();
}
if ( $this->is_request( 'frontend' ) || $this->is_request( 'cron' ) ) {
include_once( WC_ABSPATH . 'includes/class-wc-session-handler.php' );
}
if ( $this->is_request( 'cron' ) && 'yes' === get_option( 'woocommerce_allow_tracking', 'no' ) ) {
include_once( WC_ABSPATH . 'includes/class-wc-tracker.php' );
}
$this->query = new WC_Query();
$this->api = new WC_API();
}
/**
* Include required frontend files.
*/
public function frontend_includes() {
include_once( WC_ABSPATH . 'includes/wc-cart-functions.php' );
include_once( WC_ABSPATH . 'includes/wc-notice-functions.php' );
include_once( WC_ABSPATH . 'includes/wc-template-hooks.php' );
include_once( WC_ABSPATH . 'includes/class-wc-template-loader.php' ); // Template Loader.
include_once( WC_ABSPATH . 'includes/class-wc-frontend-scripts.php' ); // Frontend Scripts.
include_once( WC_ABSPATH . 'includes/class-wc-form-handler.php' ); // Form Handlers.
include_once( WC_ABSPATH . 'includes/class-wc-cart.php' ); // The main cart class.
include_once( WC_ABSPATH . 'includes/class-wc-cart-item.php' );
include_once( WC_ABSPATH . 'includes/class-wc-tax.php' ); // Tax class.
include_once( WC_ABSPATH . 'includes/class-wc-shipping-zones.php' ); // Shipping Zones class.
include_once( WC_ABSPATH . 'includes/class-wc-customer.php' ); // Customer class.
include_once( WC_ABSPATH . 'includes/class-wc-shortcodes.php' ); // Shortcodes class.
include_once( WC_ABSPATH . 'includes/class-wc-embed.php' ); // Embeds.
include_once( WC_ABSPATH . 'includes/class-wc-structured-data.php' ); // Structured Data class.
if ( $this->is_active_theme( 'twentyseventeen' ) ) {
include_once( WC_ABSPATH . 'includes/theme-support/class-wc-twenty-seventeen.php' );
}
}
/**
* Function used to Init WooCommerce Template Functions - This makes them pluggable by plugins and themes.
*/
public function include_template_functions() {
include_once( WC_ABSPATH . 'includes/wc-template-functions.php' );
}
/**
* Init WooCommerce when WordPress Initialises.
*/
public function init() {
// Before init action.
do_action( 'before_woocommerce_init' );
// Set up localisation.
$this->load_plugin_textdomain();
// Load class instances.
$this->product_factory = new WC_Product_Factory(); // Product Factory to create new product instances.
$this->order_factory = new WC_Order_Factory(); // Order Factory to create new order instances.
$this->countries = new WC_Countries(); // Countries class.
$this->integrations = new WC_Integrations(); // Integrations class.
$this->structured_data = new WC_Structured_Data(); // Structured Data class, generates and handles structured data.
$this->deprecated_hook_handlers['actions'] = new WC_Deprecated_Action_Hooks();
$this->deprecated_hook_handlers['filters'] = new WC_Deprecated_Filter_Hooks();
// Session class, handles session data for users - can be overwritten if custom handler is needed.
if ( $this->is_request( 'frontend' ) || $this->is_request( 'cron' ) ) {
$session_class = apply_filters( 'woocommerce_session_handler', 'WC_Session_Handler' );
$this->session = new $session_class();
}
// Classes/actions loaded for the frontend and for ajax requests.
if ( $this->is_request( 'frontend' ) ) {
$this->cart = new WC_Cart(); // Cart class, stores the cart contents.
$this->customer = new WC_Customer( get_current_user_id(), true ); // Customer class, handles data such as customer location.
add_action( 'shutdown', array( $this->customer, 'save' ), 10 ); // Customer should be saved during shutdown.
}
$this->load_webhooks();
// Init action.
do_action( 'woocommerce_init' );
}
/**
* Load Localisation files.
*
* Note: the first-loaded translation file overrides any following ones if the same translation is present.
*
* Locales found in:
* - WP_LANG_DIR/woocommerce/woocommerce-LOCALE.mo
* - WP_LANG_DIR/plugins/woocommerce-LOCALE.mo
*/
public function load_plugin_textdomain() {
$locale = is_admin() && function_exists( 'get_user_locale' ) ? get_user_locale() : get_locale();
$locale = apply_filters( 'plugin_locale', $locale, 'woocommerce' );
unload_textdomain( 'woocommerce' );
load_textdomain( 'woocommerce', WP_LANG_DIR . '/woocommerce/woocommerce-' . $locale . '.mo' );
load_plugin_textdomain( 'woocommerce', false, plugin_basename( dirname( WC_PLUGIN_FILE ) ) . '/i18n/languages' );
}
/**
* Ensure theme and server variable compatibility and setup image sizes.
*/
public function setup_environment() {
/* @deprecated 2.2 Use WC()->template_path() instead. */
$this->define( 'WC_TEMPLATE_PATH', $this->template_path() );
$this->add_thumbnail_support();
$this->add_image_sizes();
}
/**
* Ensure post thumbnail support is turned on.
*/
private function add_thumbnail_support() {
if ( ! current_theme_supports( 'post-thumbnails' ) ) {
add_theme_support( 'post-thumbnails' );
}
add_post_type_support( 'product', 'thumbnail' );
}
/**
* Add WC Image sizes to WP.
*
* @since 2.3
*/
private function add_image_sizes() {
$shop_thumbnail = wc_get_image_size( 'shop_thumbnail' );
$shop_catalog = wc_get_image_size( 'shop_catalog' );
$shop_single = wc_get_image_size( 'shop_single' );
add_image_size( 'shop_thumbnail', $shop_thumbnail['width'], $shop_thumbnail['height'], $shop_thumbnail['crop'] );
add_image_size( 'shop_catalog', $shop_catalog['width'], $shop_catalog['height'], $shop_catalog['crop'] );
add_image_size( 'shop_single', $shop_single['width'], $shop_single['height'], $shop_single['crop'] );
}
/**
* Get the plugin url.
*
* @return string
*/
public function plugin_url() {
return untrailingslashit( plugins_url( '/', WC_PLUGIN_FILE ) );
}
/**
* Get the plugin path.
*
* @return string
*/
public function plugin_path() {
return untrailingslashit( plugin_dir_path( WC_PLUGIN_FILE ) );
}
/**
* Get the template path.
*
* @return string
*/
public function template_path() {
return apply_filters( 'woocommerce_template_path', 'woocommerce/' );
}
/**
* Get Ajax URL.
*
* @return string
*/
public function ajax_url() {
return admin_url( 'admin-ajax.php', 'relative' );
}
/**
* Return the WC API URL for a given request.
*
* @param string $request Requested endpoint.
* @param bool|null $ssl If should use SSL, null if should auto detect. Default: null.
* @return string
*/
public function api_request_url( $request, $ssl = null ) {
if ( is_null( $ssl ) ) {
$scheme = parse_url( home_url(), PHP_URL_SCHEME );
} elseif ( $ssl ) {
$scheme = 'https';
} else {
$scheme = 'http';
}
if ( strstr( get_option( 'permalink_structure' ), '/index.php/' ) ) {
$api_request_url = trailingslashit( home_url( '/index.php/wc-api/' . $request, $scheme ) );
} elseif ( get_option( 'permalink_structure' ) ) {
$api_request_url = trailingslashit( home_url( '/wc-api/' . $request, $scheme ) );
} else {
$api_request_url = add_query_arg( 'wc-api', $request, trailingslashit( home_url( '', $scheme ) ) );
}
return esc_url_raw( apply_filters( 'woocommerce_api_request_url', $api_request_url, $request, $ssl ) );
}
/**
* Load & enqueue active webhooks.
*
* @since 2.2
*/
private function load_webhooks() {
if ( ! is_blog_installed() ) {
return;
}
if ( false === ( $webhooks = get_transient( 'woocommerce_webhook_ids' ) ) ) {
$webhooks = get_posts( array(
'fields' => 'ids',
'post_type' => 'shop_webhook',
'post_status' => 'publish',
'posts_per_page' => -1,
) );
set_transient( 'woocommerce_webhook_ids', $webhooks );
}
foreach ( $webhooks as $webhook_id ) {
$webhook = new WC_Webhook( $webhook_id );
$webhook->enqueue();
}
}
/**
* WooCommerce Payment Token Meta API and Term/Order item Meta - set table names.
*/
public function wpdb_table_fix() {
global $wpdb;
$wpdb->payment_tokenmeta = $wpdb->prefix . 'woocommerce_payment_tokenmeta';
$wpdb->order_itemmeta = $wpdb->prefix . 'woocommerce_order_itemmeta';
$wpdb->tables[] = 'woocommerce_payment_tokenmeta';
$wpdb->tables[] = 'woocommerce_order_itemmeta';
if ( get_option( 'db_version' ) < 34370 ) {
$wpdb->woocommerce_termmeta = $wpdb->prefix . 'woocommerce_termmeta';
$wpdb->tables[] = 'woocommerce_termmeta';
}
}
/**
* Get Checkout Class.
*
* @return WC_Checkout
*/
public function checkout() {
return WC_Checkout::instance();
}
/**
* Get gateways class.
*
* @return WC_Payment_Gateways
*/
public function payment_gateways() {
return WC_Payment_Gateways::instance();
}
/**
* Get shipping class.
*
* @return WC_Shipping
*/
public function shipping() {
return WC_Shipping::instance();
}
/**
* Email Class.
*
* @return WC_Emails
*/
public function mailer() {
return WC_Emails::instance();
}
}
Reference in New Issue View Git Blame Copy Permalink