->plugin_url() . '/assets/images/woocommerce_logo.png' ); ?>){kind=logo}
-
-
- - - - - - -
-
-
+
+
Welcome to the WooCommerce repository on GitHub. Here you can browse the source, look at open issues and keep track of development. We recommend all developers to follow the [WooCommerce development blog](https://woocommerce.wordpress.com/) to stay up to date about everything happening in the project. You can also [follow @DevelopWC](https://twitter.com/DevelopWC) on Twitter for the latest development updates.
@@ -18,6 +18,7 @@ If you are not a developer, please use the [WooCommerce plugin page](https://wor
* [WooCommerce Developer Documentation](https://github.com/woocommerce/woocommerce/wiki)
* [WooCommerce Code Reference](https://docs.woocommerce.com/wc-apidocs/)
* [WooCommerce REST API Docs](https://woocommerce.github.io/woocommerce-rest-api-docs/)
+* [Setting up a development environment](https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment)
## Reporting Security Issues
To disclose a security issue to our team, [please submit a report via HackerOne here](https://hackerone.com/automattic/).
@@ -34,4 +35,10 @@ This repository is not suitable for support. Please don't use our issue tracker
Support requests in issues on this repository will be closed on sight.
## Contributing to WooCommerce
-If you have a patch or have stumbled upon an issue with WooCommerce core, you can contribute this back to the code. Please read our [contributor guidelines](https://github.com/woocommerce/woocommerce/blob/master/.github/CONTRIBUTING.md) for more information how you can do this.
+If you have a patch or have stumbled upon an issue with WooCommerce core, you can contribute this back to the code. Please read our [contributor guidelines](https://github.com/woocommerce/woocommerce/blob/trunk/.github/CONTRIBUTING.md) for more information how you can do this.
+
+
+
+ Made with 💜 by WooCommerce.
+ We're hiring! Come work with us!
+
| - | - | - |
- -
-' . sprintf( - /* translators: %s: Documentation URL */ - __( 'Should you need help understanding, using, or extending WooCommerce, please read our documentation. You will find all kinds of resources including snippets, tutorials and much more.', 'woocommerce' ), - 'https://docs.woocommerce.com/documentation/plugins/woocommerce/?utm_source=helptab&utm_medium=product&utm_content=docs&utm_campaign=woocommerceplugin' - ) . '
' . - '' . sprintf( - /* translators: %s: Forum URL */ - __( 'For further assistance with WooCommerce core, use the community forum. For help with premium extensions sold on WooCommerce.com, open a support request at WooCommerce.com.', 'woocommerce' ), - 'https://wordpress.org/support/plugin/woocommerce', - 'https://woocommerce.com/my-account/create-a-ticket/?utm_source=helptab&utm_medium=product&utm_content=tickets&utm_campaign=woocommerceplugin' - ) . '
' . - '' . __( 'Before asking for help, we recommend checking the system status page to identify any problems with your configuration.', 'woocommerce' ) . '
' . - '' . __( 'System status', 'woocommerce' ) . ' ' . __( 'Community forum', 'woocommerce' ) . ' ' . __( 'WooCommerce.com support', 'woocommerce' ) . '
', - ) - ); - - $screen->add_help_tab( - array( - 'id' => 'woocommerce_bugs_tab', - 'title' => __( 'Found a bug?', 'woocommerce' ), - 'content' => - '' . sprintf( __( 'If you find a bug within WooCommerce core you can create a ticket via Github issues. Ensure you read the contribution guide prior to submitting your report. To help us solve your issue, please be as descriptive as possible and include your system status report.', 'woocommerce' ), 'https://github.com/woocommerce/woocommerce/issues?state=open', 'https://github.com/woocommerce/woocommerce/blob/master/.github/CONTRIBUTING.md', admin_url( 'admin.php?page=wc-status' ) ) . '
' . - '' . __( 'Report a bug', 'woocommerce' ) . ' ' . __( 'System status', 'woocommerce' ) . '
', - - ) - ); - - $screen->set_help_sidebar( - '' . __( 'For more information:', 'woocommerce' ) . '
' . - '' . __( 'About WooCommerce', 'woocommerce' ) . '
' . - '' . __( 'WordPress.org project', 'woocommerce' ) . '
' . - '' . __( 'Github project', 'woocommerce' ) . '
' . - '' . __( 'Official theme', 'woocommerce' ) . '
' . - '' . __( 'Official extensions', 'woocommerce' ) . '
' - ); - } -} - -return new WC_Admin_Help(); diff --git a/includes/admin/class-wc-admin-menus.php b/includes/admin/class-wc-admin-menus.php deleted file mode 100644 index d926fcf548e..00000000000 --- a/includes/admin/class-wc-admin-menus.php +++ /dev/null @@ -1,392 +0,0 @@ - Menus > Pages. - add_action( 'admin_head-nav-menus.php', array( $this, 'add_nav_menu_meta_boxes' ) ); - - // Admin bar menus. - if ( apply_filters( 'woocommerce_show_admin_bar_visit_store', true ) ) { - add_action( 'admin_bar_menu', array( $this, 'admin_bar_menus' ), 31 ); - } - - // Handle saving settings earlier than load-{page} hook to avoid race conditions in conditional menus. - add_action( 'wp_loaded', array( $this, 'save_settings' ) ); - } - - /** - * Add menu items. - */ - public function admin_menu() { - global $menu; - - $woocommerce_icon = 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMDI0IDEwMjQiPjxwYXRoIGZpbGw9IiNhMmFhYjIiIGQ9Ik02MTIuMTkyIDQyNi4zMzZjMC02Ljg5Ni0zLjEzNi01MS42LTI4LTUxLjYtMzcuMzYgMC00Ni43MDQgNzIuMjU2LTQ2LjcwNCA4Mi42MjQgMCAzLjQwOCAzLjE1MiA1OC40OTYgMjguMDMyIDU4LjQ5NiAzNC4xOTItLjAzMiA0Ni42NzItNzIuMjg4IDQ2LjY3Mi04OS41MnptMjAyLjE5MiAwYzAtNi44OTYtMy4xNTItNTEuNi0yOC4wMzItNTEuNi0zNy4yOCAwLTQ2LjYwOCA3Mi4yNTYtNDYuNjA4IDgyLjYyNCAwIDMuNDA4IDMuMDcyIDU4LjQ5NiAyNy45NTIgNTguNDk2IDM0LjE5Mi0uMDMyIDQ2LjY4OC03Mi4yODggNDYuNjg4LTg5LjUyek0xNDEuMjk2Ljc2OGMtNjguMjI0IDAtMTIzLjUwNCA1NS40ODgtMTIzLjUwNCAxMjMuOTJ2NjUwLjcyYzAgNjguNDMyIDU1LjI5NiAxMjMuOTIgMTIzLjUwNCAxMjMuOTJoMzM5LjgwOGwxMjMuNTA0IDEyMy45MzZWODk5LjMyOGgyNzguMDQ4YzY4LjIyNCAwIDEyMy41Mi01NS40NzIgMTIzLjUyLTEyMy45MnYtNjUwLjcyYzAtNjguNDMyLTU1LjI5Ni0xMjMuOTItMTIzLjUyLTEyMy45MmgtNzQxLjM2em01MjYuODY0IDQyMi4xNmMwIDU1LjA4OC0zMS4wODggMTU0Ljg4LTEwMi42NCAxNTQuODgtNi4yMDggMC0xOC40OTYtMy42MTYtMjUuNDI0LTYuMDE2LTMyLjUxMi0xMS4xNjgtNTAuMTkyLTQ5LjY5Ni01Mi4zNTItNjYuMjU2IDAgMC0zLjA3Mi0xNy43OTItMy4wNzItNDAuNzUyIDAtMjIuOTkyIDMuMDcyLTQ1LjMyOCAzLjA3Mi00NS4zMjggMTUuNTUyLTc1LjcyOCA0My41NTItMTA2LjczNiA5Ni40NDgtMTA2LjczNiA1OS4wNzItLjAzMiA4My45NjggNTguNTI4IDgzLjk2OCAxMTAuMjA4ek00ODYuNDk2IDMwMi40YzAgMy4zOTItNDMuNTUyIDE0MS4xNjgtNDMuNTUyIDIxMy40MjR2NzUuNzEyYy0yLjU5MiAxMi4wOC00LjE2IDI0LjE0NC0yMS44MjQgMjQuMTQ0LTQ2LjYwOCAwLTg4Ljg4LTE1MS40NzItOTIuMDE2LTE2MS44NC02LjIwOCA2Ljg5Ni02Mi4yNCAxNjEuODQtOTYuNDQ4IDE2MS44NC0yNC44NjQgMC00My41NTItMTEzLjY0OC00Ni42MDgtMTIzLjkzNkMxNzYuNzA0IDQzNi42NzIgMTYwIDMzNC4yMjQgMTYwIDMyNy4zMjhjMC0yMC42NzIgMS4xNTItMzguNzM2IDI2LjA0OC0zOC43MzYgNi4yMDggMCAyMS42IDYuMDY0IDIzLjcxMiAxNy4xNjggMTEuNjQ4IDYyLjAzMiAxNi42ODggMTIwLjUxMiAyOS4xNjggMTg1Ljk2OCAxLjg1NiAyLjkyOCAxLjUwNCA3LjAwOCA0LjU2IDEwLjQzMiAzLjE1Mi0xMC4yODggNjYuOTI4LTE2OC43ODQgOTQuOTYtMTY4Ljc4NCAyMi41NDQgMCAzMC40IDQ0LjU5MiAzMy41MzYgNjEuODI0IDYuMjA4IDIwLjY1NiAxMy4wODggNTUuMjE2IDIyLjQxNiA4Mi43NTIgMC0xMy43NzYgMTIuNDgtMjAzLjEyIDY1LjM5Mi0yMDMuMTIgMTguNTkyLjAzMiAyNi43MDQgNi45MjggMjYuNzA0IDI3LjU2OHpNODcwLjMyIDQyMi45MjhjMCA1NS4wODgtMzEuMDg4IDE1NC44OC0xMDIuNjQgMTU0Ljg4LTYuMTkyIDAtMTguNDQ4LTMuNjE2LTI1LjQyNC02LjAxNi0zMi40MzItMTEuMTY4LTUwLjE3Ni00OS42OTYtNTIuMjg4LTY2LjI1NiAwIDAtMy44ODgtMTcuOTItMy44ODgtNDAuODk2czMuODg4LTQ1LjE4NCAzLjg4OC00NS4xODRjMTUuNTUyLTc1LjcyOCA0My40ODgtMTA2LjczNiA5Ni4zODQtMTA2LjczNiA1OS4xMDQtLjAzMiA4My45NjggNTguNTI4IDgzLjk2OCAxMTAuMjA4eiIvPjwvc3ZnPg=='; - - if ( current_user_can( 'edit_others_shop_orders' ) ) { - $menu[] = array( '', 'read', 'separator-woocommerce', '', 'wp-menu-separator woocommerce' ); // WPCS: override ok. - } - - add_menu_page( __( 'WooCommerce', 'woocommerce' ), __( 'WooCommerce', 'woocommerce' ), 'edit_others_shop_orders', 'woocommerce', null, $woocommerce_icon, '55.5' ); - - add_submenu_page( 'edit.php?post_type=product', __( 'Attributes', 'woocommerce' ), __( 'Attributes', 'woocommerce' ), 'manage_product_terms', 'product_attributes', array( $this, 'attributes_page' ) ); - } - - /** - * Add menu item. - */ - public function reports_menu() { - if ( current_user_can( 'edit_others_shop_orders' ) ) { - add_submenu_page( 'woocommerce', __( 'Reports', 'woocommerce' ), __( 'Reports', 'woocommerce' ), 'view_woocommerce_reports', 'wc-reports', array( $this, 'reports_page' ) ); - } else { - add_menu_page( __( 'Sales reports', 'woocommerce' ), __( 'Sales reports', 'woocommerce' ), 'view_woocommerce_reports', 'wc-reports', array( $this, 'reports_page' ), 'dashicons-chart-bar', '55.6' ); - } - } - - /** - * Add menu item. - */ - public function settings_menu() { - $settings_page = add_submenu_page( 'woocommerce', __( 'WooCommerce settings', 'woocommerce' ), __( 'Settings', 'woocommerce' ), 'manage_woocommerce', 'wc-settings', array( $this, 'settings_page' ) ); - - add_action( 'load-' . $settings_page, array( $this, 'settings_page_init' ) ); - } - - /** - * Loads gateways and shipping methods into memory for use within settings. - */ - public function settings_page_init() { - WC()->payment_gateways(); - WC()->shipping(); - - // Include settings pages. - WC_Admin_Settings::get_settings_pages(); - - // Add any posted messages. - if ( ! empty( $_GET['wc_error'] ) ) { // WPCS: input var okay, CSRF ok. - WC_Admin_Settings::add_error( wp_kses_post( wp_unslash( $_GET['wc_error'] ) ) ); // WPCS: input var okay, CSRF ok. - } - - if ( ! empty( $_GET['wc_message'] ) ) { // WPCS: input var okay, CSRF ok. - WC_Admin_Settings::add_message( wp_kses_post( wp_unslash( $_GET['wc_message'] ) ) ); // WPCS: input var okay, CSRF ok. - } - - do_action( 'woocommerce_settings_page_init' ); - } - - /** - * Handle saving of settings. - * - * @return void - */ - public function save_settings() { - global $current_tab, $current_section; - - // We should only save on the settings page. - if ( ! is_admin() || ! isset( $_GET['page'] ) || 'wc-settings' !== $_GET['page'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended - return; - } - - // Include settings pages. - WC_Admin_Settings::get_settings_pages(); - - // Get current tab/section. - $current_tab = empty( $_GET['tab'] ) ? 'general' : sanitize_title( wp_unslash( $_GET['tab'] ) ); // WPCS: input var okay, CSRF ok. - $current_section = empty( $_REQUEST['section'] ) ? '' : sanitize_title( wp_unslash( $_REQUEST['section'] ) ); // WPCS: input var okay, CSRF ok. - - // Save settings if data has been posted. - if ( '' !== $current_section && apply_filters( "woocommerce_save_settings_{$current_tab}_{$current_section}", ! empty( $_POST['save'] ) ) ) { // WPCS: input var okay, CSRF ok. - WC_Admin_Settings::save(); - } elseif ( '' === $current_section && apply_filters( "woocommerce_save_settings_{$current_tab}", ! empty( $_POST['save'] ) ) ) { // WPCS: input var okay, CSRF ok. - WC_Admin_Settings::save(); - } - } - - /** - * Add menu item. - */ - public function status_menu() { - add_submenu_page( 'woocommerce', __( 'WooCommerce status', 'woocommerce' ), __( 'Status', 'woocommerce' ), 'manage_woocommerce', 'wc-status', array( $this, 'status_page' ) ); - } - - /** - * Addons menu item. - */ - public function addons_menu() { - $count_html = WC_Helper_Updater::get_updates_count_html(); - /* translators: %s: extensions count */ - $menu_title = sprintf( __( 'Extensions %s', 'woocommerce' ), $count_html ); - add_submenu_page( 'woocommerce', __( 'WooCommerce extensions', 'woocommerce' ), $menu_title, 'manage_woocommerce', 'wc-addons', array( $this, 'addons_page' ) ); - } - - /** - * Highlights the correct top level admin menu item for post type add screens. - */ - public function menu_highlight() { - global $parent_file, $submenu_file, $post_type; - - switch ( $post_type ) { - case 'shop_order': - case 'shop_coupon': - $parent_file = 'woocommerce'; // WPCS: override ok. - break; - case 'product': - $screen = get_current_screen(); - if ( $screen && taxonomy_is_product_attribute( $screen->taxonomy ) ) { - $submenu_file = 'product_attributes'; // WPCS: override ok. - $parent_file = 'edit.php?post_type=product'; // WPCS: override ok. - } - break; - } - } - - /** - * Adds the order processing count to the menu. - */ - public function menu_order_count() { - global $submenu; - - if ( isset( $submenu['woocommerce'] ) ) { - // Remove 'WooCommerce' sub menu item. - unset( $submenu['woocommerce'][0] ); - - // Add count if user has access. - if ( apply_filters( 'woocommerce_include_processing_order_count_in_menu', true ) && current_user_can( 'edit_others_shop_orders' ) ) { - $order_count = apply_filters( 'woocommerce_menu_order_count', wc_processing_order_count() ); - - if ( $order_count ) { - foreach ( $submenu['woocommerce'] as $key => $menu_item ) { - if ( 0 === strpos( $menu_item[0], _x( 'Orders', 'Admin menu name', 'woocommerce' ) ) ) { - $submenu['woocommerce'][ $key ][0] .= ' ' . number_format_i18n( $order_count ) . ''; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited - break; - } - } - } - } - } - } - - /** - * Reorder the WC menu items in admin. - * - * @param int $menu_order Menu order. - * @return array - */ - public function menu_order( $menu_order ) { - // Initialize our custom order array. - $woocommerce_menu_order = array(); - - // Get the index of our custom separator. - $woocommerce_separator = array_search( 'separator-woocommerce', $menu_order, true ); - - // Get index of product menu. - $woocommerce_product = array_search( 'edit.php?post_type=product', $menu_order, true ); - - // Loop through menu order and do some rearranging. - foreach ( $menu_order as $index => $item ) { - - if ( 'woocommerce' === $item ) { - $woocommerce_menu_order[] = 'separator-woocommerce'; - $woocommerce_menu_order[] = $item; - $woocommerce_menu_order[] = 'edit.php?post_type=product'; - unset( $menu_order[ $woocommerce_separator ] ); - unset( $menu_order[ $woocommerce_product ] ); - } elseif ( ! in_array( $item, array( 'separator-woocommerce' ), true ) ) { - $woocommerce_menu_order[] = $item; - } - } - - // Return order. - return $woocommerce_menu_order; - } - - /** - * Custom menu order. - * - * @param bool $enabled Whether custom menu ordering is already enabled. - * @return bool - */ - public function custom_menu_order( $enabled ) { - return $enabled || current_user_can( 'edit_others_shop_orders' ); - } - - /** - * Validate screen options on update. - * - * @param bool|int $status Screen option value. Default false to skip. - * @param string $option The option name. - * @param int $value The number of rows to use. - */ - public function set_screen_option( $status, $option, $value ) { - if ( in_array( $option, array( 'woocommerce_keys_per_page', 'woocommerce_webhooks_per_page' ), true ) ) { - return $value; - } - - return $status; - } - - /** - * Init the reports page. - */ - public function reports_page() { - WC_Admin_Reports::output(); - } - - /** - * Init the settings page. - */ - public function settings_page() { - WC_Admin_Settings::output(); - } - - /** - * Init the attributes page. - */ - public function attributes_page() { - WC_Admin_Attributes::output(); - } - - /** - * Init the status page. - */ - public function status_page() { - WC_Admin_Status::output(); - } - - /** - * Init the addons page. - */ - public function addons_page() { - WC_Admin_Addons::output(); - } - - /** - * Add custom nav meta box. - * - * Adapted from http://www.johnmorrisonline.com/how-to-add-a-fully-functional-custom-meta-box-to-wordpress-navigation-menus/. - */ - public function add_nav_menu_meta_boxes() { - add_meta_box( 'woocommerce_endpoints_nav_link', __( 'WooCommerce endpoints', 'woocommerce' ), array( $this, 'nav_menu_links' ), 'nav-menus', 'side', 'low' ); - } - - /** - * Output menu links. - */ - public function nav_menu_links() { - // Get items from account menu. - $endpoints = wc_get_account_menu_items(); - - // Remove dashboard item. - if ( isset( $endpoints['dashboard'] ) ) { - unset( $endpoints['dashboard'] ); - } - - // Include missing lost password. - $endpoints['lost-password'] = __( 'Lost password', 'woocommerce' ); - - $endpoints = apply_filters( 'woocommerce_custom_nav_menu_items', $endpoints ); - - ?> -' . wp_kses_post( $error ) . '
'; - } - - echo ''; - - // Clear. - delete_option( 'woocommerce_meta_box_errors' ); - } - } - - /** - * Add WC Meta boxes. - */ - public function add_meta_boxes() { - $screen = get_current_screen(); - $screen_id = $screen ? $screen->id : ''; - - // Products. - add_meta_box( 'postexcerpt', __( 'Product short description', 'woocommerce' ), 'WC_Meta_Box_Product_Short_Description::output', 'product', 'normal' ); - add_meta_box( 'woocommerce-product-data', __( 'Product data', 'woocommerce' ), 'WC_Meta_Box_Product_Data::output', 'product', 'normal', 'high' ); - add_meta_box( 'woocommerce-product-images', __( 'Product gallery', 'woocommerce' ), 'WC_Meta_Box_Product_Images::output', 'product', 'side', 'low' ); - - // Orders. - foreach ( wc_get_order_types( 'order-meta-boxes' ) as $type ) { - $order_type_object = get_post_type_object( $type ); - /* Translators: %s order type name. */ - add_meta_box( 'woocommerce-order-data', sprintf( __( '%s data', 'woocommerce' ), $order_type_object->labels->singular_name ), 'WC_Meta_Box_Order_Data::output', $type, 'normal', 'high' ); - add_meta_box( 'woocommerce-order-items', __( 'Items', 'woocommerce' ), 'WC_Meta_Box_Order_Items::output', $type, 'normal', 'high' ); - /* Translators: %s order type name. */ - add_meta_box( 'woocommerce-order-notes', sprintf( __( '%s notes', 'woocommerce' ), $order_type_object->labels->singular_name ), 'WC_Meta_Box_Order_Notes::output', $type, 'side', 'default' ); - add_meta_box( 'woocommerce-order-downloads', __( 'Downloadable product permissions', 'woocommerce' ) . wc_help_tip( __( 'Note: Permissions for order items will automatically be granted when the order status changes to processing/completed.', 'woocommerce' ) ), 'WC_Meta_Box_Order_Downloads::output', $type, 'normal', 'default' ); - /* Translators: %s order type name. */ - add_meta_box( 'woocommerce-order-actions', sprintf( __( '%s actions', 'woocommerce' ), $order_type_object->labels->singular_name ), 'WC_Meta_Box_Order_Actions::output', $type, 'side', 'high' ); - } - - // Coupons. - add_meta_box( 'woocommerce-coupon-data', __( 'Coupon data', 'woocommerce' ), 'WC_Meta_Box_Coupon_Data::output', 'shop_coupon', 'normal', 'high' ); - - // Comment rating. - if ( 'comment' === $screen_id && isset( $_GET['c'] ) && metadata_exists( 'comment', wc_clean( wp_unslash( $_GET['c'] ) ), 'rating' ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended - add_meta_box( 'woocommerce-rating', __( 'Rating', 'woocommerce' ), 'WC_Meta_Box_Product_Reviews::output', 'comment', 'normal', 'high' ); - } - } - - /** - * Remove bloat. - */ - public function remove_meta_boxes() { - remove_meta_box( 'postexcerpt', 'product', 'normal' ); - remove_meta_box( 'product_shipping_classdiv', 'product', 'side' ); - remove_meta_box( 'commentsdiv', 'product', 'normal' ); - remove_meta_box( 'commentstatusdiv', 'product', 'side' ); - remove_meta_box( 'commentstatusdiv', 'product', 'normal' ); - remove_meta_box( 'woothemes-settings', 'shop_coupon', 'normal' ); - remove_meta_box( 'commentstatusdiv', 'shop_coupon', 'normal' ); - remove_meta_box( 'slugdiv', 'shop_coupon', 'normal' ); - - foreach ( wc_get_order_types( 'order-meta-boxes' ) as $type ) { - remove_meta_box( 'commentsdiv', $type, 'normal' ); - remove_meta_box( 'woothemes-settings', $type, 'normal' ); - remove_meta_box( 'commentstatusdiv', $type, 'normal' ); - remove_meta_box( 'slugdiv', $type, 'normal' ); - remove_meta_box( 'submitdiv', $type, 'side' ); - } - } - - /** - * Rename core meta boxes. - */ - public function rename_meta_boxes() { - global $post; - - // Comments/Reviews. - if ( isset( $post ) && ( 'publish' === $post->post_status || 'private' === $post->post_status ) && post_type_supports( 'product', 'comments' ) ) { - remove_meta_box( 'commentsdiv', 'product', 'normal' ); - add_meta_box( 'commentsdiv', __( 'Reviews', 'woocommerce' ), 'post_comment_meta_box', 'product', 'normal' ); - } - } - - /** - * Check if we're saving, the trigger an action based on the post type. - * - * @param int $post_id Post ID. - * @param object $post Post object. - */ - public function save_meta_boxes( $post_id, $post ) { - $post_id = absint( $post_id ); - - // $post_id and $post are required - if ( empty( $post_id ) || empty( $post ) || self::$saved_meta_boxes ) { - return; - } - - // Dont' save meta boxes for revisions or autosaves. - if ( Constants::is_true( 'DOING_AUTOSAVE' ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) { - return; - } - - // Check the nonce. - if ( empty( $_POST['woocommerce_meta_nonce'] ) || ! wp_verify_nonce( wp_unslash( $_POST['woocommerce_meta_nonce'] ), 'woocommerce_save_data' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - return; - } - - // Check the post being saved == the $post_id to prevent triggering this call for other save_post events. - if ( empty( $_POST['post_ID'] ) || absint( $_POST['post_ID'] ) !== $post_id ) { - return; - } - - // Check user has permission to edit. - if ( ! current_user_can( 'edit_post', $post_id ) ) { - return; - } - - // We need this save event to run once to avoid potential endless loops. This would have been perfect: - // remove_action( current_filter(), __METHOD__ ); - // But cannot be used due to https://github.com/woocommerce/woocommerce/issues/6485 - // When that is patched in core we can use the above. - self::$saved_meta_boxes = true; - - // Check the post type. - if ( in_array( $post->post_type, wc_get_order_types( 'order-meta-boxes' ), true ) ) { - do_action( 'woocommerce_process_shop_order_meta', $post_id, $post ); - } elseif ( in_array( $post->post_type, array( 'product', 'shop_coupon' ), true ) ) { - do_action( 'woocommerce_process_' . $post->post_type . '_meta', $post_id, $post ); - } - } -} - -new WC_Admin_Meta_Boxes(); diff --git a/includes/admin/class-wc-admin-notices.php b/includes/admin/class-wc-admin-notices.php deleted file mode 100644 index fa9716cc498..00000000000 --- a/includes/admin/class-wc-admin-notices.php +++ /dev/null @@ -1,650 +0,0 @@ - callback. - * - * @var array - */ - private static $core_notices = array( - 'update' => 'update_notice', - 'template_files' => 'template_file_check_notice', - 'legacy_shipping' => 'legacy_shipping_notice', - 'no_shipping_methods' => 'no_shipping_methods_notice', - 'regenerating_thumbnails' => 'regenerating_thumbnails_notice', - 'regenerating_lookup_table' => 'regenerating_lookup_table_notice', - 'no_secure_connection' => 'secure_connection_notice', - WC_PHP_MIN_REQUIREMENTS_NOTICE => 'wp_php_min_requirements_notice', - 'maxmind_license_key' => 'maxmind_missing_license_key_notice', - 'redirect_download_method' => 'redirect_download_method_notice', - 'uploads_directory_is_unprotected' => 'uploads_directory_is_unprotected_notice', - 'base_tables_missing' => 'base_tables_missing_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__, 'add_redirect_download_method_notice' ) ); - add_action( 'wp_loaded', array( __CLASS__, 'hide_notices' ) ); - // @TODO: This prevents Action Scheduler async jobs from storing empty list of notices during WC installation. - // That could lead to OBW not starting and 'Run setup wizard' notice not appearing in WP admin, which we want - // to avoid. - if ( ! WC_Install::is_new_install() || ! wc_is_running_from_async_action_scheduler() ) { - add_action( 'shutdown', array( __CLASS__, 'store_notices' ) ); - } - - if ( current_user_can( 'manage_woocommerce' ) ) { - add_action( 'admin_print_styles', array( __CLASS__, 'add_notices' ) ); - } - } - - /** - * Parses query to create nonces when available. - * - * @param object $response The WP_REST_Response we're working with. - * @return object $response The prepared WP_REST_Response object. - */ - public static function prepare_note_with_nonce( $response ) { - if ( 'wc-update-db-reminder' !== $response->data['name'] || ! isset( $response->data['actions'] ) ) { - return $response; - } - - foreach ( $response->data['actions'] as $action_key => $action ) { - $url_parts = ! empty( $action->query ) ? wp_parse_url( $action->query ) : ''; - - if ( ! isset( $url_parts['query'] ) ) { - continue; - } - - wp_parse_str( $url_parts['query'], $params ); - - if ( array_key_exists( '_nonce_action', $params ) && array_key_exists( '_nonce_name', $params ) ) { - $org_params = $params; - - // Check to make sure we're acting on the whitelisted nonce actions. - if ( 'wc_db_update' !== $params['_nonce_action'] && 'woocommerce_hide_notices_nonce' !== $params['_nonce_action'] ) { - continue; - } - - unset( $org_params['_nonce_action'] ); - unset( $org_params['_nonce_name'] ); - - $url = $url_parts['scheme'] . '://' . $url_parts['host'] . $url_parts['path']; - - $nonce = array( $params['_nonce_name'] => wp_create_nonce( $params['_nonce_action'] ) ); - $merged_params = array_merge( $nonce, $org_params ); - $parsed_query = add_query_arg( $merged_params, $url ); - - $response->data['actions'][ $action_key ]->query = $parsed_query; - $response->data['actions'][ $action_key ]->url = $parsed_query; - } - } - - return $response; - } - - /** - * 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 ( ! self::is_ssl() ) { - self::add_notice( 'no_secure_connection' ); - } - if ( ! self::is_uploads_directory_protected() ) { - self::add_notice( 'uploads_directory_is_unprotected' ); - } - self::add_notice( 'template_files' ); - self::add_min_version_notice(); - self::add_maxmind_missing_license_key_notice(); - } - - /** - * Show a notice. - * - * @param string $name Notice name. - * @param bool $force_save Force saving inside this method instead of at the 'shutdown'. - */ - public static function add_notice( $name, $force_save = false ) { - self::$notices = array_unique( array_merge( self::get_notices(), array( $name ) ) ); - - if ( $force_save ) { - // Adding early save to prevent more race conditions with notices. - self::store_notices(); - } - } - - /** - * Remove a notice from being displayed. - * - * @param string $name Notice name. - * @param bool $force_save Force saving inside this method instead of at the 'shutdown'. - */ - public static function remove_notice( $name, $force_save = false ) { - self::$notices = array_diff( self::get_notices(), array( $name ) ); - delete_option( 'woocommerce_admin_notice_' . $name ); - - if ( $force_save ) { - // Adding early save to prevent more race conditions with notices. - self::store_notices(); - } - } - - /** - * See if a notice is being shown. - * - * @param string $name Notice name. - * - * @return boolean - */ - public static function has_notice( $name ) { - return in_array( $name, self::get_notices(), true ); - } - - /** - * 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'] ) ) { // WPCS: input var ok, CSRF ok. - if ( ! wp_verify_nonce( sanitize_key( wp_unslash( $_GET['_wc_notice_nonce'] ) ), 'woocommerce_hide_notices_nonce' ) ) { // WPCS: input var ok, CSRF ok. - wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'woocommerce' ) ); - } - - if ( ! current_user_can( 'manage_woocommerce' ) ) { - wp_die( esc_html__( 'You don’t have permission to do this.', 'woocommerce' ) ); - } - - $hide_notice = sanitize_text_field( wp_unslash( $_GET['wc-hide-notice'] ) ); // WPCS: input var ok, CSRF ok. - - self::remove_notice( $hide_notice ); - - update_user_meta( get_current_user_id(), 'dismissed_' . $hide_notice . '_notice', true ); - - do_action( 'woocommerce_hide_' . $hide_notice . '_notice' ); - } - } - - /** - * Add notices + styles if needed. - */ - public static function add_notices() { - $notices = self::get_notices(); - - if ( empty( $notices ) ) { - return; - } - - $screen = get_current_screen(); - $screen_id = $screen ? $screen->id : ''; - $show_on_screens = array( - 'dashboard', - 'plugins', - ); - - // Notices should only show on WooCommerce screens, the main dashboard, and on the plugins screen. - if ( ! in_array( $screen_id, wc_get_screen_ids(), true ) && ! in_array( $screen_id, $show_on_screens, true ) ) { - return; - } - - wp_enqueue_style( 'woocommerce-activation', plugins_url( '/assets/css/activation.css', WC_PLUGIN_FILE ), array(), Constants::get_constant( 'WC_VERSION' ) ); - - // Add RTL support. - wp_style_add_data( 'woocommerce-activation', 'rtl', 'replace' ); - - 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 Notice name. - * @param string $notice_html 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 dirname( __FILE__ ) . '/views/html-notice-custom.php'; - } - } - } - } - } - - /** - * If we need to update the database, include a message with the DB update button. - */ - public static function update_notice() { - $screen = get_current_screen(); - $screen_id = $screen ? $screen->id : ''; - if ( WC()->is_wc_admin_active() && in_array( $screen_id, wc_get_screen_ids(), true ) ) { - return; - } - - if ( WC_Install::needs_db_update() ) { - $next_scheduled_date = WC()->queue()->get_next( 'woocommerce_run_update_callback', null, 'woocommerce-db-updates' ); - - if ( $next_scheduled_date || ! empty( $_GET['do_update_woocommerce'] ) ) { // WPCS: input var ok, CSRF ok. - include dirname( __FILE__ ) . '/views/html-notice-updating.php'; - } else { - include dirname( __FILE__ ) . '/views/html-notice-update.php'; - } - } else { - include dirname( __FILE__ ) . '/views/html-notice-updated.php'; - } - } - - /** - * If we have just installed, show a message with the install pages button. - * - * @deprecated 4.6.0 - */ - public static function install_notice() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', __( 'Onboarding is maintained in WooCommerce Admin.', 'woocommerce' ) ); - } - - /** - * 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() . '/' . WC()->template_path() . $file ) ) { - $theme_file = get_stylesheet_directory() . '/' . WC()->template_path() . $file; - } elseif ( file_exists( get_template_directory() . '/' . $file ) ) { - $theme_file = get_template_directory() . '/' . $file; - } elseif ( file_exists( get_template_directory() . '/' . WC()->template_path() . $file ) ) { - $theme_file = get_template_directory() . '/' . WC()->template_path() . $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 dirname( __FILE__ ) . '/views/html-notice-template-check.php'; - } else { - self::remove_notice( 'template_files' ); - } - } - - /** - * Show a notice asking users to convert to shipping zones. - * - * @todo remove in 4.0.0 - */ - 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 dirname( __FILE__ ) . '/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'] ) ) { // WPCS: input var ok, CSRF ok. - $product_count = wp_count_posts( 'product' ); - $method_count = wc_get_shipping_method_count(); - - if ( $product_count->publish > 0 && 0 === $method_count ) { - include dirname( __FILE__ ) . '/views/html-notice-no-shipping-methods.php'; - } - - if ( $method_count > 0 ) { - self::remove_notice( 'no_shipping_methods' ); - } - } - } - - /** - * Notice shown when regenerating thumbnails background process is running. - */ - public static function regenerating_thumbnails_notice() { - include dirname( __FILE__ ) . '/views/html-notice-regenerating-thumbnails.php'; - } - - /** - * Notice about secure connection. - */ - public static function secure_connection_notice() { - if ( self::is_ssl() || get_user_meta( get_current_user_id(), 'dismissed_no_secure_connection_notice', true ) ) { - return; - } - - include dirname( __FILE__ ) . '/views/html-notice-secure-connection.php'; - } - - /** - * Notice shown when regenerating thumbnails background process is running. - * - * @since 3.6.0 - */ - public static function regenerating_lookup_table_notice() { - // See if this is still relevent. - if ( ! wc_update_product_lookup_tables_is_running() ) { - self::remove_notice( 'regenerating_lookup_table' ); - return; - } - - include dirname( __FILE__ ) . '/views/html-notice-regenerating-lookup-table.php'; - } - - /** - * Add notice about minimum PHP and WordPress requirement. - * - * @since 3.6.5 - */ - public static function add_min_version_notice() { - if ( version_compare( phpversion(), WC_NOTICE_MIN_PHP_VERSION, '<' ) || version_compare( get_bloginfo( 'version' ), WC_NOTICE_MIN_WP_VERSION, '<' ) ) { - self::add_notice( WC_PHP_MIN_REQUIREMENTS_NOTICE ); - } - } - - /** - * Notice about WordPress and PHP minimum requirements. - * - * @since 3.6.5 - * @return void - */ - public static function wp_php_min_requirements_notice() { - if ( apply_filters( 'woocommerce_hide_php_wp_nag', get_user_meta( get_current_user_id(), 'dismissed_' . WC_PHP_MIN_REQUIREMENTS_NOTICE . '_notice', true ) ) ) { - self::remove_notice( WC_PHP_MIN_REQUIREMENTS_NOTICE ); - return; - } - - $old_php = version_compare( phpversion(), WC_NOTICE_MIN_PHP_VERSION, '<' ); - $old_wp = version_compare( get_bloginfo( 'version' ), WC_NOTICE_MIN_WP_VERSION, '<' ); - - // Both PHP and WordPress up to date version => no notice. - if ( ! $old_php && ! $old_wp ) { - return; - } - - if ( $old_php && $old_wp ) { - $msg = sprintf( - /* translators: 1: Minimum PHP version 2: Minimum WordPress version */ - __( 'Update required: WooCommerce will soon require PHP version %1$s and WordPress version %2$s or newer.', 'woocommerce' ), - WC_NOTICE_MIN_PHP_VERSION, - WC_NOTICE_MIN_WP_VERSION - ); - } elseif ( $old_php ) { - $msg = sprintf( - /* translators: %s: Minimum PHP version */ - __( 'Update required: WooCommerce will soon require PHP version %s or newer.', 'woocommerce' ), - WC_NOTICE_MIN_PHP_VERSION - ); - } elseif ( $old_wp ) { - $msg = sprintf( - /* translators: %s: Minimum WordPress version */ - __( 'Update required: WooCommerce will soon require WordPress version %s or newer.', 'woocommerce' ), - WC_NOTICE_MIN_WP_VERSION - ); - } - - include dirname( __FILE__ ) . '/views/html-notice-wp-php-minimum-requirements.php'; - } - - /** - * Add MaxMind missing license key notice. - * - * @since 3.9.0 - */ - public static function add_maxmind_missing_license_key_notice() { - $default_address = get_option( 'woocommerce_default_customer_address' ); - - if ( ! in_array( $default_address, array( 'geolocation', 'geolocation_ajax' ), true ) ) { - return; - } - - $integration_options = get_option( 'woocommerce_maxmind_geolocation_settings' ); - if ( empty( $integration_options['license_key'] ) ) { - self::add_notice( 'maxmind_license_key' ); - - } - } - - /** - * Add notice about Redirect-only download method, nudging user to switch to a different method instead. - */ - public static function add_redirect_download_method_notice() { - if ( 'redirect' === get_option( 'woocommerce_file_download_method' ) ) { - self::add_notice( 'redirect_download_method' ); - } else { - self::remove_notice( 'redirect_download_method' ); - } - } - - /** - * Display MaxMind missing license key notice. - * - * @since 3.9.0 - */ - public static function maxmind_missing_license_key_notice() { - $user_dismissed_notice = get_user_meta( get_current_user_id(), 'dismissed_maxmind_license_key_notice', true ); - $filter_dismissed_notice = ! apply_filters( 'woocommerce_maxmind_geolocation_display_notices', true ); - - if ( $user_dismissed_notice || $filter_dismissed_notice ) { - self::remove_notice( 'maxmind_license_key' ); - return; - } - - include dirname( __FILE__ ) . '/views/html-notice-maxmind-license-key.php'; - } - - /** - * Notice about Redirect-Only download method. - * - * @since 4.0 - */ - public static function redirect_download_method_notice() { - if ( apply_filters( 'woocommerce_hide_redirect_method_nag', get_user_meta( get_current_user_id(), 'dismissed_redirect_download_method_notice', true ) ) ) { - self::remove_notice( 'redirect_download_method' ); - return; - } - - include dirname( __FILE__ ) . '/views/html-notice-redirect-only-download.php'; - } - - /** - * Notice about uploads directory begin unprotected. - * - * @since 4.2.0 - */ - public static function uploads_directory_is_unprotected_notice() { - if ( get_user_meta( get_current_user_id(), 'dismissed_uploads_directory_is_unprotected_notice', true ) || self::is_uploads_directory_protected() ) { - self::remove_notice( 'uploads_directory_is_unprotected' ); - return; - } - - include dirname( __FILE__ ) . '/views/html-notice-uploads-directory-is-unprotected.php'; - } - - /** - * Notice about base tables missing. - */ - public static function base_tables_missing_notice() { - $notice_dismissed = apply_filters( - 'woocommerce_hide_base_tables_missing_nag', - get_user_meta( get_current_user_id(), 'dismissed_base_tables_missing_notice', true ) - ); - if ( $notice_dismissed ) { - self::remove_notice( 'base_tables_missing' ); - } - - include dirname( __FILE__ ) . '/views/html-notice-base-table-missing.php'; - } - - /** - * Determine if the store is running SSL. - * - * @return bool Flag SSL enabled. - * @since 3.5.1 - */ - protected static function is_ssl() { - $shop_page = wc_get_page_permalink( 'shop' ); - - return ( is_ssl() && 'https' === substr( $shop_page, 0, 5 ) ); - } - - /** - * Wrapper for is_plugin_active. - * - * @param string $plugin Plugin to check. - * @return boolean - */ - protected static function is_plugin_active( $plugin ) { - if ( ! function_exists( 'is_plugin_active' ) ) { - include_once ABSPATH . 'wp-admin/includes/plugin.php'; - } - return is_plugin_active( $plugin ); - } - - /** - * Simplify Commerce is no longer in core. - * - * @deprecated 3.6.0 No longer shown. - */ - public static function simplify_commerce_notice() { - wc_deprecated_function( 'WC_Admin_Notices::simplify_commerce_notice', '3.6.0' ); - } - - /** - * Show the Theme Check notice. - * - * @deprecated 3.3.0 No longer shown. - */ - public static function theme_check_notice() { - wc_deprecated_function( 'WC_Admin_Notices::theme_check_notice', '3.3.0' ); - } - - /** - * Check if uploads directory is protected. - * - * @since 4.2.0 - * @return bool - */ - protected static function is_uploads_directory_protected() { - $cache_key = '_woocommerce_upload_directory_status'; - $status = get_transient( $cache_key ); - - // Check for cache. - if ( false !== $status ) { - return 'protected' === $status; - } - - // Get only data from the uploads directory. - $uploads = wp_get_upload_dir(); - - // Check for the "uploads/woocommerce_uploads" directory. - $response = wp_safe_remote_get( - esc_url_raw( $uploads['baseurl'] . '/woocommerce_uploads/' ), - array( - 'redirection' => 0, - ) - ); - $response_code = intval( wp_remote_retrieve_response_code( $response ) ); - $response_content = wp_remote_retrieve_body( $response ); - - // Check if returns 200 with empty content in case can open an index.html file, - // and check for non-200 codes in case the directory is protected. - $is_protected = ( 200 === $response_code && empty( $response_content ) ) || ( 200 !== $response_code ); - set_transient( $cache_key, $is_protected ? 'protected' : 'unprotected', 1 * DAY_IN_SECONDS ); - - return $is_protected; - } -} - -WC_Admin_Notices::init(); diff --git a/includes/admin/class-wc-admin-permalink-settings.php b/includes/admin/class-wc-admin-permalink-settings.php deleted file mode 100644 index abcd784d721..00000000000 --- a/includes/admin/class-wc-admin-permalink-settings.php +++ /dev/null @@ -1,217 +0,0 @@ -settings_init(); - $this->settings_save(); - } - - /** - * Init our settings. - */ - public function settings_init() { - add_settings_section( 'woocommerce-permalink', __( 'Product permalinks', 'woocommerce' ), array( $this, 'settings' ), 'permalink' ); - - add_settings_field( - 'woocommerce_product_category_slug', - __( 'Product category base', 'woocommerce' ), - array( $this, 'product_category_slug_input' ), - 'permalink', - 'optional' - ); - add_settings_field( - 'woocommerce_product_tag_slug', - __( 'Product tag base', 'woocommerce' ), - array( $this, 'product_tag_slug_input' ), - 'permalink', - 'optional' - ); - add_settings_field( - 'woocommerce_product_attribute_slug', - __( 'Product attribute base', 'woocommerce' ), - array( $this, 'product_attribute_slug_input' ), - 'permalink', - 'optional' - ); - - $this->permalinks = wc_get_permalink_structure(); - } - - /** - * Show a slug input box. - */ - public function product_category_slug_input() { - ?> - - - - -/attribute-name/attribute/
- shop would make your product links like %sshop/sample-product/. This setting affects product URLs only, not things such as product categories.', 'woocommerce' ), esc_url( home_url( '/' ) ) ) ) );
-
- $shop_page_id = wc_get_page_id( 'shop' );
- $base_slug = urldecode( ( $shop_page_id > 0 && get_post( $shop_page_id ) ) ? get_page_uri( $shop_page_id ) : _x( 'shop', 'default-slug', 'woocommerce' ) );
- $product_base = _x( 'product', 'default-slug', 'woocommerce' );
-
- $structures = array(
- 0 => '',
- 1 => '/' . trailingslashit( $base_slug ),
- 2 => '/' . trailingslashit( $base_slug ) . trailingslashit( '%product_cat%' ),
- );
- ?>
- | - | /?product=sample-product //sample-product/ |
-
|---|---|
| - | //sample-product/ |
-
| - | //product-category/sample-product/ |
-
| - | - - | -
' . esc_html__( 'Give your new product a name here. This is a required field and will be what your customers will see in your store.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'top', - 'align' => 'left', - ), - ), - ), - 'content' => array( - 'target' => '#wp-content-editor-container', - 'next' => 'product-type', - 'next_trigger' => array(), - 'options' => array( - 'content' => '' . esc_html__( 'This is your products main body of content. Here you should describe your product in detail.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'bottom', - 'align' => 'middle', - ), - ), - ), - 'product-type' => array( - 'target' => '#product-type', - 'next' => 'virtual', - 'next_trigger' => array( - 'target' => '#product-type', - 'event' => 'change blur click', - ), - 'options' => array( - 'content' => '' . esc_html__( 'Choose a type for this product. Simple is suitable for most physical goods and services (we recommend setting up a simple product for now).', 'woocommerce' ) . '
' . - '' . esc_html__( 'Variable is for more complex products such as t-shirts with multiple sizes.', 'woocommerce' ) . '
' . - '' . esc_html__( 'Grouped products are for grouping several simple products into one.', 'woocommerce' ) . '
' . - '' . esc_html__( 'Finally, external products are for linking off-site.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'bottom', - 'align' => 'middle', - ), - ), - ), - 'virtual' => array( - 'target' => '#_virtual', - 'next' => 'downloadable', - 'next_trigger' => array( - 'target' => '#_virtual', - 'event' => 'change', - ), - 'options' => array( - 'content' => '' . esc_html__( 'Check the "Virtual" box if this is a non-physical item, for example a service, which does not need shipping.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'bottom', - 'align' => 'middle', - ), - ), - ), - 'downloadable' => array( - 'target' => '#_downloadable', - 'next' => 'regular_price', - 'next_trigger' => array( - 'target' => '#_downloadable', - 'event' => 'change', - ), - 'options' => array( - 'content' => '' . esc_html__( 'If purchasing this product gives a customer access to a downloadable file, e.g. software, check this box.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'bottom', - 'align' => 'middle', - ), - ), - ), - 'regular_price' => array( - 'target' => '#_regular_price', - 'next' => 'postexcerpt', - 'next_trigger' => array( - 'target' => '#_regular_price', - 'event' => 'input', - ), - 'options' => array( - 'content' => '' . esc_html__( 'Next you need to give your product a price.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'bottom', - 'align' => 'middle', - ), - ), - ), - 'postexcerpt' => array( - 'target' => '#postexcerpt', - 'next' => 'postimagediv', - 'next_trigger' => array( - 'target' => '#postexcerpt', - 'event' => 'input', - ), - 'options' => array( - 'content' => '' . esc_html__( 'Add a quick summary for your product here. This will appear on the product page under the product name.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'bottom', - 'align' => 'middle', - ), - ), - ), - 'postimagediv' => array( - 'target' => '#postimagediv', - 'next' => 'product_tag', - 'options' => array( - 'content' => '' . esc_html__( "Upload or assign an image to your product here. This image will be shown in your store's catalog.", 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'right', - 'align' => 'middle', - ), - ), - ), - 'product_tag' => array( - 'target' => '#tagsdiv-product_tag', - 'next' => 'product_catdiv', - 'options' => array( - 'content' => '' . esc_html__( 'You can optionally "tag" your products here. Tags are a method of labeling your products to make them easier for customers to find.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'right', - 'align' => 'middle', - ), - ), - ), - 'product_catdiv' => array( - 'target' => '#product_catdiv', - 'next' => 'submitdiv', - 'options' => array( - 'content' => '' . esc_html__( 'Optionally assign categories to your products to make them easier to browse through and find in your store.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'right', - 'align' => 'middle', - ), - ), - ), - 'submitdiv' => array( - 'target' => '#submitdiv', - 'next' => '', - 'options' => array( - 'content' => '' . esc_html__( 'When you are finished editing your product, hit the "Publish" button to publish your product to your store.', 'woocommerce' ) . '
', - 'position' => array( - 'edge' => 'right', - 'align' => 'middle', - ), - ), - ), - ), - ); - - $this->enqueue_pointers( $pointers ); - } - - /** - * Enqueue pointers and add script to page. - * - * @param array $pointers Pointers data. - */ - public function enqueue_pointers( $pointers ) { - $pointers = rawurlencode( wp_json_encode( $pointers ) ); - wp_enqueue_style( 'wp-pointer' ); - wp_enqueue_script( 'wp-pointer' ); - wc_enqueue_js( - "jQuery( function( $ ) { - var wc_pointers = JSON.parse( decodeURIComponent( '{$pointers}' ) ); - - setTimeout( init_wc_pointers, 800 ); - - function init_wc_pointers() { - $.each( wc_pointers.pointers, function( i ) { - show_wc_pointer( i ); - return false; - }); - } - - function show_wc_pointer( id ) { - var pointer = wc_pointers.pointers[ id ]; - var options = $.extend( pointer.options, { - pointerClass: 'wp-pointer wc-pointer', - close: function() { - if ( pointer.next ) { - show_wc_pointer( pointer.next ); - } - }, - buttons: function( event, t ) { - var close = '" . esc_js( __( 'Dismiss', 'woocommerce' ) ) . "', - next = '" . esc_js( __( 'Next', 'woocommerce' ) ) . "', - button = $( '' + close + '' ), - button2 = $( '' + next + '' ), - wrapper = $( '' ); - - button.bind( 'click.pointer', function(e) { - e.preventDefault(); - t.element.pointer('destroy'); - }); - - button2.bind( 'click.pointer', function(e) { - e.preventDefault(); - t.element.pointer('close'); - }); - - wrapper.append( button ); - wrapper.append( button2 ); - - return wrapper; - }, - } ); - var this_pointer = $( pointer.target ).pointer( options ); - this_pointer.pointer( 'open' ); - - if ( pointer.next_trigger ) { - $( pointer.next_trigger.target ).on( pointer.next_trigger.event, function() { - setTimeout( function() { this_pointer.pointer( 'close' ); }, 400 ); - }); - } - } - });" - ); - } -} - -new WC_Admin_Pointers(); diff --git a/includes/admin/class-wc-admin-post-types.php b/includes/admin/class-wc-admin-post-types.php deleted file mode 100644 index e2d145206a1..00000000000 --- a/includes/admin/class-wc-admin-post-types.php +++ /dev/null @@ -1,992 +0,0 @@ -request_data(); - - $screen_id = false; - - if ( function_exists( 'get_current_screen' ) ) { - $screen = get_current_screen(); - $screen_id = isset( $screen, $screen->id ) ? $screen->id : ''; - } - - if ( ! empty( $request_data['screen'] ) ) { - $screen_id = wc_clean( wp_unslash( $request_data['screen'] ) ); - } - - switch ( $screen_id ) { - case 'edit-shop_order': - include_once __DIR__ . '/list-tables/class-wc-admin-list-table-orders.php'; - $wc_list_table = new WC_Admin_List_Table_Orders(); - break; - case 'edit-shop_coupon': - include_once __DIR__ . '/list-tables/class-wc-admin-list-table-coupons.php'; - $wc_list_table = new WC_Admin_List_Table_Coupons(); - break; - case 'edit-product': - include_once __DIR__ . '/list-tables/class-wc-admin-list-table-products.php'; - $wc_list_table = new WC_Admin_List_Table_Products(); - break; - } - - // Ensure the table handler is only loaded once. Prevents multiple loads if a plugin calls check_ajax_referer many times. - remove_action( 'current_screen', array( $this, 'setup_screen' ) ); - remove_action( 'check_ajax_referer', array( $this, 'setup_screen' ) ); - } - - /** - * Change messages when a post type is updated. - * - * @param array $messages Array of messages. - * @return array - */ - public function post_updated_messages( $messages ) { - global $post; - - $messages['product'] = array( - 0 => '', // Unused. Messages start at index 1. - /* translators: %s: Product view URL. */ - 1 => sprintf( __( 'Product updated. View Product', 'woocommerce' ), esc_url( get_permalink( $post->ID ) ) ), - 2 => __( 'Custom field updated.', 'woocommerce' ), - 3 => __( 'Custom field deleted.', 'woocommerce' ), - 4 => __( 'Product updated.', 'woocommerce' ), - 5 => __( 'Revision restored.', 'woocommerce' ), - /* translators: %s: product url */ - 6 => sprintf( __( 'Product published. View Product', 'woocommerce' ), esc_url( get_permalink( $post->ID ) ) ), - 7 => __( 'Product saved.', 'woocommerce' ), - /* translators: %s: product url */ - 8 => sprintf( __( 'Product submitted. Preview product', 'woocommerce' ), esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) ), - 9 => sprintf( - /* translators: 1: date 2: product url */ - __( 'Product scheduled for: %1$s. Preview product', 'woocommerce' ), - '' . date_i18n( __( 'M j, Y @ G:i', 'woocommerce' ), strtotime( $post->post_date ) ) . '', - esc_url( get_permalink( $post->ID ) ) - ), - /* translators: %s: product url */ - 10 => sprintf( __( 'Product draft updated. Preview product', 'woocommerce' ), esc_url( add_query_arg( 'preview', 'true', get_permalink( $post->ID ) ) ) ), - ); - - $messages['shop_order'] = array( - 0 => '', // Unused. Messages start at index 1. - 1 => __( 'Order updated.', 'woocommerce' ), - 2 => __( 'Custom field updated.', 'woocommerce' ), - 3 => __( 'Custom field deleted.', 'woocommerce' ), - 4 => __( 'Order updated.', 'woocommerce' ), - 5 => __( 'Revision restored.', 'woocommerce' ), - 6 => __( 'Order updated.', 'woocommerce' ), - 7 => __( 'Order saved.', 'woocommerce' ), - 8 => __( 'Order submitted.', 'woocommerce' ), - 9 => sprintf( - /* translators: %s: date */ - __( 'Order scheduled for: %s.', 'woocommerce' ), - '' . date_i18n( __( 'M j, Y @ G:i', 'woocommerce' ), strtotime( $post->post_date ) ) . '' - ), - 10 => __( 'Order draft updated.', 'woocommerce' ), - 11 => __( 'Order updated and sent.', 'woocommerce' ), - ); - - $messages['shop_coupon'] = array( - 0 => '', // Unused. Messages start at index 1. - 1 => __( 'Coupon updated.', 'woocommerce' ), - 2 => __( 'Custom field updated.', 'woocommerce' ), - 3 => __( 'Custom field deleted.', 'woocommerce' ), - 4 => __( 'Coupon updated.', 'woocommerce' ), - 5 => __( 'Revision restored.', 'woocommerce' ), - 6 => __( 'Coupon updated.', 'woocommerce' ), - 7 => __( 'Coupon saved.', 'woocommerce' ), - 8 => __( 'Coupon submitted.', 'woocommerce' ), - 9 => sprintf( - /* translators: %s: date */ - __( 'Coupon scheduled for: %s.', 'woocommerce' ), - '' . date_i18n( __( 'M j, Y @ G:i', 'woocommerce' ), strtotime( $post->post_date ) ) . '' - ), - 10 => __( 'Coupon draft updated.', 'woocommerce' ), - ); - - return $messages; - } - - /** - * Specify custom bulk actions messages for different post types. - * - * @param array $bulk_messages Array of messages. - * @param array $bulk_counts Array of how many objects were updated. - * @return array - */ - public function bulk_post_updated_messages( $bulk_messages, $bulk_counts ) { - $bulk_messages['product'] = array( - /* translators: %s: product count */ - 'updated' => _n( '%s product updated.', '%s products updated.', $bulk_counts['updated'], 'woocommerce' ), - /* translators: %s: product count */ - 'locked' => _n( '%s product not updated, somebody is editing it.', '%s products not updated, somebody is editing them.', $bulk_counts['locked'], 'woocommerce' ), - /* translators: %s: product count */ - 'deleted' => _n( '%s product permanently deleted.', '%s products permanently deleted.', $bulk_counts['deleted'], 'woocommerce' ), - /* translators: %s: product count */ - 'trashed' => _n( '%s product moved to the Trash.', '%s products moved to the Trash.', $bulk_counts['trashed'], 'woocommerce' ), - /* translators: %s: product count */ - 'untrashed' => _n( '%s product restored from the Trash.', '%s products restored from the Trash.', $bulk_counts['untrashed'], 'woocommerce' ), - ); - - $bulk_messages['shop_order'] = array( - /* translators: %s: order count */ - 'updated' => _n( '%s order updated.', '%s orders updated.', $bulk_counts['updated'], 'woocommerce' ), - /* translators: %s: order count */ - 'locked' => _n( '%s order not updated, somebody is editing it.', '%s orders not updated, somebody is editing them.', $bulk_counts['locked'], 'woocommerce' ), - /* translators: %s: order count */ - 'deleted' => _n( '%s order permanently deleted.', '%s orders permanently deleted.', $bulk_counts['deleted'], 'woocommerce' ), - /* translators: %s: order count */ - 'trashed' => _n( '%s order moved to the Trash.', '%s orders moved to the Trash.', $bulk_counts['trashed'], 'woocommerce' ), - /* translators: %s: order count */ - 'untrashed' => _n( '%s order restored from the Trash.', '%s orders restored from the Trash.', $bulk_counts['untrashed'], 'woocommerce' ), - ); - - $bulk_messages['shop_coupon'] = array( - /* translators: %s: coupon count */ - 'updated' => _n( '%s coupon updated.', '%s coupons updated.', $bulk_counts['updated'], 'woocommerce' ), - /* translators: %s: coupon count */ - 'locked' => _n( '%s coupon not updated, somebody is editing it.', '%s coupons not updated, somebody is editing them.', $bulk_counts['locked'], 'woocommerce' ), - /* translators: %s: coupon count */ - 'deleted' => _n( '%s coupon permanently deleted.', '%s coupons permanently deleted.', $bulk_counts['deleted'], 'woocommerce' ), - /* translators: %s: coupon count */ - 'trashed' => _n( '%s coupon moved to the Trash.', '%s coupons moved to the Trash.', $bulk_counts['trashed'], 'woocommerce' ), - /* translators: %s: coupon count */ - 'untrashed' => _n( '%s coupon restored from the Trash.', '%s coupons restored from the Trash.', $bulk_counts['untrashed'], 'woocommerce' ), - ); - - return $bulk_messages; - } - - /** - * Custom bulk edit - form. - * - * @param string $column_name Column being shown. - * @param string $post_type Post type being shown. - */ - public function bulk_edit( $column_name, $post_type ) { - if ( 'price' !== $column_name || 'product' !== $post_type ) { - return; - } - - $shipping_class = get_terms( - 'product_shipping_class', - array( - 'hide_empty' => false, - ) - ); - - include WC()->plugin_path() . '/includes/admin/views/html-bulk-edit-product.php'; - } - - /** - * Custom quick edit - form. - * - * @param string $column_name Column being shown. - * @param string $post_type Post type being shown. - */ - public function quick_edit( $column_name, $post_type ) { - if ( 'price' !== $column_name || 'product' !== $post_type ) { - return; - } - - $shipping_class = get_terms( - 'product_shipping_class', - array( - 'hide_empty' => false, - ) - ); - - include WC()->plugin_path() . '/includes/admin/views/html-quick-edit-product.php'; - } - - /** - * Offers a way to hook into save post without causing an infinite loop - * when quick/bulk saving product info. - * - * @since 3.0.0 - * @param int $post_id Post ID being saved. - * @param object $post Post object being saved. - */ - public function bulk_and_quick_edit_hook( $post_id, $post ) { - remove_action( 'save_post', array( $this, 'bulk_and_quick_edit_hook' ) ); - do_action( 'woocommerce_product_bulk_and_quick_edit', $post_id, $post ); - add_action( 'save_post', array( $this, 'bulk_and_quick_edit_hook' ), 10, 2 ); - } - - /** - * Quick and bulk edit saving. - * - * @param int $post_id Post ID being saved. - * @param object $post Post object being saved. - * @return int - */ - public function bulk_and_quick_edit_save_post( $post_id, $post ) { - $request_data = $this->request_data(); - - // If this is an autosave, our form has not been submitted, so we don't want to do anything. - if ( Constants::is_true( 'DOING_AUTOSAVE' ) ) { - return $post_id; - } - - // Don't save revisions and autosaves. - if ( wp_is_post_revision( $post_id ) || wp_is_post_autosave( $post_id ) || 'product' !== $post->post_type || ! current_user_can( 'edit_post', $post_id ) ) { - return $post_id; - } - - // Check nonce. - // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.ValidatedSanitizedInput.MissingUnslash - if ( ! isset( $request_data['woocommerce_quick_edit_nonce'] ) || ! wp_verify_nonce( $request_data['woocommerce_quick_edit_nonce'], 'woocommerce_quick_edit_nonce' ) ) { - return $post_id; - } - - // Get the product and save. - $product = wc_get_product( $post ); - - if ( ! empty( $request_data['woocommerce_quick_edit'] ) ) { // WPCS: input var ok. - $this->quick_edit_save( $post_id, $product ); - } else { - $this->bulk_edit_save( $post_id, $product ); - } - - return $post_id; - } - - /** - * Quick edit. - * - * @param int $post_id Post ID being saved. - * @param WC_Product $product Product object. - */ - private function quick_edit_save( $post_id, $product ) { - $request_data = $this->request_data(); - - $data_store = $product->get_data_store(); - $old_regular_price = $product->get_regular_price(); - $old_sale_price = $product->get_sale_price(); - $input_to_props = array( - '_weight' => 'weight', - '_length' => 'length', - '_width' => 'width', - '_height' => 'height', - '_visibility' => 'catalog_visibility', - '_tax_class' => 'tax_class', - '_tax_status' => 'tax_status', - ); - - foreach ( $input_to_props as $input_var => $prop ) { - if ( isset( $request_data[ $input_var ] ) ) { - $product->{"set_{$prop}"}( wc_clean( wp_unslash( $request_data[ $input_var ] ) ) ); - } - } - - if ( isset( $request_data['_sku'] ) ) { - $sku = $product->get_sku(); - // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash - $new_sku = (string) wc_clean( $request_data['_sku'] ); - - if ( $new_sku !== $sku ) { - if ( ! empty( $new_sku ) ) { - $unique_sku = wc_product_has_unique_sku( $post_id, $new_sku ); - if ( $unique_sku ) { - $product->set_sku( wc_clean( wp_unslash( $new_sku ) ) ); - } - } else { - $product->set_sku( '' ); - } - } - } - - if ( ! empty( $request_data['_shipping_class'] ) ) { - if ( '_no_shipping_class' === $request_data['_shipping_class'] ) { - $product->set_shipping_class_id( 0 ); - } else { - // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash - $shipping_class_id = $data_store->get_shipping_class_id_by_slug( wc_clean( $request_data['_shipping_class'] ) ); - $product->set_shipping_class_id( $shipping_class_id ); - } - } - - $product->set_featured( isset( $request_data['_featured'] ) ); - - if ( $product->is_type( 'simple' ) || $product->is_type( 'external' ) ) { - - if ( isset( $request_data['_regular_price'] ) ) { - // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash - $new_regular_price = ( '' === $request_data['_regular_price'] ) ? '' : wc_format_decimal( $request_data['_regular_price'] ); - $product->set_regular_price( $new_regular_price ); - } else { - $new_regular_price = null; - } - if ( isset( $request_data['_sale_price'] ) ) { - // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash - $new_sale_price = ( '' === $request_data['_sale_price'] ) ? '' : wc_format_decimal( $request_data['_sale_price'] ); - $product->set_sale_price( $new_sale_price ); - } else { - $new_sale_price = null; - } - - // Handle price - remove dates and set to lowest. - $price_changed = false; - - if ( ! is_null( $new_regular_price ) && $new_regular_price !== $old_regular_price ) { - $price_changed = true; - } elseif ( ! is_null( $new_sale_price ) && $new_sale_price !== $old_sale_price ) { - $price_changed = true; - } - - if ( $price_changed ) { - $product->set_date_on_sale_to( '' ); - $product->set_date_on_sale_from( '' ); - } - } - - // Handle Stock Data. - // phpcs:disable WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - $manage_stock = ! empty( $request_data['_manage_stock'] ) && 'grouped' !== $product->get_type() ? 'yes' : 'no'; - $backorders = ! empty( $request_data['_backorders'] ) ? wc_clean( $request_data['_backorders'] ) : 'no'; - if ( ! empty( $request_data['_stock_status'] ) ) { - $stock_status = wc_clean( $request_data['_stock_status'] ); - } else { - $stock_status = $product->is_type( 'variable' ) ? null : 'instock'; - } - // phpcs:enable WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - - $product->set_manage_stock( $manage_stock ); - $product->set_backorders( $backorders ); - - if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) { - $stock_amount = 'yes' === $manage_stock && isset( $request_data['_stock'] ) && is_numeric( wp_unslash( $request_data['_stock'] ) ) ? wc_stock_amount( wp_unslash( $request_data['_stock'] ) ) : ''; - $product->set_stock_quantity( $stock_amount ); - } - - $product = $this->maybe_update_stock_status( $product, $stock_status ); - - $product->save(); - - do_action( 'woocommerce_product_quick_edit_save', $product ); - } - - /** - * Bulk edit. - * - * @param int $post_id Post ID being saved. - * @param WC_Product $product Product object. - */ - public function bulk_edit_save( $post_id, $product ) { - // phpcs:disable WordPress.Security.ValidatedSanitizedInput.MissingUnslash - - $request_data = $this->request_data(); - - $data_store = $product->get_data_store(); - - if ( ! empty( $request_data['change_weight'] ) && isset( $request_data['_weight'] ) ) { - $product->set_weight( wc_clean( wp_unslash( $request_data['_weight'] ) ) ); - } - - if ( ! empty( $request_data['change_dimensions'] ) ) { - if ( isset( $request_data['_length'] ) ) { - $product->set_length( wc_clean( wp_unslash( $request_data['_length'] ) ) ); - } - if ( isset( $request_data['_width'] ) ) { - $product->set_width( wc_clean( wp_unslash( $request_data['_width'] ) ) ); - } - if ( isset( $request_data['_height'] ) ) { - $product->set_height( wc_clean( wp_unslash( $request_data['_height'] ) ) ); - } - } - - if ( ! empty( $request_data['_tax_status'] ) ) { - $product->set_tax_status( wc_clean( $request_data['_tax_status'] ) ); - } - - if ( ! empty( $request_data['_tax_class'] ) ) { - $tax_class = wc_clean( wp_unslash( $request_data['_tax_class'] ) ); - if ( 'standard' === $tax_class ) { - $tax_class = ''; - } - $product->set_tax_class( $tax_class ); - } - - if ( ! empty( $request_data['_shipping_class'] ) ) { - if ( '_no_shipping_class' === $request_data['_shipping_class'] ) { - $product->set_shipping_class_id( 0 ); - } else { - $shipping_class_id = $data_store->get_shipping_class_id_by_slug( wc_clean( $request_data['_shipping_class'] ) ); - $product->set_shipping_class_id( $shipping_class_id ); - } - } - - if ( ! empty( $request_data['_visibility'] ) ) { - $product->set_catalog_visibility( wc_clean( $request_data['_visibility'] ) ); - } - - if ( ! empty( $request_data['_featured'] ) ) { - // phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - $product->set_featured( wp_unslash( $request_data['_featured'] ) ); - // phpcs:enable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - } - - if ( ! empty( $request_data['_sold_individually'] ) ) { - if ( 'yes' === $request_data['_sold_individually'] ) { - $product->set_sold_individually( 'yes' ); - } else { - $product->set_sold_individually( '' ); - } - } - - // Handle price - remove dates and set to lowest. - $change_price_product_types = apply_filters( 'woocommerce_bulk_edit_save_price_product_types', array( 'simple', 'external' ) ); - $can_product_type_change_price = false; - foreach ( $change_price_product_types as $product_type ) { - if ( $product->is_type( $product_type ) ) { - $can_product_type_change_price = true; - break; - } - } - - if ( $can_product_type_change_price ) { - $regular_price_changed = $this->set_new_price( $product, 'regular' ); - $sale_price_changed = $this->set_new_price( $product, 'sale' ); - - if ( $regular_price_changed || $sale_price_changed ) { - $product->set_date_on_sale_to( '' ); - $product->set_date_on_sale_from( '' ); - - if ( $product->get_regular_price() < $product->get_sale_price() ) { - $product->set_sale_price( '' ); - } - } - } - - // Handle Stock Data. - $was_managing_stock = $product->get_manage_stock() ? 'yes' : 'no'; - $backorders = $product->get_backorders(); - $backorders = ! empty( $request_data['_backorders'] ) ? wc_clean( $request_data['_backorders'] ) : $backorders; - - if ( ! empty( $request_data['_manage_stock'] ) ) { - $manage_stock = 'yes' === wc_clean( $request_data['_manage_stock'] ) && 'grouped' !== $product->get_type() ? 'yes' : 'no'; - } else { - $manage_stock = $was_managing_stock; - } - - $stock_amount = 'yes' === $manage_stock && ! empty( $request_data['change_stock'] ) && isset( $request_data['_stock'] ) ? wc_stock_amount( $request_data['_stock'] ) : $product->get_stock_quantity(); - - $product->set_manage_stock( $manage_stock ); - $product->set_backorders( $backorders ); - - if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) { - $change_stock = absint( $request_data['change_stock'] ); - switch ( $change_stock ) { - case 2: - wc_update_product_stock( $product, $stock_amount, 'increase', true ); - break; - case 3: - wc_update_product_stock( $product, $stock_amount, 'decrease', true ); - break; - default: - wc_update_product_stock( $product, $stock_amount, 'set', true ); - break; - } - } else { - // Reset values if WooCommerce Setting - Manage Stock status is disabled. - $product->set_stock_quantity( '' ); - $product->set_manage_stock( 'no' ); - } - - $stock_status = empty( $request_data['_stock_status'] ) ? null : wc_clean( $request_data['_stock_status'] ); - $product = $this->maybe_update_stock_status( $product, $stock_status ); - - $product->save(); - - do_action( 'woocommerce_product_bulk_edit_save', $product ); - - // phpcs:enable WordPress.Security.ValidatedSanitizedInput.MissingUnslash - } - - /** - * Disable the auto-save functionality for Orders. - */ - public function disable_autosave() { - global $post; - - if ( $post && in_array( get_post_type( $post->ID ), wc_get_order_types( 'order-meta-boxes' ), true ) ) { - wp_dequeue_script( 'autosave' ); - } - } - - /** - * Output extra data on post forms. - * - * @param WP_Post $post Current post object. - */ - public function edit_form_top( $post ) { - echo ''; - } - - /** - * Change title boxes in admin. - * - * @param string $text Text to shown. - * @param WP_Post $post Current post object. - * @return string - */ - public function enter_title_here( $text, $post ) { - switch ( $post->post_type ) { - case 'product': - $text = esc_html__( 'Product name', 'woocommerce' ); - break; - case 'shop_coupon': - $text = esc_html__( 'Coupon code', 'woocommerce' ); - break; - } - return $text; - } - - /** - * Print coupon description textarea field. - * - * @param WP_Post $post Current post object. - */ - public function edit_form_after_title( $post ) { - // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped - if ( 'shop_coupon' === $post->post_type ) { - ?> - - post_type && 'post' === $screen->base ) { - $hidden = array_merge( $hidden, array( 'postcustom' ) ); - } - - return $hidden; - } - - /** - * Output product visibility options. - */ - public function product_data_visibility() { - global $post, $thepostid, $product_object; - - if ( 'product' !== $post->post_type ) { - return; - } - - $thepostid = $post->ID; - $product_object = $thepostid ? wc_get_product( $thepostid ) : new WC_Product(); - $current_visibility = $product_object->get_catalog_visibility(); - $current_featured = wc_bool_to_string( $product_object->get_featured() ); - $visibility_options = wc_get_product_visibility_options(); - ?> -' . sprintf( wp_kses_post( __( 'This is the WooCommerce shop page. The shop page is a special archive that lists your products. You can read more about this here.', 'woocommerce' ) ), 'https://docs.woocommerce.com/document/woocommerce-pages/#section-4' ) . '
'; - echo '| - - | -- - - - ID, $key, true ), 1, true ); ?> /> - - - - - - - | -
|---|
' . esc_html( $error ) . '
' . esc_html( $message ) . '
' . wp_kses_post( $description ) . '
'; - } - - if ( $tooltip_html && in_array( $value['type'], array( 'checkbox' ), true ) ) { - $tooltip_html = '' . $tooltip_html . '
'; - } elseif ( $tooltip_html ) { - $tooltip_html = wc_help_tip( $tooltip_html ); - } - - return array( - 'description' => $description, - 'tooltip_html' => $tooltip_html, - ); - } - - /** - * Save admin fields. - * - * Loops through the woocommerce options array and outputs each field. - * - * @param array $options Options array to output. - * @param array $data Optional. Data to use for saving. Defaults to $_POST. - * @return bool - */ - public static function save_fields( $options, $data = null ) { - if ( is_null( $data ) ) { - $data = $_POST; // WPCS: input var okay, CSRF ok. - } - if ( empty( $data ) ) { - return false; - } - - // Options to update will be stored here and saved later. - $update_options = array(); - $autoload_options = array(); - - // Loop options and get values to save. - foreach ( $options as $option ) { - if ( ! isset( $option['id'] ) || ! isset( $option['type'] ) || ( isset( $option['is_option'] ) && false === $option['is_option'] ) ) { - continue; - } - - // Get posted value. - if ( strstr( $option['id'], '[' ) ) { - parse_str( $option['id'], $option_name_array ); - $option_name = current( array_keys( $option_name_array ) ); - $setting_name = key( $option_name_array[ $option_name ] ); - $raw_value = isset( $data[ $option_name ][ $setting_name ] ) ? wp_unslash( $data[ $option_name ][ $setting_name ] ) : null; - } else { - $option_name = $option['id']; - $setting_name = ''; - $raw_value = isset( $data[ $option['id'] ] ) ? wp_unslash( $data[ $option['id'] ] ) : null; - } - - // Format the value based on option type. - switch ( $option['type'] ) { - case 'checkbox': - $value = '1' === $raw_value || 'yes' === $raw_value ? 'yes' : 'no'; - break; - case 'textarea': - $value = wp_kses_post( trim( $raw_value ) ); - break; - case 'multiselect': - case 'multi_select_countries': - $value = array_filter( array_map( 'wc_clean', (array) $raw_value ) ); - break; - case 'image_width': - $value = array(); - if ( isset( $raw_value['width'] ) ) { - $value['width'] = wc_clean( $raw_value['width'] ); - $value['height'] = wc_clean( $raw_value['height'] ); - $value['crop'] = isset( $raw_value['crop'] ) ? 1 : 0; - } else { - $value['width'] = $option['default']['width']; - $value['height'] = $option['default']['height']; - $value['crop'] = $option['default']['crop']; - } - break; - case 'select': - $allowed_values = empty( $option['options'] ) ? array() : array_map( 'strval', array_keys( $option['options'] ) ); - if ( empty( $option['default'] ) && empty( $allowed_values ) ) { - $value = null; - break; - } - $default = ( empty( $option['default'] ) ? $allowed_values[0] : $option['default'] ); - $value = in_array( $raw_value, $allowed_values, true ) ? $raw_value : $default; - break; - case 'relative_date_selector': - $value = wc_parse_relative_date_option( $raw_value ); - break; - default: - $value = wc_clean( $raw_value ); - break; - } - - /** - * Fire an action when a certain 'type' of field is being saved. - * - * @deprecated 2.4.0 - doesn't allow manipulation of values! - */ - if ( has_action( 'woocommerce_update_option_' . sanitize_title( $option['type'] ) ) ) { - wc_deprecated_function( 'The woocommerce_update_option_X action', '2.4.0', 'woocommerce_admin_settings_sanitize_option filter' ); - do_action( 'woocommerce_update_option_' . sanitize_title( $option['type'] ), $option ); - continue; - } - - /** - * Sanitize the value of an option. - * - * @since 2.4.0 - */ - $value = apply_filters( 'woocommerce_admin_settings_sanitize_option', $value, $option, $raw_value ); - - /** - * Sanitize the value of an option by option name. - * - * @since 2.4.0 - */ - $value = apply_filters( "woocommerce_admin_settings_sanitize_option_$option_name", $value, $option, $raw_value ); - - if ( is_null( $value ) ) { - continue; - } - - // Check if option is an array and handle that differently to single values. - if ( $option_name && $setting_name ) { - if ( ! isset( $update_options[ $option_name ] ) ) { - $update_options[ $option_name ] = get_option( $option_name, array() ); - } - if ( ! is_array( $update_options[ $option_name ] ) ) { - $update_options[ $option_name ] = array(); - } - $update_options[ $option_name ][ $setting_name ] = $value; - } else { - $update_options[ $option_name ] = $value; - } - - $autoload_options[ $option_name ] = isset( $option['autoload'] ) ? (bool) $option['autoload'] : true; - - /** - * Fire an action before saved. - * - * @deprecated 2.4.0 - doesn't allow manipulation of values! - */ - do_action( 'woocommerce_update_option', $option ); - } - - // Save all options in our array. - foreach ( $update_options as $name => $value ) { - update_option( $name, $value, $autoload_options[ $name ] ? 'yes' : 'no' ); - } - - return true; - } - - /** - * Checks which method we're using to serve downloads. - * - * If using force or x-sendfile, this ensures the .htaccess is in place. - */ - public static function check_download_folder_protection() { - $upload_dir = wp_get_upload_dir(); - $downloads_path = $upload_dir['basedir'] . '/woocommerce_uploads'; - $download_method = get_option( 'woocommerce_file_download_method' ); - $file_path = $downloads_path . '/.htaccess'; - $file_content = 'redirect' === $download_method ? 'Options -Indexes' : 'deny from all'; - $create = false; - - if ( wp_mkdir_p( $downloads_path ) && ! file_exists( $file_path ) ) { - $create = true; - } else { - $current_content = @file_get_contents( $file_path ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents - - if ( $current_content !== $file_content ) { - unlink( $file_path ); - $create = true; - } - } - - if ( $create ) { - $file_handle = @fopen( $file_path, 'wb' ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_system_read_fopen - if ( $file_handle ) { - fwrite( $file_handle, $file_content ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fwrite - fclose( $file_handle ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fclose - } - } - } - } - -endif; diff --git a/includes/admin/class-wc-admin-setup-wizard.php b/includes/admin/class-wc-admin-setup-wizard.php deleted file mode 100644 index 14c11081d8c..00000000000 --- a/includes/admin/class-wc-admin-setup-wizard.php +++ /dev/null @@ -1,2306 +0,0 @@ -countries->get_base_country(); - // https://developers.taxjar.com/api/reference/#countries . - $tax_supported_countries = array_merge( - array( 'US', 'CA', 'AU' ), - WC()->countries->get_european_union_countries() - ); - - return in_array( $country_code, $tax_supported_countries, true ); - } - - /** - * Should we show the MailChimp install option? - * True only if the user can install plugins. - * - * @deprecated 4.6.0 - * @return boolean - */ - protected function should_show_mailchimp() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - return current_user_can( 'install_plugins' ); - } - - /** - * Should we show the Facebook install option? - * True only if the user can install plugins, - * and up until the end date of the recommendation. - * - * @deprecated 4.6.0 - * @return boolean - */ - protected function should_show_facebook() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - return current_user_can( 'install_plugins' ); - } - - /** - * Is the WooCommerce Admin actively included in the WooCommerce core? - * Based on presence of a basic WC Admin function. - * - * @deprecated 4.6.0 - * @return boolean - */ - protected function is_wc_admin_active() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - return function_exists( 'wc_admin_url' ); - } - - /** - * Should we show the WooCommerce Admin install option? - * True only if the user can install plugins, - * and is running the correct version of WordPress. - * - * @see WC_Admin_Setup_Wizard::$wc_admin_plugin_minimum_wordpress_version - * - * @deprecated 4.6.0 - * @return boolean - */ - protected function should_show_wc_admin() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - $wordpress_minimum_met = version_compare( get_bloginfo( 'version' ), $this->wc_admin_plugin_minimum_wordpress_version, '>=' ); - return current_user_can( 'install_plugins' ) && $wordpress_minimum_met && ! $this->is_wc_admin_active(); - } - - /** - * Should we show the new WooCommerce Admin onboarding experience? - * - * @deprecated 4.6.0 - * @return boolean - */ - protected function should_show_wc_admin_onboarding() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - // As of WooCommerce 4.1, all new sites should use the latest OBW from wc-admin package. - // This filter will allow for forcing the old wizard while we migrate e2e tests. - return ! apply_filters( 'woocommerce_setup_wizard_force_legacy', false ); - } - - /** - * Should we display the 'Recommended' step? - * True if at least one of the recommendations will be displayed. - * - * @deprecated 4.6.0 - * @return boolean - */ - protected function should_show_recommended_step() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - return $this->should_show_theme() - || $this->should_show_automated_tax() - || $this->should_show_mailchimp() - || $this->should_show_facebook() - || $this->should_show_wc_admin(); - } - - /** - * Register/enqueue scripts and styles for the Setup Wizard. - * - * Hooked onto 'admin_enqueue_scripts'. - * - * @deprecated 4.6.0 - */ - public function enqueue_scripts() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - } - - /** - * Show the setup wizard. - * - * @deprecated 4.6.0 - */ - public function setup_wizard() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - if ( empty( $_GET['page'] ) || 'wc-setup' !== $_GET['page'] ) { // WPCS: CSRF ok, input var ok. - return; - } - $default_steps = array( - 'new_onboarding' => array( - 'name' => '', - 'view' => array( $this, 'wc_setup_new_onboarding' ), - 'handler' => array( $this, 'wc_setup_new_onboarding_save' ), - ), - 'store_setup' => array( - 'name' => __( 'Store setup', 'woocommerce' ), - 'view' => array( $this, 'wc_setup_store_setup' ), - 'handler' => array( $this, 'wc_setup_store_setup_save' ), - ), - 'payment' => array( - 'name' => __( 'Payment', 'woocommerce' ), - 'view' => array( $this, 'wc_setup_payment' ), - 'handler' => array( $this, 'wc_setup_payment_save' ), - ), - 'shipping' => array( - 'name' => __( 'Shipping', 'woocommerce' ), - 'view' => array( $this, 'wc_setup_shipping' ), - 'handler' => array( $this, 'wc_setup_shipping_save' ), - ), - 'recommended' => array( - 'name' => __( 'Recommended', 'woocommerce' ), - 'view' => array( $this, 'wc_setup_recommended' ), - 'handler' => array( $this, 'wc_setup_recommended_save' ), - ), - 'activate' => array( - 'name' => __( 'Activate', 'woocommerce' ), - 'view' => array( $this, 'wc_setup_activate' ), - 'handler' => array( $this, 'wc_setup_activate_save' ), - ), - 'next_steps' => array( - 'name' => __( 'Ready!', 'woocommerce' ), - 'view' => array( $this, 'wc_setup_ready' ), - 'handler' => '', - ), - ); - - // Hide the new/improved onboarding experience screen if the user is not part of the a/b test. - if ( ! $this->should_show_wc_admin_onboarding() ) { - unset( $default_steps['new_onboarding'] ); - } - - // Hide recommended step if nothing is going to be shown there. - if ( ! $this->should_show_recommended_step() ) { - unset( $default_steps['recommended'] ); - } - - // Hide shipping step if the store is selling digital products only. - if ( 'virtual' === get_option( 'woocommerce_product_type' ) ) { - unset( $default_steps['shipping'] ); - } - - // Hide activate section when the user does not have capabilities to install plugins, think multiside admins not being a super admin. - if ( ! current_user_can( 'install_plugins' ) ) { - unset( $default_steps['activate'] ); - } - - $this->steps = apply_filters( 'woocommerce_setup_wizard_steps', $default_steps ); - $this->step = isset( $_GET['step'] ) ? sanitize_key( $_GET['step'] ) : current( array_keys( $this->steps ) ); // WPCS: CSRF ok, input var ok. - - // @codingStandardsIgnoreStart - if ( ! empty( $_POST['save_step'] ) && isset( $this->steps[ $this->step ]['handler'] ) ) { - call_user_func( $this->steps[ $this->step ]['handler'], $this ); - } - // @codingStandardsIgnoreEnd - - ob_start(); - $this->setup_wizard_header(); - $this->setup_wizard_steps(); - $this->setup_wizard_content(); - $this->setup_wizard_footer(); - exit; - } - - /** - * Get the URL for the next step's screen. - * - * @param string $step slug (default: current step). - * @return string URL for next step if a next step exists. - * Admin URL if it's the last step. - * Empty string on failure. - * - * @deprecated 4.6.0 - * @since 3.0.0 - */ - public function get_next_step_link( $step = '' ) { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - if ( ! $step ) { - $step = $this->step; - } - - $keys = array_keys( $this->steps ); - if ( end( $keys ) === $step ) { - return admin_url(); - } - - $step_index = array_search( $step, $keys, true ); - if ( false === $step_index ) { - return ''; - } - - return add_query_arg( 'step', $keys[ $step_index + 1 ], remove_query_arg( 'activate_error' ) ); - } - - /** - * Setup Wizard Header. - * - * @deprecated 4.6.0 - */ - public function setup_wizard_header() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - // same as default WP from wp-admin/admin-header.php. - $wp_version_class = 'branch-' . str_replace( array( '.', ',' ), '-', floatval( get_bloginfo( 'version' ) ) ); - - set_current_screen(); - ?> - - > - - - -->plugin_url() ); ?>/assets/images/woocommerce_logo.png){kind=logo}
- -
- -- -
- -' . sprintf( - /* translators: %s: URL */ - __( 'Accept debit and credit cards in 135+ currencies, methods such as Alipay, and one-touch checkout with Apple Pay. Learn more.', 'woocommerce' ), - 'https://woocommerce.com/products/stripe/' - ) . '
'; - $paypal_checkout_description = '' . sprintf( - /* translators: %s: URL */ - __( 'Safe and secure payments using credit cards or your customer\'s PayPal account. Learn more.', 'woocommerce' ), - 'https://woocommerce.com/products/woocommerce-gateway-paypal-checkout/' - ) . '
'; - $klarna_checkout_description = '' . sprintf( - /* translators: %s: URL */ - __( 'Full checkout experience with pay now, pay later and slice it. No credit card numbers, no passwords, no worries. Learn more about Klarna.', 'woocommerce' ), - 'https://woocommerce.com/products/klarna-checkout/' - ) . '
'; - $klarna_payments_description = '' . sprintf( - /* translators: %s: URL */ - __( 'Choose the payment that you want, pay now, pay later or slice it. No credit card numbers, no passwords, no worries. Learn more about Klarna.', 'woocommerce' ), - 'https://woocommerce.com/products/klarna-payments/ ' - ) . '
'; - $square_description = '' . sprintf( - /* translators: %s: URL */ - __( 'Securely accept credit and debit cards with one low rate, no surprise fees (custom rates available). Sell online and in store and track sales and inventory in one place. Learn more about Square.', 'woocommerce' ), - 'https://woocommerce.com/products/square/' - ) . '
'; - - return array( - 'stripe' => array( - 'name' => __( 'WooCommerce Stripe Gateway', 'woocommerce' ), - 'image' => WC()->plugin_url() . '/assets/images/stripe.png', - 'description' => $stripe_description, - 'class' => 'checked stripe-logo', - 'repo-slug' => 'woocommerce-gateway-stripe', - 'settings' => array( - 'create_account' => array( - 'label' => __( 'Set up Stripe for me using this email:', 'woocommerce' ), - 'type' => 'checkbox', - 'value' => 'yes', - 'default' => 'yes', - 'placeholder' => '', - 'required' => false, - 'plugins' => $this->get_wcs_requisite_plugins(), - ), - 'email' => array( - 'label' => __( 'Stripe email address:', 'woocommerce' ), - 'type' => 'email', - 'value' => $user_email, - 'placeholder' => __( 'Stripe email address', 'woocommerce' ), - 'required' => true, - ), - ), - ), - 'ppec_paypal' => array( - 'name' => __( 'WooCommerce PayPal Checkout Gateway', 'woocommerce' ), - 'image' => WC()->plugin_url() . '/assets/images/paypal.png', - 'description' => $paypal_checkout_description, - 'enabled' => false, - 'class' => 'checked paypal-logo', - 'repo-slug' => 'woocommerce-gateway-paypal-express-checkout', - 'settings' => array( - 'reroute_requests' => array( - 'label' => __( 'Set up PayPal for me using this email:', 'woocommerce' ), - 'type' => 'checkbox', - 'value' => 'yes', - 'default' => 'yes', - 'placeholder' => '', - 'required' => false, - 'plugins' => $this->get_wcs_requisite_plugins(), - ), - 'email' => array( - 'label' => __( 'Direct payments to email address:', 'woocommerce' ), - 'type' => 'email', - 'value' => $user_email, - 'placeholder' => __( 'Email address to receive payments', 'woocommerce' ), - 'required' => true, - ), - ), - ), - 'paypal' => array( - 'name' => __( 'PayPal Standard', 'woocommerce' ), - 'description' => __( 'Accept payments via PayPal using account balance or credit card.', 'woocommerce' ), - 'image' => '', - 'settings' => array( - 'email' => array( - 'label' => __( 'PayPal email address:', 'woocommerce' ), - 'type' => 'email', - 'value' => $user_email, - 'placeholder' => __( 'PayPal email address', 'woocommerce' ), - 'required' => true, - ), - ), - ), - 'klarna_checkout' => array( - 'name' => __( 'Klarna Checkout for WooCommerce', 'woocommerce' ), - 'description' => $klarna_checkout_description, - 'image' => WC()->plugin_url() . '/assets/images/klarna-black.png', - 'enabled' => true, - 'class' => 'klarna-logo', - 'repo-slug' => 'klarna-checkout-for-woocommerce', - ), - 'klarna_payments' => array( - 'name' => __( 'Klarna Payments for WooCommerce', 'woocommerce' ), - 'description' => $klarna_payments_description, - 'image' => WC()->plugin_url() . '/assets/images/klarna-black.png', - 'enabled' => true, - 'class' => 'klarna-logo', - 'repo-slug' => 'klarna-payments-for-woocommerce', - ), - 'square' => array( - 'name' => __( 'WooCommerce Square', 'woocommerce' ), - 'description' => $square_description, - 'image' => WC()->plugin_url() . '/assets/images/square-black.png', - 'class' => 'square-logo', - 'enabled' => false, - 'repo-slug' => 'woocommerce-square', - ), - 'eway' => array( - 'name' => __( 'WooCommerce eWAY Gateway', 'woocommerce' ), - 'description' => __( 'The eWAY extension for WooCommerce allows you to take credit card payments directly on your store without redirecting your customers to a third party site to make payment.', 'woocommerce' ), - 'image' => WC()->plugin_url() . '/assets/images/eway-logo.jpg', - 'enabled' => false, - 'class' => 'eway-logo', - 'repo-slug' => 'woocommerce-gateway-eway', - ), - 'payfast' => array( - 'name' => __( 'WooCommerce PayFast Gateway', 'woocommerce' ), - 'description' => __( 'The PayFast extension for WooCommerce enables you to accept payments by Credit Card and EFT via one of South Africa’s most popular payment gateways. No setup fees or monthly subscription costs.', 'woocommerce' ), - 'image' => WC()->plugin_url() . '/assets/images/payfast.png', - 'class' => 'payfast-logo', - 'enabled' => false, - 'repo-slug' => 'woocommerce-payfast-gateway', - 'file' => 'gateway-payfast.php', - ), - ); - } - - /** - * Simple array of "in cart" gateways to show in wizard. - * - * @deprecated 4.6.0 - * @return array - */ - public function get_wizard_in_cart_payment_gateways() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - $gateways = $this->get_wizard_available_in_cart_payment_gateways(); - $country = WC()->countries->get_base_country(); - $currency = get_woocommerce_currency(); - - $can_stripe = $this->is_stripe_supported_country( $country ); - $can_eway = $this->is_eway_payments_supported_country( $country ); - $can_payfast = ( 'ZA' === $country ); // South Africa. - $can_paypal = $this->is_paypal_supported_currency( $currency ); - - if ( ! current_user_can( 'install_plugins' ) ) { - return $can_paypal ? array( 'paypal' => $gateways['paypal'] ) : array(); - } - - $klarna_or_square = false; - - if ( $this->is_klarna_checkout_supported_country( $country ) ) { - $klarna_or_square = 'klarna_checkout'; - } elseif ( $this->is_klarna_payments_supported_country( $country ) ) { - $klarna_or_square = 'klarna_payments'; - } elseif ( $this->is_square_supported_country( $country ) && get_option( 'woocommerce_sell_in_person' ) ) { - $klarna_or_square = 'square'; - } - - $offered_gateways = array(); - - if ( $can_stripe ) { - $gateways['stripe']['enabled'] = true; - $gateways['stripe']['featured'] = true; - $offered_gateways += array( 'stripe' => $gateways['stripe'] ); - } elseif ( $can_paypal ) { - $gateways['ppec_paypal']['enabled'] = true; - } - - if ( $klarna_or_square ) { - if ( in_array( $klarna_or_square, array( 'klarna_checkout', 'klarna_payments' ), true ) ) { - $gateways[ $klarna_or_square ]['enabled'] = true; - $gateways[ $klarna_or_square ]['featured'] = false; - $offered_gateways += array( - $klarna_or_square => $gateways[ $klarna_or_square ], - ); - } else { - $offered_gateways += array( - $klarna_or_square => $gateways[ $klarna_or_square ], - ); - } - } - - if ( $can_paypal ) { - $offered_gateways += array( 'ppec_paypal' => $gateways['ppec_paypal'] ); - } - - if ( $can_eway ) { - $offered_gateways += array( 'eway' => $gateways['eway'] ); - } - - if ( $can_payfast ) { - $offered_gateways += array( 'payfast' => $gateways['payfast'] ); - } - - return $offered_gateways; - } - - /** - * Simple array of "manual" gateways to show in wizard. - * - * @deprecated 4.6.0 - * @return array - */ - public function get_wizard_manual_payment_gateways() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - $gateways = array( - 'cheque' => array( - 'name' => _x( 'Check payments', 'Check payment method', 'woocommerce' ), - 'description' => __( 'A simple offline gateway that lets you accept a check as method of payment.', 'woocommerce' ), - 'image' => '', - 'class' => '', - ), - 'bacs' => array( - 'name' => __( 'Bank transfer (BACS) payments', 'woocommerce' ), - 'description' => __( 'A simple offline gateway that lets you accept BACS payment.', 'woocommerce' ), - 'image' => '', - 'class' => '', - ), - 'cod' => array( - 'name' => __( 'Cash on delivery', 'woocommerce' ), - 'description' => __( 'A simple offline gateway that lets you accept cash on delivery.', 'woocommerce' ), - 'image' => '', - 'class' => '', - ), - ); - - return $gateways; - } - - /** - * Display service item in list. - * - * @param int $item_id Item ID. - * @param array $item_info Item info array. - * - * @deprecated 4.6.0 - */ - public function display_service_item( $item_id, $item_info ) { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - $item_class = 'wc-wizard-service-item'; - if ( isset( $item_info['class'] ) ) { - $item_class .= ' ' . $item_info['class']; - } - - $previously_saved_settings = get_option( 'woocommerce_' . $item_id . '_settings' ); - - // Show the user-saved state if it was previously saved. - // Otherwise, rely on the item info. - if ( is_array( $previously_saved_settings ) ) { - $should_enable_toggle = ( isset( $previously_saved_settings['enabled'] ) && 'yes' === $previously_saved_settings['enabled'] ) ? true : ( isset( $item_info['enabled'] ) && $item_info['enabled'] ); - } else { - $should_enable_toggle = isset( $item_info['enabled'] ) && $item_info['enabled']; - } - - $plugins = null; - if ( isset( $item_info['repo-slug'] ) ) { - $plugin = array( - 'slug' => $item_info['repo-slug'], - 'name' => $item_info['name'], - ); - $plugins = array( $plugin ); - } - - ?> -- -
- - get_next_step_link() ) ) ); - exit; - } - } - - /** - * - * @deprecated 4.6.0 - */ - protected function wc_setup_activate_get_feature_list() { - $features = array(); - - $stripe_settings = get_option( 'woocommerce_stripe_settings', false ); - $stripe_enabled = is_array( $stripe_settings ) - && isset( $stripe_settings['create_account'] ) && 'yes' === $stripe_settings['create_account'] - && isset( $stripe_settings['enabled'] ) && 'yes' === $stripe_settings['enabled']; - $ppec_settings = get_option( 'woocommerce_ppec_paypal_settings', false ); - $ppec_enabled = is_array( $ppec_settings ) - && isset( $ppec_settings['reroute_requests'] ) && 'yes' === $ppec_settings['reroute_requests'] - && isset( $ppec_settings['enabled'] ) && 'yes' === $ppec_settings['enabled']; - - $features['payment'] = $stripe_enabled || $ppec_enabled; - $features['taxes'] = (bool) get_option( 'woocommerce_setup_automated_taxes', false ); - $features['labels'] = (bool) get_option( 'woocommerce_setup_shipping_labels', false ); - - return $features; - } - - /** - * - * @deprecated 4.6.0 - */ - protected function wc_setup_activate_get_feature_list_str() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - $features = $this->wc_setup_activate_get_feature_list(); - if ( $features['payment'] && $features['taxes'] && $features['labels'] ) { - return __( 'payment setup, automated taxes and discounted shipping labels', 'woocommerce' ); - } else if ( $features['payment'] && $features['taxes'] ) { - return __( 'payment setup and automated taxes', 'woocommerce' ); - } else if ( $features['payment'] && $features['labels'] ) { - return __( 'payment setup and discounted shipping labels', 'woocommerce' ); - } else if ( $features['payment'] ) { - return __( 'payment setup', 'woocommerce' ); - } else if ( $features['taxes'] && $features['labels'] ) { - return __( 'automated taxes and discounted shipping labels', 'woocommerce' ); - } else if ( $features['taxes'] ) { - return __( 'automated taxes', 'woocommerce' ); - } else if ( $features['labels'] ) { - return __( 'discounted shipping labels', 'woocommerce' ); - } - return false; - } - - /** - * Activate step. - * - * @deprecated 4.6.0 - */ - public function wc_setup_activate() { - _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '4.6.0', 'Onboarding is maintained in WooCommerce Admin.' ); - $this->wc_setup_activate_actions(); - - $jetpack_connected = class_exists( 'Jetpack' ) && Jetpack::is_active(); - - $has_jetpack_error = false; - if ( isset( $_GET['activate_error'] ) ) { - $has_jetpack_error = true; - - $title = __( "Sorry, we couldn't connect your store to Jetpack", 'woocommerce' ); - - $error_message = $this->get_activate_error_message( sanitize_text_field( wp_unslash( $_GET['activate_error'] ) ) ); - $description = $error_message; - } else { - $feature_list = $this->wc_setup_activate_get_feature_list_str(); - - $description = false; - - if ( $feature_list ) { - if ( ! $jetpack_connected ) { - /* translators: %s: list of features, potentially comma separated */ - $description_base = __( 'Your store is almost ready! To activate services like %s, just connect with Jetpack.', 'woocommerce' ); - } else { - $description_base = __( 'Thanks for using Jetpack! Your store is almost ready: to activate services like %s, just connect your store.', 'woocommerce' ); - } - $description = sprintf( $description_base, $feature_list ); - } - - if ( ! $jetpack_connected ) { - $title = $feature_list ? - __( 'Connect your store to Jetpack', 'woocommerce' ) : - __( 'Connect your store to Jetpack to enable extra features', 'woocommerce' ); - $button_text = __( 'Continue with Jetpack', 'woocommerce' ); - } elseif ( $feature_list ) { - $title = __( 'Connect your store to activate WooCommerce Services', 'woocommerce' ); - $button_text = __( 'Continue with WooCommerce Services', 'woocommerce' ); - } else { - wp_redirect( esc_url_raw( $this->get_next_step_link() ) ); - exit; - } - } - ?> - - - - -->plugin_url() . '/assets/images/jetpack_horizontal_logo.png' ); ?>){kind=logo}
- ->plugin_url() . '/assets/images/wcs-notice.png' ); ?>)
- ->plugin_url() . '/assets/images/jetpack_vertical_logo.png' ); ?>){kind=logo}
-
-
-
- - - - -
- -- Terms of Service and to share details with WordPress.com', 'woocommerce' ) ), - 'https://wordpress.com/tos', - 'https://jetpack.com/support/what-data-does-jetpack-sync' - ); - ?> -
- - -- -
-- -
-- -
-- -
-- -
-- -
-- -
-- -
-' . esc_html( $response['message'] ) . '
' . esc_html( $response['message'] ) . '
' . esc_html__( 'Your changes have been saved.', 'woocommerce' ) . '
-
- ' . esc_html( $category_name ) . ''
- );
- ?>
-
'; - echo ''; - echo ''; - submit_button( - $text, - '', - '', - false, - array( - 'id' => 'search-submit', - ) - ); - echo '
'; - } - - /** - * Prepare table list items. - */ - public function prepare_items() { - $per_page = $this->get_items_per_page( 'woocommerce_webhooks_per_page' ); - $current_page = $this->get_pagenum(); - - // Query args. - $args = array( - 'limit' => $per_page, - 'offset' => $per_page * ( $current_page - 1 ), - ); - - // Handle the status query. - if ( ! empty( $_REQUEST['status'] ) ) { // WPCS: input var okay, CSRF ok. - $args['status'] = sanitize_key( wp_unslash( $_REQUEST['status'] ) ); // WPCS: input var okay, CSRF ok. - } - - if ( ! empty( $_REQUEST['s'] ) ) { // WPCS: input var okay, CSRF ok. - $args['search'] = sanitize_text_field( wp_unslash( $_REQUEST['s'] ) ); // WPCS: input var okay, CSRF ok. - } - - $args['paginate'] = true; - - // Get the webhooks. - $data_store = WC_Data_Store::load( 'webhook' ); - $webhooks = $data_store->search_webhooks( $args ); - $this->items = array_map( 'wc_get_webhook', $webhooks->webhooks ); - - // Set the pagination. - $this->set_pagination_args( - array( - 'total_items' => $webhooks->total, - 'per_page' => $per_page, - 'total_pages' => $webhooks->max_num_pages, - ) - ); - } -} diff --git a/includes/admin/class-wc-admin.php b/includes/admin/class-wc-admin.php deleted file mode 100644 index e136974d539..00000000000 --- a/includes/admin/class-wc-admin.php +++ /dev/null @@ -1,311 +0,0 @@ -id ) { - case 'dashboard': - case 'dashboard-network': - include __DIR__ . '/class-wc-admin-dashboard.php'; - break; - case 'options-permalink': - include __DIR__ . '/class-wc-admin-permalink-settings.php'; - break; - case 'plugins': - include __DIR__ . '/plugin-updates/class-wc-plugins-screen-updates.php'; - break; - case 'update-core': - include __DIR__ . '/plugin-updates/class-wc-updates-screen-updates.php'; - break; - case 'users': - case 'user': - case 'profile': - case 'user-edit': - include __DIR__ . '/class-wc-admin-profile.php'; - break; - } - } - - /** - * Handle redirects to setup/welcome page after install and updates. - * - * 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, as it would clear _wc_activation_redirect transient. - // That means OBW would never be shown. - if ( wc_is_running_from_async_action_scheduler() ) { - return; - } - - // 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 ); - } else { - $url = admin_url( 'plugin-install.php?tab=search&type=term&s=' . $plugin_slug ); - } - - wp_safe_redirect( $url ); - exit; - } - - // phpcs:enable WordPress.Security.NonceVerification.Recommended - } - - /** - * Prevent any user who cannot 'edit_posts' (subscribers, customers etc) from accessing admin. - */ - public function prevent_admin_access() { - $prevent_access = false; - - if ( apply_filters( 'woocommerce_disable_admin_bar', true ) && ! is_ajax() && isset( $_SERVER['SCRIPT_FILENAME'] ) && basename( sanitize_text_field( wp_unslash( $_SERVER['SCRIPT_FILENAME'] ) ) ) !== 'admin-post.php' ) { - $has_cap = false; - $access_caps = array( 'edit_posts', 'manage_woocommerce', 'view_admin_dashboard' ); - - foreach ( $access_caps as $access_cap ) { - if ( current_user_can( $access_cap ) ) { - $has_cap = true; - break; - } - } - - if ( ! $has_cap ) { - $prevent_access = true; - } - } - - if ( apply_filters( 'woocommerce_prevent_admin_access', $prevent_access ) ) { - wp_safe_redirect( wc_get_page_permalink( 'myaccount' ) ); - exit; - } - } - - /** - * 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' ) ) ) { - die( 'Security check' ); - } - - // load the mailer class. - $mailer = WC()->mailer(); - - // get the preview email subject. - $email_heading = __( 'HTML email template', 'woocommerce' ); - - // get the preview email content. - ob_start(); - include __DIR__ . '/views/html-email-template-preview.php'; - $message = ob_get_clean(); - - // create a new email. - $email = new WC_Email(); - - // wrap the content with the email template and then add styles. - $message = apply_filters( 'woocommerce_mail_content', $email->style_inline( $mailer->wrap_message( $email_heading, $message ) ) ); - - // print the preview email. - // phpcs:ignore WordPress.Security.EscapeOutput - echo $message; - // phpcs:enable - exit; - } - } - - /** - * Change the admin footer text on WooCommerce admin pages. - * - * @since 2.3 - * @param string $footer_text text to be rendered in the footer. - * @return string - */ - public function admin_footer_text( $footer_text ) { - if ( ! current_user_can( 'manage_woocommerce' ) || ! function_exists( 'wc_get_screen_ids' ) ) { - return $footer_text; - } - $current_screen = get_current_screen(); - $wc_pages = wc_get_screen_ids(); - - // Set only WC pages. - $wc_pages = array_diff( $wc_pages, array( 'profile', 'user-edit' ) ); - - // Check to make sure we're on a WooCommerce admin page. - 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' ) ) { - $footer_text = sprintf( - /* 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( '%s', esc_html__( 'WooCommerce', 'woocommerce' ) ), - '★★★★★' - ); - wc_enqueue_js( - "jQuery( 'a.wc-rating-link' ).on( 'click', function() { - jQuery.post( '" . WC()->ajax_url() . "', { action: 'woocommerce_rated' } ); - jQuery( this ).parent().text( jQuery( this ).data( 'rated' ) ); - });" - ); - } else { - $footer_text = __( 'Thank you for selling with WooCommerce.', 'woocommerce' ); - } - } - - return $footer_text; - } - - /** - * 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' ); - - wp_send_json_success( - array( - 'is_active' => $jetpack_active ? 'yes' : 'no', - ) - ); - } - - /** - * Disable WXR export of scheduled action posts. - * - * @since 3.6.2 - * - * @param array $args Scehduled action post type registration args. - * - * @return array - */ - public function disable_webhook_post_export( $args ) { - $args['can_export'] = false; - return $args; - } - - /** - * Include admin classes. - * - * @since 4.2.0 - * @param string $classes Body classes string. - * @return 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 ) ) { - return $classes; - } - - $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'; - } - - return $classes; - } -} - -return new WC_Admin(); diff --git a/includes/admin/helper/class-wc-helper.php b/includes/admin/helper/class-wc-helper.php deleted file mode 100644 index 6fb43c27fa2..00000000000 --- a/includes/admin/helper/class-wc-helper.php +++ /dev/null @@ -1,1641 +0,0 @@ - 'wc-addons', - 'section' => 'helper', - 'wc-helper-connect' => 1, - 'wc-helper-nonce' => wp_create_nonce( 'connect' ), - ), - admin_url( 'admin.php' ) - ); - - include self::get_view_filename( 'html-oauth-start.php' ); - return; - } - $disconnect_url = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'wc-helper-disconnect' => 1, - 'wc-helper-nonce' => wp_create_nonce( 'disconnect' ), - ), - admin_url( 'admin.php' ) - ); - - $current_filter = self::get_current_filter(); - $refresh_url = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'filter' => $current_filter, - 'wc-helper-refresh' => 1, - 'wc-helper-nonce' => wp_create_nonce( 'refresh' ), - ), - admin_url( 'admin.php' ) - ); - - // Installed plugins and themes, with or without an active subscription. - $woo_plugins = self::get_local_woo_plugins(); - $woo_themes = self::get_local_woo_themes(); - - $site_id = absint( $auth['site_id'] ); - $subscriptions = self::get_subscriptions(); - $updates = WC_Helper_Updater::get_update_data(); - $subscriptions_product_ids = wp_list_pluck( $subscriptions, 'product_id' ); - - foreach ( $subscriptions as &$subscription ) { - $subscription['active'] = in_array( $site_id, $subscription['connections'] ); - - $subscription['activate_url'] = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'filter' => $current_filter, - 'wc-helper-activate' => 1, - 'wc-helper-product-key' => $subscription['product_key'], - 'wc-helper-product-id' => $subscription['product_id'], - 'wc-helper-nonce' => wp_create_nonce( 'activate:' . $subscription['product_key'] ), - ), - admin_url( 'admin.php' ) - ); - - $subscription['deactivate_url'] = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'filter' => $current_filter, - 'wc-helper-deactivate' => 1, - 'wc-helper-product-key' => $subscription['product_key'], - 'wc-helper-product-id' => $subscription['product_id'], - 'wc-helper-nonce' => wp_create_nonce( 'deactivate:' . $subscription['product_key'] ), - ), - admin_url( 'admin.php' ) - ); - - $subscription['local'] = array( - 'installed' => false, - 'active' => false, - 'version' => null, - ); - - $subscription['update_url'] = admin_url( 'update-core.php' ); - - $local = wp_list_filter( array_merge( $woo_plugins, $woo_themes ), array( '_product_id' => $subscription['product_id'] ) ); - - if ( ! empty( $local ) ) { - $local = array_shift( $local ); - $subscription['local']['installed'] = true; - $subscription['local']['version'] = $local['Version']; - - if ( 'plugin' == $local['_type'] ) { - if ( is_plugin_active( $local['_filename'] ) ) { - $subscription['local']['active'] = true; - } elseif ( is_multisite() && is_plugin_active_for_network( $local['_filename'] ) ) { - $subscription['local']['active'] = true; - } - - // A magic update_url. - $subscription['update_url'] = wp_nonce_url( self_admin_url( 'update.php?action=upgrade-plugin&plugin=' ) . $local['_filename'], 'upgrade-plugin_' . $local['_filename'] ); - - } elseif ( 'theme' == $local['_type'] ) { - if ( in_array( $local['_stylesheet'], array( get_stylesheet(), get_template() ) ) ) { - $subscription['local']['active'] = true; - } - - // Another magic update_url. - $subscription['update_url'] = wp_nonce_url( self_admin_url( 'update.php?action=upgrade-theme&theme=' . $local['_stylesheet'] ), 'upgrade-theme_' . $local['_stylesheet'] ); - } - } - - $subscription['has_update'] = false; - if ( $subscription['local']['installed'] && ! empty( $updates[ $subscription['product_id'] ] ) ) { - $subscription['has_update'] = version_compare( $updates[ $subscription['product_id'] ]['version'], $subscription['local']['version'], '>' ); - } - - $subscription['download_primary'] = true; - $subscription['download_url'] = 'https://woocommerce.com/my-account/downloads/'; - if ( ! $subscription['local']['installed'] && ! empty( $updates[ $subscription['product_id'] ] ) ) { - $subscription['download_url'] = $updates[ $subscription['product_id'] ]['package']; - } - - $subscription['actions'] = array(); - - if ( $subscription['has_update'] && ! $subscription['expired'] ) { - $action = array( - /* translators: %s: version number */ - 'message' => sprintf( __( 'Version %s is available.', 'woocommerce' ), esc_html( $updates[ $subscription['product_id'] ]['version'] ) ), - 'button_label' => __( 'Update', 'woocommerce' ), - 'button_url' => $subscription['update_url'], - 'status' => 'update-available', - 'icon' => 'dashicons-update', - ); - - // Subscription is not active on this site. - if ( ! $subscription['active'] ) { - $action['message'] .= ' ' . __( 'To enable this update you need to activate this subscription.', 'woocommerce' ); - $action['button_label'] = null; - $action['button_url'] = null; - } - - $subscription['actions'][] = $action; - } - - if ( $subscription['has_update'] && $subscription['expired'] ) { - $action = array( - /* translators: %s: version number */ - 'message' => sprintf( __( 'Version %s is available.', 'woocommerce' ), esc_html( $updates[ $subscription['product_id'] ]['version'] ) ), - 'status' => 'expired', - 'icon' => 'dashicons-info', - ); - - $action['message'] .= ' ' . __( 'To enable this update you need to purchase a new subscription.', 'woocommerce' ); - $action['button_label'] = __( 'Purchase', 'woocommerce' ); - $action['button_url'] = $subscription['product_url']; - - $subscription['actions'][] = $action; - } elseif ( $subscription['expired'] && ! empty( $subscription['master_user_email'] ) ) { - $action = array( - 'message' => sprintf( __( 'This subscription has expired. Contact the owner to renew the subscription to receive updates and support.', 'woocommerce' ) ), - 'status' => 'expired', - 'icon' => 'dashicons-info', - ); - - $subscription['actions'][] = $action; - } elseif ( $subscription['expired'] ) { - $action = array( - 'message' => sprintf( __( 'This subscription has expired. Please renew to receive updates and support.', 'woocommerce' ) ), - 'button_label' => __( 'Renew', 'woocommerce' ), - 'button_url' => 'https://woocommerce.com/my-account/my-subscriptions/', - 'status' => 'expired', - 'icon' => 'dashicons-info', - ); - - $subscription['actions'][] = $action; - } - - if ( $subscription['expiring'] && ! $subscription['autorenew'] ) { - $action = array( - 'message' => __( 'Subscription is expiring soon.', 'woocommerce' ), - 'button_label' => __( 'Enable auto-renew', 'woocommerce' ), - 'button_url' => 'https://woocommerce.com/my-account/my-subscriptions/', - 'status' => 'expired', - 'icon' => 'dashicons-info', - ); - - $subscription['download_primary'] = false; - $subscription['actions'][] = $action; - } elseif ( $subscription['expiring'] ) { - $action = array( - 'message' => sprintf( __( 'This subscription is expiring soon. Please renew to continue receiving updates and support.', 'woocommerce' ) ), - 'button_label' => __( 'Renew', 'woocommerce' ), - 'button_url' => 'https://woocommerce.com/my-account/my-subscriptions/', - 'status' => 'expired', - 'icon' => 'dashicons-info', - ); - - $subscription['download_primary'] = false; - $subscription['actions'][] = $action; - } - - // Mark the first action primary. - foreach ( $subscription['actions'] as $key => $action ) { - if ( ! empty( $action['button_label'] ) ) { - $subscription['actions'][ $key ]['primary'] = true; - break; - } - } - } - - // Break the by-ref. - unset( $subscription ); - - // Installed products without a subscription. - $no_subscriptions = array(); - foreach ( array_merge( $woo_plugins, $woo_themes ) as $filename => $data ) { - if ( in_array( $data['_product_id'], $subscriptions_product_ids ) ) { - continue; - } - - $data['_product_url'] = '#'; - $data['_has_update'] = false; - - if ( ! empty( $updates[ $data['_product_id'] ] ) ) { - $data['_has_update'] = version_compare( $updates[ $data['_product_id'] ]['version'], $data['Version'], '>' ); - - if ( ! empty( $updates[ $data['_product_id'] ]['url'] ) ) { - $data['_product_url'] = $updates[ $data['_product_id'] ]['url']; - } elseif ( ! empty( $data['PluginURI'] ) ) { - $data['_product_url'] = $data['PluginURI']; - } - } - - $data['_actions'] = array(); - - if ( $data['_has_update'] ) { - $action = array( - /* translators: %s: version number */ - 'message' => sprintf( __( 'Version %s is available. To enable this update you need to purchase a new subscription.', 'woocommerce' ), esc_html( $updates[ $data['_product_id'] ]['version'] ) ), - 'button_label' => __( 'Purchase', 'woocommerce' ), - 'button_url' => $data['_product_url'], - 'status' => 'expired', - 'icon' => 'dashicons-info', - ); - - $data['_actions'][] = $action; - } else { - $action = array( - /* translators: 1: subscriptions docs 2: subscriptions docs */ - 'message' => sprintf( __( 'To receive updates and support for this extension, you need to purchase a new subscription or consolidate your extensions to one connected account by sharing or transferring this extension to this connected account.', 'woocommerce' ), 'https://docs.woocommerce.com/document/managing-woocommerce-com-subscriptions/#section-10', 'https://docs.woocommerce.com/document/managing-woocommerce-com-subscriptions/#section-5' ), - 'button_label' => __( 'Purchase', 'woocommerce' ), - 'button_url' => $data['_product_url'], - 'status' => 'expired', - 'icon' => 'dashicons-info', - ); - - $data['_actions'][] = $action; - } - - $no_subscriptions[ $filename ] = $data; - } - - // Update the user id if it came from a migrated connection. - if ( empty( $auth['user_id'] ) ) { - $auth['user_id'] = get_current_user_id(); - WC_Helper_Options::update( 'auth', $auth ); - } - - // Sort alphabetically. - uasort( $subscriptions, array( __CLASS__, '_sort_by_product_name' ) ); - uasort( $no_subscriptions, array( __CLASS__, '_sort_by_name' ) ); - - // Filters. - self::get_filters_counts( $subscriptions ); // Warm it up. - self::_filter( $subscriptions, self::get_current_filter() ); - - // We have an active connection. - include self::get_view_filename( 'html-main.php' ); - return; - } - - /** - * Get available subscriptions filters. - * - * @return array An array of filter keys and labels. - */ - public static function get_filters() { - $filters = array( - 'all' => __( 'All', 'woocommerce' ), - 'active' => __( 'Active', 'woocommerce' ), - 'inactive' => __( 'Inactive', 'woocommerce' ), - 'installed' => __( 'Installed', 'woocommerce' ), - 'update-available' => __( 'Update Available', 'woocommerce' ), - 'expiring' => __( 'Expiring Soon', 'woocommerce' ), - 'expired' => __( 'Expired', 'woocommerce' ), - 'download' => __( 'Download', 'woocommerce' ), - ); - - return $filters; - } - - /** - * Get counts data for the filters array. - * - * @param array $subscriptions The array of all available subscriptions. - * - * @return array Filter counts (filter => count). - */ - public static function get_filters_counts( $subscriptions = null ) { - static $filters; - - if ( isset( $filters ) ) { - return $filters; - } - - $filters = array_fill_keys( array_keys( self::get_filters() ), 0 ); - if ( empty( $subscriptions ) ) { - return array(); - } - - foreach ( $filters as $key => $count ) { - $_subs = $subscriptions; - self::_filter( $_subs, $key ); - $filters[ $key ] = count( $_subs ); - } - - return $filters; - } - - /** - * Get current filter. - * - * @return string The current filter. - */ - public static function get_current_filter() { - $current_filter = 'all'; - $valid_filters = array_keys( self::get_filters() ); - - if ( ! empty( $_GET['filter'] ) && in_array( wp_unslash( $_GET['filter'] ), $valid_filters ) ) { - $current_filter = wc_clean( wp_unslash( $_GET['filter'] ) ); - } - - return $current_filter; - } - - /** - * Filter an array of subscriptions by $filter. - * - * @param array $subscriptions The subscriptions array, passed by ref. - * @param string $filter The filter. - */ - private static function _filter( &$subscriptions, $filter ) { - switch ( $filter ) { - case 'active': - $subscriptions = wp_list_filter( $subscriptions, array( 'active' => true ) ); - break; - - case 'inactive': - $subscriptions = wp_list_filter( $subscriptions, array( 'active' => false ) ); - break; - - case 'installed': - foreach ( $subscriptions as $key => $subscription ) { - if ( empty( $subscription['local']['installed'] ) ) { - unset( $subscriptions[ $key ] ); - } - } - break; - - case 'update-available': - $subscriptions = wp_list_filter( $subscriptions, array( 'has_update' => true ) ); - break; - - case 'expiring': - $subscriptions = wp_list_filter( $subscriptions, array( 'expiring' => true ) ); - break; - - case 'expired': - $subscriptions = wp_list_filter( $subscriptions, array( 'expired' => true ) ); - break; - - case 'download': - foreach ( $subscriptions as $key => $subscription ) { - if ( $subscription['local']['installed'] || $subscription['expired'] ) { - unset( $subscriptions[ $key ] ); - } - } - break; - } - } - - /** - * Enqueue admin scripts and styles. - */ - public static function admin_enqueue_scripts() { - $screen = get_current_screen(); - $screen_id = $screen ? $screen->id : ''; - $wc_screen_id = sanitize_title( __( 'WooCommerce', 'woocommerce' ) ); - - if ( $wc_screen_id . '_page_wc-addons' === $screen_id && isset( $_GET['section'] ) && 'helper' === $_GET['section'] ) { - wp_enqueue_style( 'woocommerce-helper', WC()->plugin_url() . '/assets/css/helper.css', array(), Constants::get_constant( 'WC_VERSION' ) ); - wp_style_add_data( 'woocommerce-helper', 'rtl', 'replace' ); - } - } - - /** - * Various success/error notices. - * - * Runs during admin page render, so no headers/redirects here. - * - * @return array Array pairs of message/type strings with notices. - */ - private static function _get_return_notices() { - $return_status = isset( $_GET['wc-helper-status'] ) ? wc_clean( wp_unslash( $_GET['wc-helper-status'] ) ) : null; - $notices = array(); - - switch ( $return_status ) { - case 'activate-success': - $product_id = isset( $_GET['wc-helper-product-id'] ) ? absint( $_GET['wc-helper-product-id'] ) : 0; - $subscription = self::_get_subscriptions_from_product_id( $product_id ); - $notices[] = array( - 'type' => 'updated', - 'message' => sprintf( - /* translators: %s: product name */ - __( '%s activated successfully. You will now receive updates for this product.', 'woocommerce' ), - '' . esc_html( $subscription['product_name'] ) . '' - ), - ); - break; - - case 'activate-error': - $product_id = isset( $_GET['wc-helper-product-id'] ) ? absint( $_GET['wc-helper-product-id'] ) : 0; - $subscription = self::_get_subscriptions_from_product_id( $product_id ); - $notices[] = array( - 'type' => 'error', - 'message' => sprintf( - /* translators: %s: product name */ - __( 'An error has occurred when activating %s. Please try again later.', 'woocommerce' ), - '' . esc_html( $subscription['product_name'] ) . '' - ), - ); - break; - - case 'deactivate-success': - $product_id = isset( $_GET['wc-helper-product-id'] ) ? absint( $_GET['wc-helper-product-id'] ) : 0; - $subscription = self::_get_subscriptions_from_product_id( $product_id ); - $local = self::_get_local_from_product_id( $product_id ); - - $message = sprintf( - /* translators: %s: product name */ - __( 'Subscription for %s deactivated successfully. You will no longer receive updates for this product.', 'woocommerce' ), - '' . esc_html( $subscription['product_name'] ) . '' - ); - - if ( $local && is_plugin_active( $local['_filename'] ) && current_user_can( 'activate_plugins' ) ) { - $deactivate_plugin_url = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'filter' => self::get_current_filter(), - 'wc-helper-deactivate-plugin' => 1, - 'wc-helper-product-id' => $subscription['product_id'], - 'wc-helper-nonce' => wp_create_nonce( 'deactivate-plugin:' . $subscription['product_id'] ), - ), - admin_url( 'admin.php' ) - ); - - $message = sprintf( - /* translators: %1$s: product name, %2$s: deactivate url */ - __( 'Subscription for %1$s deactivated successfully. You will no longer receive updates for this product. Click here if you wish to deactivate the plugin as well.', 'woocommerce' ), - '' . esc_html( $subscription['product_name'] ) . '', - esc_url( $deactivate_plugin_url ) - ); - } - - $notices[] = array( - 'message' => $message, - 'type' => 'updated', - ); - break; - - case 'deactivate-error': - $product_id = isset( $_GET['wc-helper-product-id'] ) ? absint( $_GET['wc-helper-product-id'] ) : 0; - $subscription = self::_get_subscriptions_from_product_id( $product_id ); - $notices[] = array( - 'type' => 'error', - 'message' => sprintf( - /* translators: %s: product name */ - __( 'An error has occurred when deactivating the subscription for %s. Please try again later.', 'woocommerce' ), - '' . esc_html( $subscription['product_name'] ) . '' - ), - ); - break; - - case 'deactivate-plugin-success': - $product_id = isset( $_GET['wc-helper-product-id'] ) ? absint( $_GET['wc-helper-product-id'] ) : 0; - $subscription = self::_get_subscriptions_from_product_id( $product_id ); - $notices[] = array( - 'type' => 'updated', - 'message' => sprintf( - /* translators: %s: product name */ - __( 'The extension %s has been deactivated successfully.', 'woocommerce' ), - '' . esc_html( $subscription['product_name'] ) . '' - ), - ); - break; - - case 'deactivate-plugin-error': - $product_id = isset( $_GET['wc-helper-product-id'] ) ? absint( $_GET['wc-helper-product-id'] ) : 0; - $subscription = self::_get_subscriptions_from_product_id( $product_id ); - $notices[] = array( - 'type' => 'error', - 'message' => sprintf( - /* translators: %1$s: product name, %2$s: plugins screen url */ - __( 'An error has occurred when deactivating the extension %1$s. Please proceed to the Plugins screen to deactivate it manually.', 'woocommerce' ), - '' . esc_html( $subscription['product_name'] ) . '', - admin_url( 'plugins.php' ) - ), - ); - break; - - case 'helper-connected': - $notices[] = array( - 'message' => __( 'You have successfully connected your store to WooCommerce.com', 'woocommerce' ), - 'type' => 'updated', - ); - break; - - case 'helper-disconnected': - $notices[] = array( - 'message' => __( 'You have successfully disconnected your store from WooCommerce.com', 'woocommerce' ), - 'type' => 'updated', - ); - break; - - case 'helper-refreshed': - $notices[] = array( - 'message' => __( 'Authentication and subscription caches refreshed successfully.', 'woocommerce' ), - 'type' => 'updated', - ); - break; - } - - return $notices; - } - - /** - * Various early-phase actions with possible redirects. - * - * @param object $screen WP screen object. - */ - public static function current_screen( $screen ) { - $wc_screen_id = sanitize_title( __( 'WooCommerce', 'woocommerce' ) ); - - if ( $wc_screen_id . '_page_wc-addons' !== $screen->id ) { - return; - } - - if ( empty( $_GET['section'] ) || 'helper' !== $_GET['section'] ) { - return; - } - - if ( ! empty( $_GET['wc-helper-connect'] ) ) { - return self::_helper_auth_connect(); - } - - if ( ! empty( $_GET['wc-helper-return'] ) ) { - return self::_helper_auth_return(); - } - - if ( ! empty( $_GET['wc-helper-disconnect'] ) ) { - return self::_helper_auth_disconnect(); - } - - if ( ! empty( $_GET['wc-helper-refresh'] ) ) { - return self::_helper_auth_refresh(); - } - - if ( ! empty( $_GET['wc-helper-activate'] ) ) { - return self::_helper_subscription_activate(); - } - - if ( ! empty( $_GET['wc-helper-deactivate'] ) ) { - return self::_helper_subscription_deactivate(); - } - - if ( ! empty( $_GET['wc-helper-deactivate-plugin'] ) ) { - return self::_helper_plugin_deactivate(); - } - } - - /** - * Initiate a new OAuth connection. - */ - private static function _helper_auth_connect() { - if ( empty( $_GET['wc-helper-nonce'] ) || ! wp_verify_nonce( wp_unslash( $_GET['wc-helper-nonce'] ), 'connect' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - self::log( 'Could not verify nonce in _helper_auth_connect' ); - wp_die( 'Could not verify nonce' ); - } - - $redirect_uri = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'wc-helper-return' => 1, - 'wc-helper-nonce' => wp_create_nonce( 'connect' ), - ), - admin_url( 'admin.php' ) - ); - - $request = WC_Helper_API::post( - 'oauth/request_token', - array( - 'body' => array( - 'home_url' => home_url(), - 'redirect_uri' => $redirect_uri, - ), - ) - ); - - $code = wp_remote_retrieve_response_code( $request ); - - if ( 200 !== $code ) { - self::log( sprintf( 'Call to oauth/request_token returned a non-200 response code (%d)', $code ) ); - wp_die( 'Something went wrong' ); - } - - $secret = json_decode( wp_remote_retrieve_body( $request ) ); - if ( empty( $secret ) ) { - self::log( sprintf( 'Call to oauth/request_token returned an invalid body: %s', wp_remote_retrieve_body( $request ) ) ); - wp_die( 'Something went wrong' ); - } - - /** - * Fires when the Helper connection process is initiated. - */ - do_action( 'woocommerce_helper_connect_start' ); - - $connect_url = add_query_arg( - array( - 'home_url' => rawurlencode( home_url() ), - 'redirect_uri' => rawurlencode( $redirect_uri ), - 'secret' => rawurlencode( $secret ), - ), - WC_Helper_API::url( 'oauth/authorize' ) - ); - - wp_redirect( esc_url_raw( $connect_url ) ); - die(); - } - - /** - * Return from WooCommerce.com OAuth flow. - */ - private static function _helper_auth_return() { - if ( empty( $_GET['wc-helper-nonce'] ) || ! wp_verify_nonce( wp_unslash( $_GET['wc-helper-nonce'] ), 'connect' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - self::log( 'Could not verify nonce in _helper_auth_return' ); - wp_die( 'Something went wrong' ); - } - - // Bail if the user clicked deny. - if ( ! empty( $_GET['deny'] ) ) { - /** - * Fires when the Helper connection process is denied/cancelled. - */ - do_action( 'woocommerce_helper_denied' ); - wp_safe_redirect( admin_url( 'admin.php?page=wc-addons§ion=helper' ) ); - die(); - } - - // We do need a request token... - if ( empty( $_GET['request_token'] ) ) { - self::log( 'Request token not found in _helper_auth_return' ); - wp_die( 'Something went wrong' ); - } - - // Obtain an access token. - $request = WC_Helper_API::post( - 'oauth/access_token', - array( - 'body' => array( - 'request_token' => wp_unslash( $_GET['request_token'] ), // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - 'home_url' => home_url(), - ), - ) - ); - - $code = wp_remote_retrieve_response_code( $request ); - - if ( 200 !== $code ) { - self::log( sprintf( 'Call to oauth/access_token returned a non-200 response code (%d)', $code ) ); - wp_die( 'Something went wrong' ); - } - - $access_token = json_decode( wp_remote_retrieve_body( $request ), true ); - if ( ! $access_token ) { - self::log( sprintf( 'Call to oauth/access_token returned an invalid body: %s', wp_remote_retrieve_body( $request ) ) ); - wp_die( 'Something went wrong' ); - } - - WC_Helper_Options::update( - 'auth', - array( - 'access_token' => $access_token['access_token'], - 'access_token_secret' => $access_token['access_token_secret'], - 'site_id' => $access_token['site_id'], - 'user_id' => get_current_user_id(), - 'updated' => time(), - ) - ); - - // Obtain the connected user info. - if ( ! self::_flush_authentication_cache() ) { - self::log( 'Could not obtain connected user info in _helper_auth_return' ); - WC_Helper_Options::update( 'auth', array() ); - wp_die( 'Something went wrong.' ); - } - - self::_flush_subscriptions_cache(); - self::_flush_updates_cache(); - - /** - * Fires when the Helper connection process has completed successfully. - */ - do_action( 'woocommerce_helper_connected' ); - - // Enable tracking when connected. - if ( class_exists( 'WC_Tracker' ) ) { - update_option( 'woocommerce_allow_tracking', 'yes' ); - WC_Tracker::send_tracking_data( true ); - } - - // If connecting through in-app purchase, redirects back to WooCommerce.com - // for product installation. - if ( ! empty( $_GET['wccom-install-url'] ) ) { - wp_redirect( wp_unslash( $_GET['wccom-install-url'] ) ); - exit; - } - - wp_safe_redirect( - add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'wc-helper-status' => 'helper-connected', - ), - admin_url( 'admin.php' ) - ) - ); - die(); - } - - /** - * Disconnect from WooCommerce.com, clear OAuth tokens. - */ - private static function _helper_auth_disconnect() { - if ( empty( $_GET['wc-helper-nonce'] ) || ! wp_verify_nonce( wp_unslash( $_GET['wc-helper-nonce'] ), 'disconnect' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - self::log( 'Could not verify nonce in _helper_auth_disconnect' ); - wp_die( 'Could not verify nonce' ); - } - - /** - * Fires when the Helper has been disconnected. - */ - do_action( 'woocommerce_helper_disconnected' ); - - $redirect_uri = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'wc-helper-status' => 'helper-disconnected', - ), - admin_url( 'admin.php' ) - ); - - WC_Helper_API::post( - 'oauth/invalidate_token', - array( - 'authenticated' => true, - ) - ); - - WC_Helper_Options::update( 'auth', array() ); - WC_Helper_Options::update( 'auth_user_data', array() ); - - self::_flush_subscriptions_cache(); - self::_flush_updates_cache(); - - wp_safe_redirect( $redirect_uri ); - die(); - } - - /** - * User hit the Refresh button, clear all caches. - */ - private static function _helper_auth_refresh() { - if ( empty( $_GET['wc-helper-nonce'] ) || ! wp_verify_nonce( wp_unslash( $_GET['wc-helper-nonce'] ), 'refresh' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - self::log( 'Could not verify nonce in _helper_auth_refresh' ); - wp_die( 'Could not verify nonce' ); - } - - /** - * Fires when Helper subscriptions are refreshed. - */ - do_action( 'woocommerce_helper_subscriptions_refresh' ); - - $redirect_uri = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'filter' => self::get_current_filter(), - 'wc-helper-status' => 'helper-refreshed', - ), - admin_url( 'admin.php' ) - ); - - self::_flush_authentication_cache(); - self::_flush_subscriptions_cache(); - self::_flush_updates_cache(); - - wp_safe_redirect( $redirect_uri ); - die(); - } - - /** - * Active a product subscription. - */ - private static function _helper_subscription_activate() { - $product_key = isset( $_GET['wc-helper-product-key'] ) ? wc_clean( wp_unslash( $_GET['wc-helper-product-key'] ) ) : ''; - $product_id = isset( $_GET['wc-helper-product-id'] ) ? absint( $_GET['wc-helper-product-id'] ) : 0; - - if ( empty( $_GET['wc-helper-nonce'] ) || ! wp_verify_nonce( wp_unslash( $_GET['wc-helper-nonce'] ), 'activate:' . $product_key ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - self::log( 'Could not verify nonce in _helper_subscription_activate' ); - wp_die( 'Could not verify nonce' ); - } - - // Activate subscription. - $activation_response = WC_Helper_API::post( - 'activate', - array( - 'authenticated' => true, - 'body' => wp_json_encode( - array( - 'product_key' => $product_key, - ) - ), - ) - ); - - $activated = wp_remote_retrieve_response_code( $activation_response ) === 200; - $body = json_decode( wp_remote_retrieve_body( $activation_response ), true ); - - if ( ! $activated && ! empty( $body['code'] ) && 'already_connected' === $body['code'] ) { - $activated = true; - } - - if ( $activated ) { - /** - * Fires when the Helper activates a product successfully. - * - * @param int $product_id Product ID being activated. - * @param string $product_key Subscription product key. - * @param array $activation_response The response object from wp_safe_remote_request(). - */ - do_action( 'woocommerce_helper_subscription_activate_success', $product_id, $product_key, $activation_response ); - } else { - /** - * Fires when the Helper fails to activate a product. - * - * @param int $product_id Product ID being activated. - * @param string $product_key Subscription product key. - * @param array $activation_response The response object from wp_safe_remote_request(). - */ - do_action( 'woocommerce_helper_subscription_activate_error', $product_id, $product_key, $activation_response ); - } - - // Attempt to activate this plugin. - $local = self::_get_local_from_product_id( $product_id ); - if ( $local && 'plugin' == $local['_type'] && current_user_can( 'activate_plugins' ) && ! is_plugin_active( $local['_filename'] ) ) { - activate_plugin( $local['_filename'] ); - } - - self::_flush_subscriptions_cache(); - self::_flush_updates_cache(); - - $redirect_uri = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'filter' => self::get_current_filter(), - 'wc-helper-status' => $activated ? 'activate-success' : 'activate-error', - 'wc-helper-product-id' => $product_id, - ), - admin_url( 'admin.php' ) - ); - - wp_safe_redirect( $redirect_uri ); - die(); - } - - /** - * Deactivate a product subscription. - */ - private static function _helper_subscription_deactivate() { - $product_key = isset( $_GET['wc-helper-product-key'] ) ? wc_clean( wp_unslash( $_GET['wc-helper-product-key'] ) ) : ''; - $product_id = isset( $_GET['wc-helper-product-id'] ) ? absint( $_GET['wc-helper-product-id'] ) : 0; - - if ( empty( $_GET['wc-helper-nonce'] ) || ! wp_verify_nonce( wp_unslash( $_GET['wc-helper-nonce'] ), 'deactivate:' . $product_key ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - self::log( 'Could not verify nonce in _helper_subscription_deactivate' ); - wp_die( 'Could not verify nonce' ); - } - - $deactivation_response = WC_Helper_API::post( - 'deactivate', - array( - 'authenticated' => true, - 'body' => wp_json_encode( - array( - 'product_key' => $product_key, - ) - ), - ) - ); - - $code = wp_remote_retrieve_response_code( $deactivation_response ); - $deactivated = 200 === $code; - - if ( $deactivated ) { - /** - * Fires when the Helper activates a product successfully. - * - * @param int $product_id Product ID being deactivated. - * @param string $product_key Subscription product key. - * @param array $deactivation_response The response object from wp_safe_remote_request(). - */ - do_action( 'woocommerce_helper_subscription_deactivate_success', $product_id, $product_key, $deactivation_response ); - } else { - self::log( sprintf( 'Deactivate API call returned a non-200 response code (%d)', $code ) ); - - /** - * Fires when the Helper fails to activate a product. - * - * @param int $product_id Product ID being deactivated. - * @param string $product_key Subscription product key. - * @param array $deactivation_response The response object from wp_safe_remote_request(). - */ - do_action( 'woocommerce_helper_subscription_deactivate_error', $product_id, $product_key, $deactivation_response ); - } - - self::_flush_subscriptions_cache(); - - $redirect_uri = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'filter' => self::get_current_filter(), - 'wc-helper-status' => $deactivated ? 'deactivate-success' : 'deactivate-error', - 'wc-helper-product-id' => $product_id, - ), - admin_url( 'admin.php' ) - ); - - wp_safe_redirect( $redirect_uri ); - die(); - } - - /** - * Deactivate a plugin. - */ - private static function _helper_plugin_deactivate() { - $product_id = isset( $_GET['wc-helper-product-id'] ) ? absint( $_GET['wc-helper-product-id'] ) : 0; - $deactivated = false; - - if ( empty( $_GET['wc-helper-nonce'] ) || ! wp_verify_nonce( wp_unslash( $_GET['wc-helper-nonce'] ), 'deactivate-plugin:' . $product_id ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized - self::log( 'Could not verify nonce in _helper_plugin_deactivate' ); - wp_die( 'Could not verify nonce' ); - } - - if ( ! current_user_can( 'activate_plugins' ) ) { - wp_die( 'You are not allowed to manage plugins on this site.' ); - } - - $local = wp_list_filter( - array_merge( - self::get_local_woo_plugins(), - self::get_local_woo_themes() - ), - array( '_product_id' => $product_id ) - ); - - // Attempt to deactivate this plugin or theme. - if ( ! empty( $local ) ) { - $local = array_shift( $local ); - if ( is_plugin_active( $local['_filename'] ) ) { - deactivate_plugins( $local['_filename'] ); - } - - $deactivated = ! is_plugin_active( $local['_filename'] ); - } - - $redirect_uri = add_query_arg( - array( - 'page' => 'wc-addons', - 'section' => 'helper', - 'filter' => self::get_current_filter(), - 'wc-helper-status' => $deactivated ? 'deactivate-plugin-success' : 'deactivate-plugin-error', - 'wc-helper-product-id' => $product_id, - ), - admin_url( 'admin.php' ) - ); - - wp_safe_redirect( $redirect_uri ); - die(); - } - - /** - * Get a local plugin/theme entry from product_id. - * - * @param int $product_id The product id. - * - * @return array|bool The array containing the local plugin/theme data or false. - */ - private static function _get_local_from_product_id( $product_id ) { - $local = wp_list_filter( - array_merge( - self::get_local_woo_plugins(), - self::get_local_woo_themes() - ), - array( '_product_id' => $product_id ) - ); - - if ( ! empty( $local ) ) { - return array_shift( $local ); - } - - return false; - } - - /** - * Checks whether current site has product subscription of a given ID. - * - * @since 3.7.0 - * - * @param int $product_id The product id. - * - * @return bool Returns true if product subscription exists, false otherwise. - */ - public static function has_product_subscription( $product_id ) { - $subscription = self::_get_subscriptions_from_product_id( $product_id, true ); - return ! empty( $subscription ); - } - - /** - * Get a subscription entry from product_id. If multiple subscriptions are - * found with the same product id and $single is set to true, will return the - * first one in the list, so you can use this method to get things like extension - * name, version, etc. - * - * @param int $product_id The product id. - * @param bool $single Whether to return a single subscription or all matching a product id. - * - * @return array|bool The array containing sub data or false. - */ - private static function _get_subscriptions_from_product_id( $product_id, $single = true ) { - $subscriptions = wp_list_filter( self::get_subscriptions(), array( 'product_id' => $product_id ) ); - if ( ! empty( $subscriptions ) ) { - return $single ? array_shift( $subscriptions ) : $subscriptions; - } - - return false; - } - - /** - * Obtain a list of data about locally installed Woo extensions. - */ - public static function get_local_woo_plugins() { - if ( ! function_exists( 'get_plugins' ) ) { - require_once ABSPATH . 'wp-admin/includes/plugin.php'; - } - - $plugins = get_plugins(); - - /** - * Check if plugins have WC headers, if not then clear cache and fetch again. - * WC Headers will not be present if `wc_enable_wc_plugin_headers` hook was added after a `get_plugins` call -- for example when WC is activated/updated. - * Also, get_plugins call is expensive so we should clear this cache very conservatively. - */ - if ( ! empty( $plugins ) && ! array_key_exists( 'Woo', current( $plugins ) ) ) { - wp_clean_plugins_cache( false ); - $plugins = get_plugins(); - } - - $woo_plugins = array(); - - // Backwards compatibility for woothemes_queue_update(). - $_compat = array(); - if ( ! empty( $GLOBALS['woothemes_queued_updates'] ) ) { - foreach ( $GLOBALS['woothemes_queued_updates'] as $_compat_plugin ) { - $_compat[ $_compat_plugin->file ] = array( - 'product_id' => $_compat_plugin->product_id, - 'file_id' => $_compat_plugin->file_id, - ); - } - } - - foreach ( $plugins as $filename => $data ) { - if ( empty( $data['Woo'] ) && ! empty( $_compat[ $filename ] ) ) { - $data['Woo'] = sprintf( '%d:%s', $_compat[ $filename ]['product_id'], $_compat[ $filename ]['file_id'] ); - } - - if ( empty( $data['Woo'] ) ) { - continue; - } - - list( $product_id, $file_id ) = explode( ':', $data['Woo'] ); - if ( empty( $product_id ) || empty( $file_id ) ) { - continue; - } - - $data['_filename'] = $filename; - $data['_product_id'] = absint( $product_id ); - $data['_file_id'] = $file_id; - $data['_type'] = 'plugin'; - $data['slug'] = dirname( $filename ); - $woo_plugins[ $filename ] = $data; - } - - return $woo_plugins; - } - - /** - * Get locally installed Woo themes. - */ - public static function get_local_woo_themes() { - $themes = wp_get_themes(); - $woo_themes = array(); - - foreach ( $themes as $theme ) { - $header = $theme->get( 'Woo' ); - - // Backwards compatibility for theme_info.txt. - if ( ! $header ) { - $txt = $theme->get_stylesheet_directory() . '/theme_info.txt'; - if ( is_readable( $txt ) ) { - $txt = file_get_contents( $txt ); - $txt = preg_split( '#\s#', $txt ); - if ( count( $txt ) >= 2 ) { - $header = sprintf( '%d:%s', $txt[0], $txt[1] ); - } - } - } - - if ( empty( $header ) ) { - continue; - } - - list( $product_id, $file_id ) = explode( ':', $header ); - if ( empty( $product_id ) || empty( $file_id ) ) { - continue; - } - - $data = array( - 'Name' => $theme->get( 'Name' ), - 'Version' => $theme->get( 'Version' ), - 'Woo' => $header, - - '_filename' => $theme->get_stylesheet() . '/style.css', - '_stylesheet' => $theme->get_stylesheet(), - '_product_id' => absint( $product_id ), - '_file_id' => $file_id, - '_type' => 'theme', - ); - - $woo_themes[ $data['_filename'] ] = $data; - } - - return $woo_themes; - } - - /** - * Get the connected user's subscriptions. - * - * @return array - */ - public static function get_subscriptions() { - $cache_key = '_woocommerce_helper_subscriptions'; - $data = get_transient( $cache_key ); - if ( false !== $data ) { - return $data; - } - - // Obtain the connected user info. - $request = WC_Helper_API::get( - 'subscriptions', - array( - 'authenticated' => true, - ) - ); - - if ( wp_remote_retrieve_response_code( $request ) !== 200 ) { - set_transient( $cache_key, array(), 15 * MINUTE_IN_SECONDS ); - return array(); - } - - $data = json_decode( wp_remote_retrieve_body( $request ), true ); - if ( empty( $data ) || ! is_array( $data ) ) { - $data = array(); - } - - set_transient( $cache_key, $data, 1 * HOUR_IN_SECONDS ); - return $data; - } - - /** - * Runs when any plugin is activated. - * - * Depending on the activated plugin attempts to look through available - * subscriptions and auto-activate one if possible, so the user does not - * need to visit the Helper UI at all after installing a new extension. - * - * @param string $filename The filename of the activated plugin. - */ - public static function activated_plugin( $filename ) { - $plugins = self::get_local_woo_plugins(); - - // Not a local woo plugin. - if ( empty( $plugins[ $filename ] ) ) { - return; - } - - // Make sure we have a connection. - $auth = WC_Helper_Options::get( 'auth' ); - if ( empty( $auth ) ) { - return; - } - - $plugin = $plugins[ $filename ]; - $product_id = $plugin['_product_id']; - $subscriptions = self::_get_subscriptions_from_product_id( $product_id, false ); - - // No valid subscriptions for this product. - if ( empty( $subscriptions ) ) { - return; - } - - $subscription = null; - foreach ( $subscriptions as $_sub ) { - - // Don't attempt to activate expired subscriptions. - if ( $_sub['expired'] ) { - continue; - } - - // No more sites available in this subscription. - if ( $_sub['sites_max'] && $_sub['sites_active'] >= $_sub['sites_max'] ) { - continue; - } - - // Looks good. - $subscription = $_sub; - break; - } - - // No valid subscription found. - if ( ! $subscription ) { - return; - } - - $product_key = $subscription['product_key']; - $activation_response = WC_Helper_API::post( - 'activate', - array( - 'authenticated' => true, - 'body' => wp_json_encode( - array( - 'product_key' => $product_key, - ) - ), - ) - ); - - $activated = wp_remote_retrieve_response_code( $activation_response ) === 200; - $body = json_decode( wp_remote_retrieve_body( $activation_response ), true ); - - if ( ! $activated && ! empty( $body['code'] ) && 'already_connected' === $body['code'] ) { - $activated = true; - } - - if ( $activated ) { - self::log( 'Auto-activated a subscription for ' . $filename ); - /** - * Fires when the Helper activates a product successfully. - * - * @param int $product_id Product ID being activated. - * @param string $product_key Subscription product key. - * @param array $activation_response The response object from wp_safe_remote_request(). - */ - do_action( 'woocommerce_helper_subscription_activate_success', $product_id, $product_key, $activation_response ); - } else { - self::log( 'Could not activate a subscription upon plugin activation: ' . $filename ); - - /** - * Fires when the Helper fails to activate a product. - * - * @param int $product_id Product ID being activated. - * @param string $product_key Subscription product key. - * @param array $activation_response The response object from wp_safe_remote_request(). - */ - do_action( 'woocommerce_helper_subscription_activate_error', $product_id, $product_key, $activation_response ); - } - - self::_flush_subscriptions_cache(); - self::_flush_updates_cache(); - } - - /** - * Runs when any plugin is deactivated. - * - * When a user deactivates a plugin, attempt to deactivate any subscriptions - * associated with the extension. - * - * @param string $filename The filename of the deactivated plugin. - */ - public static function deactivated_plugin( $filename ) { - $plugins = self::get_local_woo_plugins(); - - // Not a local woo plugin. - if ( empty( $plugins[ $filename ] ) ) { - return; - } - - // Make sure we have a connection. - $auth = WC_Helper_Options::get( 'auth' ); - if ( empty( $auth ) ) { - return; - } - - $plugin = $plugins[ $filename ]; - $product_id = $plugin['_product_id']; - $subscriptions = self::_get_subscriptions_from_product_id( $product_id, false ); - $site_id = absint( $auth['site_id'] ); - - // No valid subscriptions for this product. - if ( empty( $subscriptions ) ) { - return; - } - - $deactivated = 0; - - foreach ( $subscriptions as $subscription ) { - // Don't touch subscriptions that aren't activated on this site. - if ( ! in_array( $site_id, $subscription['connections'], true ) ) { - continue; - } - - $product_key = $subscription['product_key']; - $deactivation_response = WC_Helper_API::post( - 'deactivate', - array( - 'authenticated' => true, - 'body' => wp_json_encode( - array( - 'product_key' => $product_key, - ) - ), - ) - ); - - if ( wp_remote_retrieve_response_code( $deactivation_response ) === 200 ) { - $deactivated++; - - /** - * Fires when the Helper activates a product successfully. - * - * @param int $product_id Product ID being deactivated. - * @param string $product_key Subscription product key. - * @param array $deactivation_response The response object from wp_safe_remote_request(). - */ - do_action( 'woocommerce_helper_subscription_deactivate_success', $product_id, $product_key, $deactivation_response ); - } else { - /** - * Fires when the Helper fails to activate a product. - * - * @param int $product_id Product ID being deactivated. - * @param string $product_key Subscription product key. - * @param array $deactivation_response The response object from wp_safe_remote_request(). - */ - do_action( 'woocommerce_helper_subscription_deactivate_error', $product_id, $product_key, $deactivation_response ); - } - } - - if ( $deactivated ) { - self::log( sprintf( 'Auto-deactivated %d subscription(s) for %s', $deactivated, $filename ) ); - self::_flush_subscriptions_cache(); - self::_flush_updates_cache(); - } - } - - /** - * Various Helper-related admin notices. - */ - public static function admin_notices() { - if ( apply_filters( 'woocommerce_helper_suppress_admin_notices', false ) ) { - return; - } - - $screen = get_current_screen(); - $screen_id = $screen ? $screen->id : ''; - - if ( 'update-core' !== $screen_id ) { - return; - } - - // Don't nag if Woo doesn't have an update available. - if ( ! self::_woo_core_update_available() ) { - return; - } - - // Add a note about available extension updates if Woo core has an update available. - $notice = self::_get_extensions_update_notice(); - if ( ! empty( $notice ) ) { - echo ''; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped - } - } - - /** - * Get an update notice if one or more Woo extensions has an update available. - * - * @return string|null The update notice or null if everything is up to date. - */ - private static function _get_extensions_update_notice() { - $plugins = self::get_local_woo_plugins(); - $updates = WC_Helper_Updater::get_update_data(); - $available = 0; - - foreach ( $plugins as $data ) { - if ( empty( $updates[ $data['_product_id'] ] ) ) { - continue; - } - - $product_id = $data['_product_id']; - if ( version_compare( $updates[ $product_id ]['version'], $data['Version'], '>' ) ) { - $available++; - } - } - - if ( ! $available ) { - return; - } - - return sprintf( - /* translators: %1$s: helper url, %2$d: number of extensions */ - _n( 'Note: You currently have %2$d paid extension which should be updated first before updating WooCommerce.', 'Note: You currently have %2$d paid extensions which should be updated first before updating WooCommerce.', $available, 'woocommerce' ), - admin_url( 'admin.php?page=wc-addons§ion=helper' ), - $available - ); - } - - /** - * Whether WooCommerce has an update available. - * - * @return bool True if a Woo core update is available. - */ - private static function _woo_core_update_available() { - $updates = get_site_transient( 'update_plugins' ); - if ( empty( $updates->response ) ) { - return false; - } - - if ( empty( $updates->response['woocommerce/woocommerce.php'] ) ) { - return false; - } - - $data = $updates->response['woocommerce/woocommerce.php']; - if ( version_compare( Constants::get_constant( 'WC_VERSION' ), $data->new_version, '>=' ) ) { - return false; - } - - return true; - } - - /** - * Flush subscriptions cache. - */ - public static function _flush_subscriptions_cache() { - delete_transient( '_woocommerce_helper_subscriptions' ); - } - - /** - * Flush auth cache. - */ - public static function _flush_authentication_cache() { - $request = WC_Helper_API::get( - 'oauth/me', - array( - 'authenticated' => true, - ) - ); - - if ( wp_remote_retrieve_response_code( $request ) !== 200 ) { - return false; - } - - $user_data = json_decode( wp_remote_retrieve_body( $request ), true ); - if ( ! $user_data ) { - return false; - } - - WC_Helper_Options::update( - 'auth_user_data', - array( - 'name' => $user_data['name'], - 'email' => $user_data['email'], - ) - ); - - return true; - } - - /** - * Flush updates cache. - */ - private static function _flush_updates_cache() { - WC_Helper_Updater::flush_updates_cache(); - } - - /** - * Sort subscriptions by the product_name. - * - * @param array $a Subscription array. - * @param array $b Subscription array. - * - * @return int - */ - public static function _sort_by_product_name( $a, $b ) { - return strcmp( $a['product_name'], $b['product_name'] ); - } - - /** - * Sort subscriptions by the Name. - * - * @param array $a Product array. - * @param array $b Product array. - * - * @return int - */ - public static function _sort_by_name( $a, $b ) { - return strcmp( $a['Name'], $b['Name'] ); - } - - /** - * Log a helper event. - * - * @param string $message Log message. - * @param string $level Optional, defaults to info, valid levels: emergency|alert|critical|error|warning|notice|info|debug. - */ - public static function log( $message, $level = 'info' ) { - if ( ! Constants::is_true( 'WP_DEBUG' ) ) { - return; - } - - if ( ! isset( self::$log ) ) { - self::$log = wc_get_logger(); - } - - self::$log->log( $level, $message, array( 'source' => 'helper' ) ); - } -} - -WC_Helper::load(); diff --git a/includes/admin/helper/views/html-main.php b/includes/admin/helper/views/html-main.php deleted file mode 100644 index 3023a192b14..00000000000 --- a/includes/admin/helper/views/html-main.php +++ /dev/null @@ -1,214 +0,0 @@ - - -Plugins screen.', 'woocommerce' ), admin_url( 'plugins.php' ) ); ?>
-|
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - - 0 ) { - /* translators: %1$d: sites active, %2$d max sites active */ - printf( __( 'Subscription: Using %1$d of %2$d sites available', 'woocommerce' ), absint( $subscription['sites_active'] ), absint( $subscription['sites_max'] ) ); - } else { - _e( 'Subscription: Unlimited', 'woocommerce' ); - } - - // Check shared. - if ( ! empty( $subscription['is_shared'] ) && ! empty( $subscription['owner_email'] ) ) { - printf( '' . __( 'Shared by %s', 'woocommerce' ), esc_html( $subscription['owner_email'] ) ); - } elseif ( isset( $subscription['master_user_email'] ) ) { - printf( '' . __( 'Shared by %s', 'woocommerce' ), esc_html( $subscription['master_user_email'] ) ); - } - ?> - - |
- - - - - - - - - - - - - - - - - - - - - - | -|
|
- - - - |
- - - - - | -|
| - | ||
Below is a list of WooCommerce.com products available on your site - but are either out-dated or do not have a valid subscription.
- -|
-
-
-
- |
- - - - - - | -
|
- - - - |
- - - | -
' . esc_html( $error['message'] ) . '
'; - - if ( ! empty( $error['actions'] ) ) { - echo ''; - foreach ( $error['actions'] as $action ) { - echo '' . esc_html( $action['label'] ) . ' '; - } - echo '
'; - } - echo ''; - printf( - /* translators: %s: tax rates count */ - esc_html__( 'Import complete - imported %s tax rates.', 'woocommerce' ), - '' . absint( $loop ) . '' - ); - echo '
' . esc_html__( 'All done!', 'woocommerce' ) . ' ' . esc_html__( 'View tax rates', 'woocommerce' ) . '
'; - - do_action( 'import_end' ); - } - - /** - * Handles the CSV upload and initial parsing of the file to prepare for. - * displaying author import options. - * - * @return bool False if error uploading or invalid file, true otherwise - */ - public function handle_upload() { - $file_url = isset( $_POST['file_url'] ) ? wc_clean( wp_unslash( $_POST['file_url'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing -- Nonce already verified in WC_Tax_Rate_Importer::dispatch() - - if ( empty( $file_url ) ) { - $file = wp_import_handle_upload(); - - if ( isset( $file['error'] ) ) { - $this->import_error( $file['error'] ); - } - - if ( ! wc_is_file_valid_csv( $file['file'], false ) ) { - // Remove file if not valid. - wp_delete_attachment( $file['id'], true ); - - $this->import_error( __( 'Invalid file type. The importer supports CSV and TXT file formats.', 'woocommerce' ) ); - } - - $this->id = absint( $file['id'] ); - } elseif ( file_exists( ABSPATH . $file_url ) ) { - if ( ! wc_is_file_valid_csv( ABSPATH . $file_url ) ) { - $this->import_error( __( 'Invalid file type. The importer supports CSV and TXT file formats.', 'woocommerce' ) ); - } - - $this->file_url = esc_attr( $file_url ); - } else { - $this->import_error(); - } - - return true; - } - - /** - * Output header html. - */ - public function header() { - echo '' . esc_html__( 'Hi there! Upload a CSV file containing tax rates to import the contents into your shop. Choose a .csv file to upload, then click "Upload file and import".', 'woocommerce' ) . '
'; - - /* translators: 1: Link to tax rates sample file 2: Closing link. */ - echo '' . sprintf( esc_html__( 'Your CSV needs to include columns in a specific order. %1$sClick here to download a sample%2$s.', 'woocommerce' ), '', '' ) . '
'; - - $action = 'admin.php?import=woocommerce_tax_rate_csv&step=1'; - - $bytes = apply_filters( 'import_upload_size_limit', wp_max_upload_size() ); - $size = size_format( $bytes ); - $upload_dir = wp_upload_dir(); - if ( ! empty( $upload_dir['error'] ) ) : - ?> --
' . esc_html__( 'Sorry, there has been an error.', 'woocommerce' ) . '
';
- if ( $message ) {
- echo esc_html( $message );
- }
- echo '
'; - - do_action( 'woocommerce_admin_order_actions_start', $this->object ); - - $actions = array(); - - if ( $this->object->has_status( array( 'pending', 'on-hold' ) ) ) { - $actions['processing'] = array( - 'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=woocommerce_mark_order_status&status=processing&order_id=' . $this->object->get_id() ), 'woocommerce-mark-order-status' ), - 'name' => __( 'Processing', 'woocommerce' ), - 'action' => 'processing', - ); - } - - if ( $this->object->has_status( array( 'pending', 'on-hold', 'processing' ) ) ) { - $actions['complete'] = array( - 'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=woocommerce_mark_order_status&status=completed&order_id=' . $this->object->get_id() ), 'woocommerce-mark-order-status' ), - 'name' => __( 'Complete', 'woocommerce' ), - 'action' => 'complete', - ); - } - - $actions = apply_filters( 'woocommerce_admin_order_actions', $actions, $this->object ); - - echo wc_render_action_buttons( $actions ); // WPCS: XSS ok. - - do_action( 'woocommerce_admin_order_actions_end', $this->object ); - - echo '
'; - } - - /** - * Render columm: billing_address. - */ - protected function render_billing_address_column() { - $address = $this->object->get_formatted_billing_address(); - - if ( $address ) { - echo esc_html( preg_replace( '#| ' . esc_html( $label ) . ' | '; - } - - $html .= ' -||
|---|---|---|
| ';
- switch ( $column ) {
- case 'product':
- $html .= wp_kses_post( $item->get_name() );
-
- if ( $product_object ) {
- $html .= ' ' . esc_html( $product_object->get_sku() ) . ' ';
- }
-
- $meta_data = $item->get_formatted_meta_data( '' );
-
- if ( $meta_data ) {
- $html .= '
| ';
- }
-
- $html .= '
' . esc_html( $message ) . '
' . esc_html( $message ) . '
WC_Log_Handler_Interface'
- ),
- '3.0'
- );
- }
- }
- }
-
- // Support the constant as long as a valid log level has been set for it.
- if ( null === $threshold ) {
- $threshold = Constants::get_constant( 'WC_LOG_THRESHOLD' );
- if ( null !== $threshold && ! WC_Log_Levels::is_valid_level( $threshold ) ) {
- $threshold = null;
- }
- }
-
- if ( null !== $threshold ) {
- $threshold = WC_Log_Levels::get_level_severity( $threshold );
- }
-
- $this->handlers = $register_handlers;
- $this->threshold = $threshold;
- }
-
- /**
- * Determine whether to handle or ignore log.
- *
- * @param string $level emergency|alert|critical|error|warning|notice|info|debug.
- * @return bool True if the log should be handled.
- */
- protected function should_handle( $level ) {
- if ( null === $this->threshold ) {
- return true;
- }
- return $this->threshold <= WC_Log_Levels::get_level_severity( $level );
- }
-
- /**
- * Add a log entry.
- *
- * This is not the preferred method for adding log messages. Please use log() or any one of
- * the level methods (debug(), info(), etc.). This method may be deprecated in the future.
- *
- * @param string $handle File handle.
- * @param string $message Message to log.
- * @param string $level Logging level.
- * @return bool
- */
- public function add( $handle, $message, $level = WC_Log_Levels::NOTICE ) {
- $message = apply_filters( 'woocommerce_logger_add_message', $message, $handle );
- $this->log(
- $level,
- $message,
- array(
- 'source' => $handle,
- '_legacy' => true,
- )
- );
- wc_do_deprecated_action( 'woocommerce_log_add', array( $handle, $message ), '3.0', 'This action has been deprecated with no alternative.' );
- return true;
- }
-
- /**
- * Add a log entry.
- *
- * @param string $level One of the following:
- * 'emergency': System is unusable.
- * 'alert': Action must be taken immediately.
- * 'critical': Critical conditions.
- * 'error': Error conditions.
- * 'warning': Warning conditions.
- * 'notice': Normal but significant condition.
- * 'info': Informational messages.
- * 'debug': Debug-level messages.
- * @param string $message Log message.
- * @param array $context Optional. Additional information for log handlers.
- */
- public function log( $level, $message, $context = array() ) {
- if ( ! WC_Log_Levels::is_valid_level( $level ) ) {
- /* translators: 1: WC_Logger::log 2: level */
- wc_doing_it_wrong( __METHOD__, sprintf( __( '%1$s was called with an invalid level "%2$s".', 'woocommerce' ), 'WC_Logger::log', $level ), '3.0' );
- }
-
- if ( $this->should_handle( $level ) ) {
- $timestamp = current_time( 'timestamp', 1 );
- $message = apply_filters( 'woocommerce_logger_log_message', $message, $level, $context );
-
- foreach ( $this->handlers as $handler ) {
- $handler->handle( $timestamp, $level, $message, $context );
- }
- }
- }
-
- /**
- * Adds an emergency level message.
- *
- * System is unusable.
- *
- * @see WC_Logger::log
- *
- * @param string $message Message to log.
- * @param array $context Log context.
- */
- public function emergency( $message, $context = array() ) {
- $this->log( WC_Log_Levels::EMERGENCY, $message, $context );
- }
-
- /**
- * Adds an alert level message.
- *
- * Action must be taken immediately.
- * Example: Entire website down, database unavailable, etc.
- *
- * @see WC_Logger::log
- *
- * @param string $message Message to log.
- * @param array $context Log context.
- */
- public function alert( $message, $context = array() ) {
- $this->log( WC_Log_Levels::ALERT, $message, $context );
- }
-
- /**
- * Adds a critical level message.
- *
- * Critical conditions.
- * Example: Application component unavailable, unexpected exception.
- *
- * @see WC_Logger::log
- *
- * @param string $message Message to log.
- * @param array $context Log context.
- */
- public function critical( $message, $context = array() ) {
- $this->log( WC_Log_Levels::CRITICAL, $message, $context );
- }
-
- /**
- * Adds an error level message.
- *
- * Runtime errors that do not require immediate action but should typically be logged
- * and monitored.
- *
- * @see WC_Logger::log
- *
- * @param string $message Message to log.
- * @param array $context Log context.
- */
- public function error( $message, $context = array() ) {
- $this->log( WC_Log_Levels::ERROR, $message, $context );
- }
-
- /**
- * Adds a warning level message.
- *
- * Exceptional occurrences that are not errors.
- *
- * Example: Use of deprecated APIs, poor use of an API, undesirable things that are not
- * necessarily wrong.
- *
- * @see WC_Logger::log
- *
- * @param string $message Message to log.
- * @param array $context Log context.
- */
- public function warning( $message, $context = array() ) {
- $this->log( WC_Log_Levels::WARNING, $message, $context );
- }
-
- /**
- * Adds a notice level message.
- *
- * Normal but significant events.
- *
- * @see WC_Logger::log
- *
- * @param string $message Message to log.
- * @param array $context Log context.
- */
- public function notice( $message, $context = array() ) {
- $this->log( WC_Log_Levels::NOTICE, $message, $context );
- }
-
- /**
- * Adds a info level message.
- *
- * Interesting events.
- * Example: User logs in, SQL logs.
- *
- * @see WC_Logger::log
- *
- * @param string $message Message to log.
- * @param array $context Log context.
- */
- public function info( $message, $context = array() ) {
- $this->log( WC_Log_Levels::INFO, $message, $context );
- }
-
- /**
- * Adds a debug level message.
- *
- * Detailed debug information.
- *
- * @see WC_Logger::log
- *
- * @param string $message Message to log.
- * @param array $context Log context.
- */
- public function debug( $message, $context = array() ) {
- $this->log( WC_Log_Levels::DEBUG, $message, $context );
- }
-
- /**
- * Clear entries for a chosen file/source.
- *
- * @param string $source Source/handle to clear.
- * @return bool
- */
- public function clear( $source = '' ) {
- if ( ! $source ) {
- return false;
- }
- foreach ( $this->handlers as $handler ) {
- if ( is_callable( array( $handler, 'clear' ) ) ) {
- $handler->clear( $source );
- }
- }
- return true;
- }
-
- /**
- * Clear all logs older than a defined number of days. Defaults to 30 days.
- *
- * @since 3.4.0
- */
- public function clear_expired_logs() {
- $days = absint( apply_filters( 'woocommerce_logger_days_to_retain_logs', 30 ) );
- $timestamp = strtotime( "-{$days} days" );
-
- foreach ( $this->handlers as $handler ) {
- if ( is_callable( array( $handler, 'delete_logs_before_timestamp' ) ) ) {
- $handler->delete_logs_before_timestamp( $timestamp );
- }
- }
- }
-}
diff --git a/includes/class-wc-meta-data.php b/includes/class-wc-meta-data.php
deleted file mode 100644
index c21d98d650c..00000000000
--- a/includes/class-wc-meta-data.php
+++ /dev/null
@@ -1,119 +0,0 @@
-current_data = $meta;
- $this->apply_changes();
- }
-
- /**
- * When converted to JSON.
- *
- * @return object|array
- */
- public function jsonSerialize() {
- return $this->get_data();
- }
-
- /**
- * Merge changes with data and clear.
- */
- public function apply_changes() {
- $this->data = $this->current_data;
- }
-
- /**
- * Creates or updates a property in the metadata object.
- *
- * @param string $key Key to set.
- * @param mixed $value Value to set.
- */
- public function __set( $key, $value ) {
- $this->current_data[ $key ] = $value;
- }
-
- /**
- * Checks if a given key exists in our data. This is called internally
- * by `empty` and `isset`.
- *
- * @param string $key Key to check if set.
- *
- * @return bool
- */
- public function __isset( $key ) {
- return array_key_exists( $key, $this->current_data );
- }
-
- /**
- * Returns the value of any property.
- *
- * @param string $key Key to get.
- * @return mixed Property value or NULL if it does not exists
- */
- public function __get( $key ) {
- if ( array_key_exists( $key, $this->current_data ) ) {
- return $this->current_data[ $key ];
- }
- return null;
- }
-
- /**
- * Return data changes only.
- *
- * @return array
- */
- public function get_changes() {
- $changes = array();
- foreach ( $this->current_data as $id => $value ) {
- if ( ! array_key_exists( $id, $this->data ) || $value !== $this->data[ $id ] ) {
- $changes[ $id ] = $value;
- }
- }
- return $changes;
- }
-
- /**
- * Return all data as an array.
- *
- * @return array
- */
- public function get_data() {
- return $this->data;
- }
-}
diff --git a/includes/class-wc-order-item-coupon.php b/includes/class-wc-order-item-coupon.php
deleted file mode 100644
index 1a8aa50702a..00000000000
--- a/includes/class-wc-order-item-coupon.php
+++ /dev/null
@@ -1,182 +0,0 @@
- '',
- 'discount' => 0,
- 'discount_tax' => 0,
- );
-
- /*
- |--------------------------------------------------------------------------
- | Setters
- |--------------------------------------------------------------------------
- */
-
- /**
- * Set order item name.
- *
- * @param string $value Coupon code.
- */
- public function set_name( $value ) {
- return $this->set_code( $value );
- }
-
- /**
- * Set code.
- *
- * @param string $value Coupon code.
- */
- public function set_code( $value ) {
- $this->set_prop( 'code', wc_format_coupon_code( $value ) );
- }
-
- /**
- * Set discount amount.
- *
- * @param string $value Discount.
- */
- public function set_discount( $value ) {
- $this->set_prop( 'discount', wc_format_decimal( $value ) );
- }
-
- /**
- * Set discounted tax amount.
- *
- * @param string $value Discount tax.
- */
- public function set_discount_tax( $value ) {
- $this->set_prop( 'discount_tax', wc_format_decimal( $value ) );
- }
-
- /*
- |--------------------------------------------------------------------------
- | Getters
- |--------------------------------------------------------------------------
- */
-
- /**
- * Get order item type.
- *
- * @return string
- */
- public function get_type() {
- return 'coupon';
- }
-
- /**
- * Get order item name.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return string
- */
- public function get_name( $context = 'view' ) {
- return $this->get_code( $context );
- }
-
- /**
- * Get coupon code.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return string
- */
- public function get_code( $context = 'view' ) {
- return $this->get_prop( 'code', $context );
- }
-
- /**
- * Get discount amount.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return string
- */
- public function get_discount( $context = 'view' ) {
- return $this->get_prop( 'discount', $context );
- }
-
- /**
- * Get discounted tax amount.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- *
- * @return string
- */
- public function get_discount_tax( $context = 'view' ) {
- return $this->get_prop( 'discount_tax', $context );
- }
-
- /*
- |--------------------------------------------------------------------------
- | Array Access Methods
- |--------------------------------------------------------------------------
- |
- | For backwards compatibility with legacy arrays.
- |
- */
-
- /**
- * OffsetGet for ArrayAccess/Backwards compatibility.
- *
- * @deprecated 4.4.0
- * @param string $offset Offset.
- * @return mixed
- */
- public function offsetGet( $offset ) {
- wc_deprecated_function( 'WC_Order_Item_Coupon::offsetGet', '4.4.0', '' );
- if ( 'discount_amount' === $offset ) {
- $offset = 'discount';
- } elseif ( 'discount_amount_tax' === $offset ) {
- $offset = 'discount_tax';
- }
- return parent::offsetGet( $offset );
- }
-
- /**
- * OffsetSet for ArrayAccess/Backwards compatibility.
- *
- * @deprecated 4.4.0
- * @param string $offset Offset.
- * @param mixed $value Value.
- */
- public function offsetSet( $offset, $value ) {
- wc_deprecated_function( 'WC_Order_Item_Coupon::offsetSet', '4.4.0', '' );
- if ( 'discount_amount' === $offset ) {
- $offset = 'discount';
- } elseif ( 'discount_amount_tax' === $offset ) {
- $offset = 'discount_tax';
- }
- parent::offsetSet( $offset, $value );
- }
-
- /**
- * OffsetExists for ArrayAccess.
- *
- * @param string $offset Offset.
- * @return bool
- */
- public function offsetExists( $offset ) {
- if ( in_array( $offset, array( 'discount_amount', 'discount_amount_tax' ), true ) ) {
- return true;
- }
- return parent::offsetExists( $offset );
- }
-}
diff --git a/includes/class-wc-order-item-fee.php b/includes/class-wc-order-item-fee.php
deleted file mode 100644
index 44e1ee12d2c..00000000000
--- a/includes/class-wc-order-item-fee.php
+++ /dev/null
@@ -1,338 +0,0 @@
- '',
- 'tax_status' => 'taxable',
- 'amount' => '',
- 'total' => '',
- 'total_tax' => '',
- 'taxes' => array(
- 'total' => array(),
- ),
- );
-
- /**
- * Get item costs grouped by tax class.
- *
- * @since 3.2.0
- * @param WC_Order $order Order object.
- * @return array
- */
- protected function get_tax_class_costs( $order ) {
- $order_item_tax_classes = $order->get_items_tax_classes();
- $costs = array_fill_keys( $order_item_tax_classes, 0 );
- $costs['non-taxable'] = 0;
-
- foreach ( $order->get_items( array( 'line_item', 'fee', 'shipping' ) ) as $item ) {
- if ( 0 > $item->get_total() ) {
- continue;
- }
- if ( 'taxable' !== $item->get_tax_status() ) {
- $costs['non-taxable'] += $item->get_total();
- } elseif ( 'inherit' === $item->get_tax_class() ) {
- $inherit_class = reset( $order_item_tax_classes );
- $costs[ $inherit_class ] += $item->get_total();
- } else {
- $costs[ $item->get_tax_class() ] += $item->get_total();
- }
- }
-
- return array_filter( $costs );
- }
- /**
- * Calculate item taxes.
- *
- * @since 3.2.0
- * @param array $calculate_tax_for Location data to get taxes for. Required.
- * @return bool True if taxes were calculated.
- */
- public function calculate_taxes( $calculate_tax_for = array() ) {
- if ( ! isset( $calculate_tax_for['country'], $calculate_tax_for['state'], $calculate_tax_for['postcode'], $calculate_tax_for['city'] ) ) {
- return false;
- }
- // Use regular calculation unless the fee is negative.
- if ( 0 <= $this->get_total() ) {
- return parent::calculate_taxes( $calculate_tax_for );
- }
-
- if ( wc_tax_enabled() && $this->get_order() ) {
- // Apportion taxes to order items, shipping, and fees.
- $order = $this->get_order();
- $tax_class_costs = $this->get_tax_class_costs( $order );
- $total_costs = array_sum( $tax_class_costs );
- $discount_taxes = array();
- if ( $total_costs ) {
- foreach ( $tax_class_costs as $tax_class => $tax_class_cost ) {
- if ( 'non-taxable' === $tax_class ) {
- continue;
- }
- $proportion = $tax_class_cost / $total_costs;
- $cart_discount_proportion = $this->get_total() * $proportion;
- $calculate_tax_for['tax_class'] = $tax_class;
- $tax_rates = WC_Tax::find_rates( $calculate_tax_for );
- $discount_taxes = wc_array_merge_recursive_numeric( $discount_taxes, WC_Tax::calc_tax( $cart_discount_proportion, $tax_rates ) );
- }
- }
- $this->set_taxes( array( 'total' => $discount_taxes ) );
- } else {
- $this->set_taxes( false );
- }
-
- do_action( 'woocommerce_order_item_fee_after_calculate_taxes', $this, $calculate_tax_for );
-
- return true;
- }
-
- /*
- |--------------------------------------------------------------------------
- | Setters
- |--------------------------------------------------------------------------
- */
-
- /**
- * Set fee amount.
- *
- * @param string $value Amount.
- */
- public function set_amount( $value ) {
- $this->set_prop( 'amount', wc_format_decimal( $value ) );
- }
-
- /**
- * Set tax class.
- *
- * @param string $value Tax class.
- */
- public function set_tax_class( $value ) {
- if ( $value && ! in_array( $value, WC_Tax::get_tax_class_slugs(), true ) ) {
- $this->error( 'order_item_fee_invalid_tax_class', __( 'Invalid tax class', 'woocommerce' ) );
- }
- $this->set_prop( 'tax_class', $value );
- }
-
- /**
- * Set tax_status.
- *
- * @param string $value Tax status.
- */
- public function set_tax_status( $value ) {
- if ( in_array( $value, array( 'taxable', 'none' ), true ) ) {
- $this->set_prop( 'tax_status', $value );
- } else {
- $this->set_prop( 'tax_status', 'taxable' );
- }
- }
-
- /**
- * Set total.
- *
- * @param string $amount Fee amount (do not enter negative amounts).
- */
- public function set_total( $amount ) {
- $this->set_prop( 'total', wc_format_decimal( $amount ) );
- }
-
- /**
- * Set total tax.
- *
- * @param string $amount Amount.
- */
- public function set_total_tax( $amount ) {
- $this->set_prop( 'total_tax', wc_format_decimal( $amount ) );
- }
-
- /**
- * Set taxes.
- *
- * This is an array of tax ID keys with total amount values.
- *
- * @param array $raw_tax_data Raw tax data.
- */
- public function set_taxes( $raw_tax_data ) {
- $raw_tax_data = maybe_unserialize( $raw_tax_data );
- $tax_data = array(
- 'total' => array(),
- );
- if ( ! empty( $raw_tax_data['total'] ) ) {
- $tax_data['total'] = array_map( 'wc_format_decimal', $raw_tax_data['total'] );
- }
- $this->set_prop( 'taxes', $tax_data );
-
- if ( 'yes' === get_option( 'woocommerce_tax_round_at_subtotal' ) ) {
- $this->set_total_tax( array_sum( $tax_data['total'] ) );
- } else {
- $this->set_total_tax( array_sum( array_map( 'wc_round_tax_total', $tax_data['total'] ) ) );
- }
- }
-
- /*
- |--------------------------------------------------------------------------
- | Getters
- |--------------------------------------------------------------------------
- */
-
- /**
- * Get fee amount.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return string
- */
- public function get_amount( $context = 'view' ) {
- return $this->get_prop( 'amount', $context );
- }
-
- /**
- * Get order item name.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return string
- */
- public function get_name( $context = 'view' ) {
- $name = $this->get_prop( 'name', $context );
- if ( 'view' === $context ) {
- return $name ? $name : __( 'Fee', 'woocommerce' );
- } else {
- return $name;
- }
- }
-
- /**
- * Get order item type.
- *
- * @return string
- */
- public function get_type() {
- return 'fee';
- }
-
- /**
- * Get tax class.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return string
- */
- public function get_tax_class( $context = 'view' ) {
- return $this->get_prop( 'tax_class', $context );
- }
-
- /**
- * Get tax status.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return string
- */
- public function get_tax_status( $context = 'view' ) {
- return $this->get_prop( 'tax_status', $context );
- }
-
- /**
- * Get total fee.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return string
- */
- public function get_total( $context = 'view' ) {
- return $this->get_prop( 'total', $context );
- }
-
- /**
- * Get total tax.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return string
- */
- public function get_total_tax( $context = 'view' ) {
- return $this->get_prop( 'total_tax', $context );
- }
-
- /**
- * Get fee taxes.
- *
- * @param string $context What the value is for. Valid values are 'view' and 'edit'.
- * @return array
- */
- public function get_taxes( $context = 'view' ) {
- return $this->get_prop( 'taxes', $context );
- }
-
- /*
- |--------------------------------------------------------------------------
- | Array Access Methods
- |--------------------------------------------------------------------------
- |
- | For backwards compatibility with legacy arrays.
- |
- */
-
- /**
- * OffsetGet for ArrayAccess/Backwards compatibility.
- *
- * @param string $offset Offset.
- * @return mixed
- */
- public function offsetGet( $offset ) {
- if ( 'line_total' === $offset ) {
- $offset = 'total';
- } elseif ( 'line_tax' === $offset ) {
- $offset = 'total_tax';
- } elseif ( 'line_tax_data' === $offset ) {
- $offset = 'taxes';
- }
- return parent::offsetGet( $offset );
- }
-
- /**
- * OffsetSet for ArrayAccess/Backwards compatibility.
- *
- * @deprecated 4.4.0
- * @param string $offset Offset.
- * @param mixed $value Value.
- */
- public function offsetSet( $offset, $value ) {
- wc_deprecated_function( 'WC_Order_Item_Fee::offsetSet', '4.4.0', '' );
- if ( 'line_total' === $offset ) {
- $offset = 'total';
- } elseif ( 'line_tax' === $offset ) {
- $offset = 'total_tax';
- } elseif ( 'line_tax_data' === $offset ) {
- $offset = 'taxes';
- }
- parent::offsetSet( $offset, $value );
- }
-
- /**
- * OffsetExists for ArrayAccess
- *
- * @param string $offset Offset.
- * @return bool
- */
- public function offsetExists( $offset ) {
- if ( in_array( $offset, array( 'line_total', 'line_tax', 'line_tax_data' ), true ) ) {
- return true;
- }
- return parent::offsetExists( $offset );
- }
-}
diff --git a/includes/class-wc-order-item-meta.php b/includes/class-wc-order-item-meta.php
deleted file mode 100644
index 693be232328..00000000000
--- a/includes/class-wc-order-item-meta.php
+++ /dev/null
@@ -1,215 +0,0 @@
-legacy = true;
- $this->meta = array_filter( (array) $item );
- return;
- }
- $this->item = $item;
- $this->meta = array_filter( (array) $item['item_meta'] );
- $this->product = $product;
- }
-
- /**
- * Display meta in a formatted list.
- *
- * @param bool $flat Flat (default: false).
- * @param bool $return Return (default: false).
- * @param string $hideprefix Hide prefix (default: _).
- * @param string $delimiter Delimiter used to separate items when $flat is true.
- * @return string|void
- */
- public function display( $flat = false, $return = false, $hideprefix = '_', $delimiter = ", \n" ) {
- $output = '';
- $formatted_meta = $this->get_formatted( $hideprefix );
-
- if ( ! empty( $formatted_meta ) ) {
- $meta_list = array();
-
- foreach ( $formatted_meta as $meta ) {
- if ( $flat ) {
- $meta_list[] = wp_kses_post( $meta['label'] . ': ' . $meta['value'] );
- } else {
- $meta_list[] = '
- ' . - __( 'This sample language includes the basics around what personal data your store may be collecting, storing and sharing, as well as who may have access to that data. Depending on what settings are enabled and which additional plugins are used, the specific information shared by your store will vary. We recommend consulting with a lawyer when deciding what information to disclose on your privacy policy.', 'woocommerce' ) . - '
' . - '' . __( 'We collect information about you during the checkout process on our store.', 'woocommerce' ) . '
' . - '' . __( 'While you visit our site, we’ll track:', 'woocommerce' ) . '
' . - '' . __( 'We’ll also use cookies to keep track of cart contents while you’re browsing our site.', 'woocommerce' ) . '
' . - '' . - __( 'Note: you may want to further detail your cookie policy, and link to that section from here.', 'woocommerce' ) . - '
' . - '' . __( 'When you purchase from us, we’ll ask you to provide information including your name, billing address, shipping address, email address, phone number, credit card/payment details and optional account information like username and password. We’ll use this information for purposes, such as, to:', 'woocommerce' ) . '
' . - '' . __( 'If you create an account, we will store your name, address, email and phone number, which will be used to populate the checkout for future orders.', 'woocommerce' ) . '
' . - '' . __( 'We generally store information about you for as long as we need the information for the purposes for which we collect and use it, and we are not legally required to continue to keep it. For example, we will store order information for XXX years for tax and accounting purposes. This includes your name, email address and billing and shipping addresses.', 'woocommerce' ) . '
' . - '' . __( 'We will also store comments or reviews, if you choose to leave them.', 'woocommerce' ) . '
' . - '' . __( 'Members of our team have access to the information you provide us. For example, both Administrators and Shop Managers can access:', 'woocommerce' ) . '
' . - '' . __( 'Our team members have access to this information to help fulfill orders, process refunds and support you.', 'woocommerce' ) . '
' . - '' . - __( 'In this section you should list who you’re sharing data with, and for what purpose. This could include, but may not be limited to, analytics, marketing, payment gateways, shipping providers, and third party embeds.', 'woocommerce' ) . - '
' . - '' . __( 'We share information with third parties who help us provide our orders and store services to you; for example --', 'woocommerce' ) . '
' . - '' . - __( 'In this subsection you should list which third party payment processors you’re using to take payments on your store since these may handle customer data. We’ve included PayPal as an example, but you should remove this if you’re not using PayPal.', 'woocommerce' ) . - '
' . - '' . __( 'We accept payments through PayPal. When processing payments, some of your data will be passed to PayPal, including information required to process or support the payment, such as the purchase total and billing information.', 'woocommerce' ) . '
' . - '' . __( 'Please see the PayPal Privacy Policy for more details.', 'woocommerce' ) . '
' . - 'grunt assets to build and minify assets.', 'woocommerce' );
- $message_two = sprintf(
- /* translators: 1: URL of WordPress.org Repository 2: URL of the GitHub Repository release page */
- __( 'Or you can download a pre-built version of the plugin from the WordPress.org repository or by visiting the releases page in the GitHub repository.', 'woocommerce' ),
- 'https://wordpress.org/plugins/woocommerce/',
- 'https://github.com/woocommerce/woocommerce/releases'
- );
- printf( '%s %s
' . implode( ', ', array_keys( $this->placeholders ) ) . '' );
- $this->form_fields = array(
- 'enabled' => array(
- 'title' => __( 'Enable/Disable', 'woocommerce' ),
- 'type' => 'checkbox',
- 'label' => __( 'Enable this email notification', 'woocommerce' ),
- 'default' => 'yes',
- ),
- 'recipient' => array(
- 'title' => __( 'Recipient(s)', 'woocommerce' ),
- 'type' => 'text',
- /* translators: %s: WP admin email */
- 'description' => sprintf( __( 'Enter recipients (comma separated) for this email. Defaults to %s.', 'woocommerce' ), '' . esc_attr( get_option( 'admin_email' ) ) . '' ),
- 'placeholder' => '',
- 'default' => '',
- 'desc_tip' => true,
- ),
- 'subject' => array(
- 'title' => __( 'Subject', 'woocommerce' ),
- 'type' => 'text',
- 'desc_tip' => true,
- 'description' => $placeholder_text,
- 'placeholder' => $this->get_default_subject(),
- 'default' => '',
- ),
- 'heading' => array(
- 'title' => __( 'Email heading', 'woocommerce' ),
- 'type' => 'text',
- 'desc_tip' => true,
- 'description' => $placeholder_text,
- 'placeholder' => $this->get_default_heading(),
- 'default' => '',
- ),
- 'additional_content' => array(
- 'title' => __( 'Additional content', 'woocommerce' ),
- 'description' => __( 'Text to appear below the main email content.', 'woocommerce' ) . ' ' . $placeholder_text,
- 'css' => 'width:400px; height: 75px;',
- 'placeholder' => __( 'N/A', 'woocommerce' ),
- 'type' => 'textarea',
- 'default' => $this->get_default_additional_content(),
- 'desc_tip' => true,
- ),
- 'email_type' => array(
- 'title' => __( 'Email type', 'woocommerce' ),
- 'type' => 'select',
- 'description' => __( 'Choose which format of email to send.', 'woocommerce' ),
- 'default' => 'html',
- 'class' => 'email_type wc-enhanced-select',
- 'options' => $this->get_email_type_options(),
- 'desc_tip' => true,
- ),
- );
- }
- }
-
-endif;
-
-return new WC_Email_New_Order();
diff --git a/includes/emails/class-wc-email.php b/includes/emails/class-wc-email.php
deleted file mode 100644
index d5accd8347a..00000000000
--- a/includes/emails/class-wc-email.php
+++ /dev/null
@@ -1,1080 +0,0 @@
-', // Greater-than.
- '<', // Less-than.
- '&', // Ampersand.
- '&', // Ampersand.
- '(c)', // Copyright.
- '(tm)', // Trademark.
- '(R)', // Registered.
- '--', // mdash.
- '-', // ndash.
- '*', // Bullet.
- '£', // Pound sign.
- 'EUR', // Euro sign. € ?.
- '$', // Dollar sign.
- '', // Unknown/unhandled entities.
- ' ', // Runs of spaces, post-handling.
- );
-
- /**
- * Strings to find/replace in subjects/headings.
- *
- * @var array
- */
- protected $placeholders = array();
-
- /**
- * Strings to find in subjects/headings.
- *
- * @deprecated 3.2.0 in favour of placeholders
- * @var array
- */
- public $find = array();
-
- /**
- * Strings to replace in subjects/headings.
- *
- * @deprecated 3.2.0 in favour of placeholders
- * @var array
- */
- public $replace = array();
-
- /**
- * Constructor.
- */
- public function __construct() {
- // Find/replace.
- $this->placeholders = array_merge(
- array(
- '{site_title}' => $this->get_blogname(),
- '{site_address}' => wp_parse_url( home_url(), PHP_URL_HOST ),
- '{site_url}' => wp_parse_url( home_url(), PHP_URL_HOST ),
- ),
- $this->placeholders
- );
-
- // Init settings.
- $this->init_form_fields();
- $this->init_settings();
-
- // Default template base if not declared in child constructor.
- if ( is_null( $this->template_base ) ) {
- $this->template_base = WC()->plugin_path() . '/templates/';
- }
-
- $this->email_type = $this->get_option( 'email_type' );
- $this->enabled = $this->get_option( 'enabled' );
-
- add_action( 'phpmailer_init', array( $this, 'handle_multipart' ) );
- add_action( 'woocommerce_update_options_email_' . $this->id, array( $this, 'process_admin_options' ) );
- }
-
- /**
- * Handle multipart mail.
- *
- * @param PHPMailer $mailer PHPMailer object.
- * @return PHPMailer
- */
- public function handle_multipart( $mailer ) {
- if ( $this->sending && 'multipart' === $this->get_email_type() ) {
- $mailer->AltBody = wordwrap( // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
- preg_replace( $this->plain_search, $this->plain_replace, wp_strip_all_tags( $this->get_content_plain() ) )
- );
- $this->sending = false;
- }
- return $mailer;
- }
-
- /**
- * Format email string.
- *
- * @param mixed $string Text to replace placeholders in.
- * @return string
- */
- public function format_string( $string ) {
- $find = array_keys( $this->placeholders );
- $replace = array_values( $this->placeholders );
-
- // If using legacy find replace, add those to our find/replace arrays first. @todo deprecate in 4.0.0.
- $find = array_merge( (array) $this->find, $find );
- $replace = array_merge( (array) $this->replace, $replace );
-
- // Take care of blogname which is no longer defined as a valid placeholder.
- $find[] = '{blogname}';
- $replace[] = $this->get_blogname();
-
- // If using the older style filters for find and replace, ensure the array is associative and then pass through filters. @todo deprecate in 4.0.0.
- if ( has_filter( 'woocommerce_email_format_string_replace' ) || has_filter( 'woocommerce_email_format_string_find' ) ) {
- $legacy_find = $this->find;
- $legacy_replace = $this->replace;
-
- foreach ( $this->placeholders as $find => $replace ) {
- $legacy_key = sanitize_title( str_replace( '_', '-', trim( $find, '{}' ) ) );
- $legacy_find[ $legacy_key ] = $find;
- $legacy_replace[ $legacy_key ] = $replace;
- }
-
- $string = str_replace( apply_filters( 'woocommerce_email_format_string_find', $legacy_find, $this ), apply_filters( 'woocommerce_email_format_string_replace', $legacy_replace, $this ), $string );
- }
-
- /**
- * Filter for main find/replace.
- *
- * @since 3.2.0
- */
- return apply_filters( 'woocommerce_email_format_string', str_replace( $find, $replace, $string ), $this );
- }
-
- /**
- * Set the locale to the store locale for customer emails to make sure emails are in the store language.
- */
- public function setup_locale() {
- if ( $this->is_customer_email() && apply_filters( 'woocommerce_email_setup_locale', true ) ) {
- wc_switch_to_site_locale();
- }
- }
-
- /**
- * Restore the locale to the default locale. Use after finished with setup_locale.
- */
- public function restore_locale() {
- if ( $this->is_customer_email() && apply_filters( 'woocommerce_email_restore_locale', true ) ) {
- wc_restore_locale();
- }
- }
-
- /**
- * Get email subject.
- *
- * @since 3.1.0
- * @return string
- */
- public function get_default_subject() {
- return $this->subject;
- }
-
- /**
- * Get email heading.
- *
- * @since 3.1.0
- * @return string
- */
- public function get_default_heading() {
- return $this->heading;
- }
-
- /**
- * Default content to show below main email content.
- *
- * @since 3.7.0
- * @return string
- */
- public function get_default_additional_content() {
- return '';
- }
-
- /**
- * Return content from the additional_content field.
- *
- * Displayed above the footer.
- *
- * @since 3.7.0
- * @return string
- */
- public function get_additional_content() {
- $content = $this->get_option( 'additional_content', '' );
-
- return apply_filters( 'woocommerce_email_additional_content_' . $this->id, $this->format_string( $content ), $this->object, $this );
- }
-
- /**
- * Get email subject.
- *
- * @return string
- */
- public function get_subject() {
- return apply_filters( 'woocommerce_email_subject_' . $this->id, $this->format_string( $this->get_option( 'subject', $this->get_default_subject() ) ), $this->object, $this );
- }
-
- /**
- * Get email heading.
- *
- * @return string
- */
- public function get_heading() {
- return apply_filters( 'woocommerce_email_heading_' . $this->id, $this->format_string( $this->get_option( 'heading', $this->get_default_heading() ) ), $this->object, $this );
- }
-
- /**
- * Get valid recipients.
- *
- * @return string
- */
- public function get_recipient() {
- $recipient = apply_filters( 'woocommerce_email_recipient_' . $this->id, $this->recipient, $this->object, $this );
- $recipients = array_map( 'trim', explode( ',', $recipient ) );
- $recipients = array_filter( $recipients, 'is_email' );
- return implode( ', ', $recipients );
- }
-
- /**
- * Get email headers.
- *
- * @return string
- */
- public function get_headers() {
- $header = 'Content-Type: ' . $this->get_content_type() . "\r\n";
-
- if ( in_array( $this->id, array( 'new_order', 'cancelled_order', 'failed_order' ), true ) ) {
- if ( $this->object && $this->object->get_billing_email() && ( $this->object->get_billing_first_name() || $this->object->get_billing_last_name() ) ) {
- $header .= 'Reply-to: ' . $this->object->get_billing_first_name() . ' ' . $this->object->get_billing_last_name() . ' <' . $this->object->get_billing_email() . ">\r\n";
- }
- } elseif ( $this->get_from_address() && $this->get_from_name() ) {
- $header .= 'Reply-to: ' . $this->get_from_name() . ' <' . $this->get_from_address() . ">\r\n";
- }
-
- return apply_filters( 'woocommerce_email_headers', $header, $this->id, $this->object, $this );
- }
-
- /**
- * Get email attachments.
- *
- * @return array
- */
- public function get_attachments() {
- return apply_filters( 'woocommerce_email_attachments', array(), $this->id, $this->object, $this );
- }
-
- /**
- * Return email type.
- *
- * @return string
- */
- public function get_email_type() {
- return $this->email_type && class_exists( 'DOMDocument' ) ? $this->email_type : 'plain';
- }
-
- /**
- * Get email content type.
- *
- * @param string $default_content_type Default wp_mail() content type.
- * @return string
- */
- public function get_content_type( $default_content_type = '' ) {
- switch ( $this->get_email_type() ) {
- case 'html':
- $content_type = 'text/html';
- break;
- case 'multipart':
- $content_type = 'multipart/alternative';
- break;
- default:
- $content_type = 'text/plain';
- break;
- }
-
- return apply_filters( 'woocommerce_email_content_type', $content_type, $this, $default_content_type );
- }
-
- /**
- * Return the email's title
- *
- * @return string
- */
- public function get_title() {
- return apply_filters( 'woocommerce_email_title', $this->title, $this );
- }
-
- /**
- * Return the email's description
- *
- * @return string
- */
- public function get_description() {
- return apply_filters( 'woocommerce_email_description', $this->description, $this );
- }
-
- /**
- * Proxy to parent's get_option and attempt to localize the result using gettext.
- *
- * @param string $key Option key.
- * @param mixed $empty_value Value to use when option is empty.
- * @return string
- */
- public function get_option( $key, $empty_value = null ) {
- $value = parent::get_option( $key, $empty_value );
- return apply_filters( 'woocommerce_email_get_option', $value, $this, $value, $key, $empty_value );
- }
-
- /**
- * Checks if this email is enabled and will be sent.
- *
- * @return bool
- */
- public function is_enabled() {
- return apply_filters( 'woocommerce_email_enabled_' . $this->id, 'yes' === $this->enabled, $this->object, $this );
- }
-
- /**
- * Checks if this email is manually sent
- *
- * @return bool
- */
- public function is_manual() {
- return $this->manual;
- }
-
- /**
- * Checks if this email is customer focussed.
- *
- * @return bool
- */
- public function is_customer_email() {
- return $this->customer_email;
- }
-
- /**
- * Get WordPress blog name.
- *
- * @return string
- */
- public function get_blogname() {
- return wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
- }
-
- /**
- * Get email content.
- *
- * @return string
- */
- public function get_content() {
- $this->sending = true;
-
- if ( 'plain' === $this->get_email_type() ) {
- $email_content = wordwrap( preg_replace( $this->plain_search, $this->plain_replace, wp_strip_all_tags( $this->get_content_plain() ) ), 70 );
- } else {
- $email_content = $this->get_content_html();
- }
-
- return $email_content;
- }
-
- /**
- * Apply inline styles to dynamic content.
- *
- * We only inline CSS for html emails, and to do so we use Emogrifier library (if supported).
- *
- * @version 4.0.0
- * @param string|null $content Content that will receive inline styles.
- * @return string
- */
- public function style_inline( $content ) {
- if ( in_array( $this->get_content_type(), array( 'text/html', 'multipart/alternative' ), true ) ) {
- ob_start();
- wc_get_template( 'emails/email-styles.php' );
- $css = apply_filters( 'woocommerce_email_styles', ob_get_clean(), $this );
-
- $emogrifier_class = 'Pelago\\Emogrifier';
-
- if ( $this->supports_emogrifier() && class_exists( $emogrifier_class ) ) {
- try {
- $emogrifier = new $emogrifier_class( $content, $css );
-
- do_action( 'woocommerce_emogrifier', $emogrifier, $this );
-
- $content = $emogrifier->emogrify();
- $html_prune = \Pelago\Emogrifier\HtmlProcessor\HtmlPruner::fromHtml( $content );
- $html_prune->removeElementsWithDisplayNone();
- $content = $html_prune->render();
- } catch ( Exception $e ) {
- $logger = wc_get_logger();
- $logger->error( $e->getMessage(), array( 'source' => 'emogrifier' ) );
- }
- } else {
- $content = '' . $content;
- }
- }
-
- return $content;
- }
-
- /**
- * Return if emogrifier library is supported.
- *
- * @version 4.0.0
- * @since 3.5.0
- * @return bool
- */
- protected function supports_emogrifier() {
- return class_exists( 'DOMDocument' );
- }
-
- /**
- * Get the email content in plain text format.
- *
- * @return string
- */
- public function get_content_plain() {
- return ''; }
-
- /**
- * Get the email content in HTML format.
- *
- * @return string
- */
- public function get_content_html() {
- return ''; }
-
- /**
- * Get the from name for outgoing emails.
- *
- * @param string $from_name Default wp_mail() name associated with the "from" email address.
- * @return string
- */
- public function get_from_name( $from_name = '' ) {
- $from_name = apply_filters( 'woocommerce_email_from_name', get_option( 'woocommerce_email_from_name' ), $this, $from_name );
- return wp_specialchars_decode( esc_html( $from_name ), ENT_QUOTES );
- }
-
- /**
- * Get the from address for outgoing emails.
- *
- * @param string $from_email Default wp_mail() email address to send from.
- * @return string
- */
- public function get_from_address( $from_email = '' ) {
- $from_email = apply_filters( 'woocommerce_email_from_address', get_option( 'woocommerce_email_from_address' ), $this, $from_email );
- return sanitize_email( $from_email );
- }
-
- /**
- * Send an email.
- *
- * @param string $to Email to.
- * @param string $subject Email subject.
- * @param string $message Email message.
- * @param string $headers Email headers.
- * @param array $attachments Email attachments.
- * @return bool success
- */
- public function send( $to, $subject, $message, $headers, $attachments ) {
- add_filter( 'wp_mail_from', array( $this, 'get_from_address' ) );
- add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ) );
- add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
-
- $message = apply_filters( 'woocommerce_mail_content', $this->style_inline( $message ) );
- $mail_callback = apply_filters( 'woocommerce_mail_callback', 'wp_mail', $this );
- $mail_callback_params = apply_filters( 'woocommerce_mail_callback_params', array( $to, $subject, $message, $headers, $attachments ), $this );
- $return = $mail_callback( ...$mail_callback_params );
-
- remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ) );
- remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ) );
- remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
-
- return $return;
- }
-
- /**
- * Initialise Settings Form Fields - these are generic email options most will use.
- */
- public function init_form_fields() {
- /* translators: %s: list of placeholders */
- $placeholder_text = sprintf( __( 'Available placeholders: %s', 'woocommerce' ), '' . esc_html( implode( ', ', array_keys( $this->placeholders ) ) ) . '' );
- $this->form_fields = array(
- 'enabled' => array(
- 'title' => __( 'Enable/Disable', 'woocommerce' ),
- 'type' => 'checkbox',
- 'label' => __( 'Enable this email notification', 'woocommerce' ),
- 'default' => 'yes',
- ),
- 'subject' => array(
- 'title' => __( 'Subject', 'woocommerce' ),
- 'type' => 'text',
- 'desc_tip' => true,
- 'description' => $placeholder_text,
- 'placeholder' => $this->get_default_subject(),
- 'default' => '',
- ),
- 'heading' => array(
- 'title' => __( 'Email heading', 'woocommerce' ),
- 'type' => 'text',
- 'desc_tip' => true,
- 'description' => $placeholder_text,
- 'placeholder' => $this->get_default_heading(),
- 'default' => '',
- ),
- 'additional_content' => array(
- 'title' => __( 'Additional content', 'woocommerce' ),
- 'description' => __( 'Text to appear below the main email content.', 'woocommerce' ) . ' ' . $placeholder_text,
- 'css' => 'width:400px; height: 75px;',
- 'placeholder' => __( 'N/A', 'woocommerce' ),
- 'type' => 'textarea',
- 'default' => $this->get_default_additional_content(),
- 'desc_tip' => true,
- ),
- 'email_type' => array(
- 'title' => __( 'Email type', 'woocommerce' ),
- 'type' => 'select',
- 'description' => __( 'Choose which format of email to send.', 'woocommerce' ),
- 'default' => 'html',
- 'class' => 'email_type wc-enhanced-select',
- 'options' => $this->get_email_type_options(),
- 'desc_tip' => true,
- ),
- );
- }
-
- /**
- * Email type options.
- *
- * @return array
- */
- public function get_email_type_options() {
- $types = array( 'plain' => __( 'Plain text', 'woocommerce' ) );
-
- if ( class_exists( 'DOMDocument' ) ) {
- $types['html'] = __( 'HTML', 'woocommerce' );
- $types['multipart'] = __( 'Multipart', 'woocommerce' );
- }
-
- return $types;
- }
-
- /**
- * Admin Panel Options Processing.
- */
- public function process_admin_options() {
- // Save regular options.
- parent::process_admin_options();
-
- $post_data = $this->get_post_data();
-
- // Save templates.
- if ( isset( $post_data['template_html_code'] ) ) {
- $this->save_template( $post_data['template_html_code'], $this->template_html );
- }
- if ( isset( $post_data['template_plain_code'] ) ) {
- $this->save_template( $post_data['template_plain_code'], $this->template_plain );
- }
- }
-
- /**
- * Get template.
- *
- * @param string $type Template type. Can be either 'template_html' or 'template_plain'.
- * @return string
- */
- public function get_template( $type ) {
- $type = basename( $type );
-
- if ( 'template_html' === $type ) {
- return $this->template_html;
- } elseif ( 'template_plain' === $type ) {
- return $this->template_plain;
- }
- return '';
- }
-
- /**
- * Save the email templates.
- *
- * @since 2.4.0
- * @param string $template_code Template code.
- * @param string $template_path Template path.
- */
- protected function save_template( $template_code, $template_path ) {
- if ( current_user_can( 'edit_themes' ) && ! empty( $template_code ) && ! empty( $template_path ) ) {
- $saved = false;
- $file = get_stylesheet_directory() . '/' . WC()->template_path() . $template_path;
- $code = wp_unslash( $template_code );
-
- if ( is_writeable( $file ) ) { // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writeable
- $f = fopen( $file, 'w+' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fopen
-
- if ( false !== $f ) {
- fwrite( $f, $code ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fwrite
- fclose( $f ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fclose
- $saved = true;
- }
- }
-
- if ( ! $saved ) {
- $redirect = add_query_arg( 'wc_error', rawurlencode( __( 'Could not write to template file.', 'woocommerce' ) ) );
- wp_safe_redirect( $redirect );
- exit;
- }
- }
- }
-
- /**
- * Get the template file in the current theme.
- *
- * @param string $template Template name.
- *
- * @return string
- */
- public function get_theme_template_file( $template ) {
- return get_stylesheet_directory() . '/' . apply_filters( 'woocommerce_template_directory', 'woocommerce', $template ) . '/' . $template;
- }
-
- /**
- * Move template action.
- *
- * @param string $template_type Template type.
- */
- protected function move_template_action( $template_type ) {
- $template = $this->get_template( $template_type );
- if ( ! empty( $template ) ) {
- $theme_file = $this->get_theme_template_file( $template );
-
- if ( wp_mkdir_p( dirname( $theme_file ) ) && ! file_exists( $theme_file ) ) {
-
- // Locate template file.
- $core_file = $this->template_base . $template;
- $template_file = apply_filters( 'woocommerce_locate_core_template', $core_file, $template, $this->template_base, $this->id );
-
- // Copy template file.
- copy( $template_file, $theme_file );
-
- /**
- * Action hook fired after copying email template file.
- *
- * @param string $template_type The copied template type
- * @param string $email The email object
- */
- do_action( 'woocommerce_copy_email_template', $template_type, $this );
-
- ?>
- - - - - - - - - - ' . esc_html( trailingslashit( basename( get_stylesheet_directory() ) ) . $template_dir . '/' . $template ) . '' ); - ?> -
- - - -
-
-
-
-
-
-
-
-
- ' . esc_html( plugin_basename( $template_file ) ) . '', '' . esc_html( trailingslashit( basename( get_stylesheet_directory() ) ) . $template_dir . '/' . $template ) . '' );
- ?>
-
- : -
-' . WC_Log_Handler_File::get_log_file_path( 'paypal' ) . '' ),
- ),
- 'ipn_notification' => array(
- 'title' => __( 'IPN Email Notifications', 'woocommerce' ),
- 'type' => 'checkbox',
- 'label' => __( 'Enable IPN email notifications', 'woocommerce' ),
- 'default' => 'yes',
- 'description' => __( 'Send notifications when an IPN is received from PayPal indicating refunds, chargebacks and cancellations.', 'woocommerce' ),
- ),
- 'receiver_email' => array(
- 'title' => __( 'Receiver email', 'woocommerce' ),
- 'type' => 'email',
- 'description' => __( 'If your main PayPal email differs from the PayPal email entered above, input your main receiver email for your PayPal account here. This is used to validate IPN requests.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- 'placeholder' => 'you@youremail.com',
- ),
- 'identity_token' => array(
- 'title' => __( 'PayPal identity token', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'Optionally enable "Payment Data Transfer" (Profile > Profile and Settings > My Selling Tools > Website Preferences) and then copy your identity token here. This will allow payments to be verified without the need for PayPal IPN.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- 'placeholder' => '',
- ),
- 'invoice_prefix' => array(
- 'title' => __( 'Invoice prefix', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'Please enter a prefix for your invoice numbers. If you use your PayPal account for multiple stores ensure this prefix is unique as PayPal will not allow orders with the same invoice number.', 'woocommerce' ),
- 'default' => 'WC-',
- 'desc_tip' => true,
- ),
- 'send_shipping' => array(
- 'title' => __( 'Shipping details', 'woocommerce' ),
- 'type' => 'checkbox',
- 'label' => __( 'Send shipping details to PayPal instead of billing.', 'woocommerce' ),
- 'description' => __( 'PayPal allows us to send one address. If you are using PayPal for shipping labels you may prefer to send the shipping address rather than billing. Turning this option off may prevent PayPal Seller protection from applying.', 'woocommerce' ),
- 'default' => 'yes',
- ),
- 'address_override' => array(
- 'title' => __( 'Address override', 'woocommerce' ),
- 'type' => 'checkbox',
- 'label' => __( 'Enable "address_override" to prevent address information from being changed.', 'woocommerce' ),
- 'description' => __( 'PayPal verifies addresses therefore this setting can cause errors (we recommend keeping it disabled).', 'woocommerce' ),
- 'default' => 'no',
- ),
- 'paymentaction' => array(
- 'title' => __( 'Payment action', 'woocommerce' ),
- 'type' => 'select',
- 'class' => 'wc-enhanced-select',
- 'description' => __( 'Choose whether you wish to capture funds immediately or authorize payment only.', 'woocommerce' ),
- 'default' => 'sale',
- 'desc_tip' => true,
- 'options' => array(
- 'sale' => __( 'Capture', 'woocommerce' ),
- 'authorization' => __( 'Authorize', 'woocommerce' ),
- ),
- ),
- 'image_url' => array(
- 'title' => __( 'Image url', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'Optionally enter the URL to a 150x50px image displayed as your logo in the upper left corner of the PayPal checkout pages.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- 'placeholder' => __( 'Optional', 'woocommerce' ),
- ),
- 'api_details' => array(
- 'title' => __( 'API credentials', 'woocommerce' ),
- 'type' => 'title',
- /* translators: %s: URL */
- 'description' => sprintf( __( 'Enter your PayPal API credentials to process refunds via PayPal. Learn how to access your PayPal API Credentials.', 'woocommerce' ), 'https://developer.paypal.com/webapps/developer/docs/classic/api/apiCredentials/#create-an-api-signature' ),
- ),
- 'api_username' => array(
- 'title' => __( 'Live API username', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'Get your API credentials from PayPal.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- 'placeholder' => __( 'Optional', 'woocommerce' ),
- ),
- 'api_password' => array(
- 'title' => __( 'Live API password', 'woocommerce' ),
- 'type' => 'password',
- 'description' => __( 'Get your API credentials from PayPal.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- 'placeholder' => __( 'Optional', 'woocommerce' ),
- ),
- 'api_signature' => array(
- 'title' => __( 'Live API signature', 'woocommerce' ),
- 'type' => 'password',
- 'description' => __( 'Get your API credentials from PayPal.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- 'placeholder' => __( 'Optional', 'woocommerce' ),
- ),
- 'sandbox_api_username' => array(
- 'title' => __( 'Sandbox API username', 'woocommerce' ),
- 'type' => 'text',
- 'description' => __( 'Get your API credentials from PayPal.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- 'placeholder' => __( 'Optional', 'woocommerce' ),
- ),
- 'sandbox_api_password' => array(
- 'title' => __( 'Sandbox API password', 'woocommerce' ),
- 'type' => 'password',
- 'description' => __( 'Get your API credentials from PayPal.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- 'placeholder' => __( 'Optional', 'woocommerce' ),
- ),
- 'sandbox_api_signature' => array(
- 'title' => __( 'Sandbox API signature', 'woocommerce' ),
- 'type' => 'password',
- 'description' => __( 'Get your API credentials from PayPal.', 'woocommerce' ),
- 'default' => '',
- 'desc_tip' => true,
- 'placeholder' => __( 'Optional', 'woocommerce' ),
- ),
-);
diff --git a/includes/import/class-wc-product-csv-importer.php b/includes/import/class-wc-product-csv-importer.php
deleted file mode 100644
index c9c11f44684..00000000000
--- a/includes/import/class-wc-product-csv-importer.php
+++ /dev/null
@@ -1,1128 +0,0 @@
- 0, // File pointer start.
- 'end_pos' => -1, // File pointer end.
- 'lines' => -1, // Max lines to read.
- 'mapping' => array(), // Column mapping. csv_heading => schema_heading.
- 'parse' => false, // Whether to sanitize and format data.
- 'update_existing' => false, // Whether to update existing items.
- 'delimiter' => ',', // CSV delimiter.
- 'prevent_timeouts' => true, // Check memory and time usage and abort if reaching limit.
- 'enclosure' => '"', // The character used to wrap text in the CSV.
- 'escape' => "\0", // PHP uses '\' as the default escape character. This is not RFC-4180 compliant. This disables the escape character.
- );
-
- $this->params = wp_parse_args( $params, $default_args );
- $this->file = $file;
-
- if ( isset( $this->params['mapping']['from'], $this->params['mapping']['to'] ) ) {
- $this->params['mapping'] = array_combine( $this->params['mapping']['from'], $this->params['mapping']['to'] );
- }
-
- // Import mappings for CSV data.
- include_once dirname( dirname( __FILE__ ) ) . '/admin/importers/mappings/mappings.php';
-
- $this->read_file();
- }
-
- /**
- * Read file.
- */
- protected function read_file() {
- if ( ! WC_Product_CSV_Importer_Controller::is_file_valid_csv( $this->file ) ) {
- wp_die( esc_html__( 'Invalid file type. The importer supports CSV and TXT file formats.', 'woocommerce' ) );
- }
-
- $handle = fopen( $this->file, 'r' ); // @codingStandardsIgnoreLine.
-
- if ( false !== $handle ) {
- $this->raw_keys = version_compare( PHP_VERSION, '5.3', '>=' ) ? array_map( 'trim', fgetcsv( $handle, 0, $this->params['delimiter'], $this->params['enclosure'], $this->params['escape'] ) ) : array_map( 'trim', fgetcsv( $handle, 0, $this->params['delimiter'], $this->params['enclosure'] ) ); // @codingStandardsIgnoreLine
-
- // Remove BOM signature from the first item.
- if ( isset( $this->raw_keys[0] ) ) {
- $this->raw_keys[0] = $this->remove_utf8_bom( $this->raw_keys[0] );
- }
-
- if ( 0 !== $this->params['start_pos'] ) {
- fseek( $handle, (int) $this->params['start_pos'] );
- }
-
- while ( 1 ) {
- $row = version_compare( PHP_VERSION, '5.3', '>=' ) ? fgetcsv( $handle, 0, $this->params['delimiter'], $this->params['enclosure'], $this->params['escape'] ) : fgetcsv( $handle, 0, $this->params['delimiter'], $this->params['enclosure'] ); // @codingStandardsIgnoreLine
-
- if ( false !== $row ) {
- $this->raw_data[] = $row;
- $this->file_positions[ count( $this->raw_data ) ] = ftell( $handle );
-
- if ( ( $this->params['end_pos'] > 0 && ftell( $handle ) >= $this->params['end_pos'] ) || 0 === --$this->params['lines'] ) {
- break;
- }
- } else {
- break;
- }
- }
-
- $this->file_position = ftell( $handle );
- }
-
- if ( ! empty( $this->params['mapping'] ) ) {
- $this->set_mapped_keys();
- }
-
- if ( $this->params['parse'] ) {
- $this->set_parsed_data();
- }
- }
-
- /**
- * Remove UTF-8 BOM signature.
- *
- * @param string $string String to handle.
- *
- * @return string
- */
- protected function remove_utf8_bom( $string ) {
- if ( 'efbbbf' === substr( bin2hex( $string ), 0, 6 ) ) {
- $string = substr( $string, 3 );
- }
-
- return $string;
- }
-
- /**
- * Set file mapped keys.
- */
- protected function set_mapped_keys() {
- $mapping = $this->params['mapping'];
-
- foreach ( $this->raw_keys as $key ) {
- $this->mapped_keys[] = isset( $mapping[ $key ] ) ? $mapping[ $key ] : $key;
- }
- }
-
- /**
- * Parse relative field and return product ID.
- *
- * Handles `id:xx` and SKUs.
- *
- * If mapping to an id: and the product ID does not exist, this link is not
- * valid.
- *
- * If mapping to a SKU and the product ID does not exist, a temporary object
- * will be created so it can be updated later.
- *
- * @param string $value Field value.
- *
- * @return int|string
- */
- public function parse_relative_field( $value ) {
- global $wpdb;
-
- if ( empty( $value ) ) {
- return '';
- }
-
- // IDs are prefixed with id:.
- if ( preg_match( '/^id:(\d+)$/', $value, $matches ) ) {
- $id = intval( $matches[1] );
-
- // If original_id is found, use that instead of the given ID since a new placeholder must have been created already.
- $original_id = $wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM {$wpdb->postmeta} WHERE meta_key = '_original_id' AND meta_value = %s;", $id ) ); // WPCS: db call ok, cache ok.
-
- if ( $original_id ) {
- return absint( $original_id );
- }
-
- // See if the given ID maps to a valid product allready.
- $existing_id = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE post_type IN ( 'product', 'product_variation' ) AND ID = %d;", $id ) ); // WPCS: db call ok, cache ok.
-
- if ( $existing_id ) {
- return absint( $existing_id );
- }
-
- // If we're not updating existing posts, we may need a placeholder product to map to.
- if ( ! $this->params['update_existing'] ) {
- $product = wc_get_product_object( 'simple' );
- $product->set_name( 'Import placeholder for ' . $id );
- $product->set_status( 'importing' );
- $product->add_meta_data( '_original_id', $id, true );
- $id = $product->save();
- }
-
- return $id;
- }
-
- $id = wc_get_product_id_by_sku( $value );
-
- if ( $id ) {
- return $id;
- }
-
- try {
- $product = wc_get_product_object( 'simple' );
- $product->set_name( 'Import placeholder for ' . $value );
- $product->set_status( 'importing' );
- $product->set_sku( $value );
- $id = $product->save();
-
- if ( $id && ! is_wp_error( $id ) ) {
- return $id;
- }
- } catch ( Exception $e ) {
- return '';
- }
-
- return '';
- }
-
- /**
- * Parse the ID field.
- *
- * If we're not doing an update, create a placeholder product so mapping works
- * for rows following this one.
- *
- * @param string $value Field value.
- *
- * @return int
- */
- public function parse_id_field( $value ) {
- global $wpdb;
-
- $id = absint( $value );
-
- if ( ! $id ) {
- return 0;
- }
-
- // See if this maps to an ID placeholder already.
- $original_id = $wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM {$wpdb->postmeta} WHERE meta_key = '_original_id' AND meta_value = %s;", $id ) ); // WPCS: db call ok, cache ok.
-
- if ( $original_id ) {
- return absint( $original_id );
- }
-
- // Not updating? Make sure we have a new placeholder for this ID.
- if ( ! $this->params['update_existing'] ) {
- $mapped_keys = $this->get_mapped_keys();
- $sku_column_index = absint( array_search( 'sku', $mapped_keys, true ) );
- $row_sku = isset( $this->raw_data[ $this->parsing_raw_data_index ][ $sku_column_index ] ) ? $this->raw_data[ $this->parsing_raw_data_index ][ $sku_column_index ] : '';
- $id_from_sku = $row_sku ? wc_get_product_id_by_sku( $row_sku ) : '';
-
- // If row has a SKU, make sure placeholder was not made already.
- if ( $id_from_sku ) {
- return $id_from_sku;
- }
-
- $product = wc_get_product_object( 'simple' );
- $product->set_name( 'Import placeholder for ' . $id );
- $product->set_status( 'importing' );
- $product->add_meta_data( '_original_id', $id, true );
-
- // If row has a SKU, make sure placeholder has it too.
- if ( $row_sku ) {
- $product->set_sku( $row_sku );
- }
- $id = $product->save();
- }
-
- return $id && ! is_wp_error( $id ) ? $id : 0;
- }
-
- /**
- * Parse relative comma-delineated field and return product ID.
- *
- * @param string $value Field value.
- *
- * @return array
- */
- public function parse_relative_comma_field( $value ) {
- if ( empty( $value ) ) {
- return array();
- }
-
- return array_filter( array_map( array( $this, 'parse_relative_field' ), $this->explode_values( $value ) ) );
- }
-
- /**
- * Parse a comma-delineated field from a CSV.
- *
- * @param string $value Field value.
- *
- * @return array
- */
- public function parse_comma_field( $value ) {
- if ( empty( $value ) && '0' !== $value ) {
- return array();
- }
-
- $value = $this->unescape_data( $value );
- return array_map( 'wc_clean', $this->explode_values( $value ) );
- }
-
- /**
- * Parse a field that is generally '1' or '0' but can be something else.
- *
- * @param string $value Field value.
- *
- * @return bool|string
- */
- public function parse_bool_field( $value ) {
- if ( '0' === $value ) {
- return false;
- }
-
- if ( '1' === $value ) {
- return true;
- }
-
- // Don't return explicit true or false for empty fields or values like 'notify'.
- return wc_clean( $value );
- }
-
- /**
- * Parse a float value field.
- *
- * @param string $value Field value.
- *
- * @return float|string
- */
- public function parse_float_field( $value ) {
- if ( '' === $value ) {
- return $value;
- }
-
- // Remove the ' prepended to fields that start with - if needed.
- $value = $this->unescape_data( $value );
-
- return floatval( $value );
- }
-
- /**
- * Parse the stock qty field.
- *
- * @param string $value Field value.
- *
- * @return float|string
- */
- public function parse_stock_quantity_field( $value ) {
- if ( '' === $value ) {
- return $value;
- }
-
- // Remove the ' prepended to fields that start with - if needed.
- $value = $this->unescape_data( $value );
-
- return wc_stock_amount( $value );
- }
-
- /**
- * Parse the tax status field.
- *
- * @param string $value Field value.
- *
- * @return string
- */
- public function parse_tax_status_field( $value ) {
- if ( '' === $value ) {
- return $value;
- }
-
- // Remove the ' prepended to fields that start with - if needed.
- $value = $this->unescape_data( $value );
-
- if ( 'true' === strtolower( $value ) || 'false' === strtolower( $value ) ) {
- $value = wc_string_to_bool( $value ) ? 'taxable' : 'none';
- }
-
- return wc_clean( $value );
- }
-
- /**
- * Parse a category field from a CSV.
- * Categories are separated by commas and subcategories are "parent > subcategory".
- *
- * @param string $value Field value.
- *
- * @return array of arrays with "parent" and "name" keys.
- */
- public function parse_categories_field( $value ) {
- if ( empty( $value ) ) {
- return array();
- }
-
- $row_terms = $this->explode_values( $value );
- $categories = array();
-
- foreach ( $row_terms as $row_term ) {
- $parent = null;
- $_terms = array_map( 'trim', explode( '>', $row_term ) );
- $total = count( $_terms );
-
- foreach ( $_terms as $index => $_term ) {
- // Don't allow users without capabilities to create new categories.
- if ( ! current_user_can( 'manage_product_terms' ) ) {
- break;
- }
-
- $term = wp_insert_term( $_term, 'product_cat', array( 'parent' => intval( $parent ) ) );
-
- if ( is_wp_error( $term ) ) {
- if ( $term->get_error_code() === 'term_exists' ) {
- // When term exists, error data should contain existing term id.
- $term_id = $term->get_error_data();
- } else {
- break; // We cannot continue on any other error.
- }
- } else {
- // New term.
- $term_id = $term['term_id'];
- }
-
- // Only requires assign the last category.
- if ( ( 1 + $index ) === $total ) {
- $categories[] = $term_id;
- } else {
- // Store parent to be able to insert or query categories based in parent ID.
- $parent = $term_id;
- }
- }
- }
-
- return $categories;
- }
-
- /**
- * Parse a tag field from a CSV.
- *
- * @param string $value Field value.
- *
- * @return array
- */
- public function parse_tags_field( $value ) {
- if ( empty( $value ) ) {
- return array();
- }
-
- $value = $this->unescape_data( $value );
- $names = $this->explode_values( $value );
- $tags = array();
-
- foreach ( $names as $name ) {
- $term = get_term_by( 'name', $name, 'product_tag' );
-
- if ( ! $term || is_wp_error( $term ) ) {
- $term = (object) wp_insert_term( $name, 'product_tag' );
- }
-
- if ( ! is_wp_error( $term ) ) {
- $tags[] = $term->term_id;
- }
- }
-
- return $tags;
- }
-
- /**
- * Parse a tag field from a CSV with space separators.
- *
- * @param string $value Field value.
- *
- * @return array
- */
- public function parse_tags_spaces_field( $value ) {
- if ( empty( $value ) ) {
- return array();
- }
-
- $value = $this->unescape_data( $value );
- $names = $this->explode_values( $value, ' ' );
- $tags = array();
-
- foreach ( $names as $name ) {
- $term = get_term_by( 'name', $name, 'product_tag' );
-
- if ( ! $term || is_wp_error( $term ) ) {
- $term = (object) wp_insert_term( $name, 'product_tag' );
- }
-
- if ( ! is_wp_error( $term ) ) {
- $tags[] = $term->term_id;
- }
- }
-
- return $tags;
- }
-
- /**
- * Parse a shipping class field from a CSV.
- *
- * @param string $value Field value.
- *
- * @return int
- */
- public function parse_shipping_class_field( $value ) {
- if ( empty( $value ) ) {
- return 0;
- }
-
- $term = get_term_by( 'name', $value, 'product_shipping_class' );
-
- if ( ! $term || is_wp_error( $term ) ) {
- $term = (object) wp_insert_term( $value, 'product_shipping_class' );
- }
-
- if ( is_wp_error( $term ) ) {
- return 0;
- }
-
- return $term->term_id;
- }
-
- /**
- * Parse images list from a CSV. Images can be filenames or URLs.
- *
- * @param string $value Field value.
- *
- * @return array
- */
- public function parse_images_field( $value ) {
- if ( empty( $value ) ) {
- return array();
- }
-
- $images = array();
- $separator = apply_filters( 'woocommerce_product_import_image_separator', ',' );
-
- foreach ( $this->explode_values( $value, $separator ) as $image ) {
- if ( stristr( $image, '://' ) ) {
- $images[] = esc_url_raw( $image );
- } else {
- $images[] = sanitize_file_name( $image );
- }
- }
-
- return $images;
- }
-
- /**
- * Parse dates from a CSV.
- * Dates requires the format YYYY-MM-DD and time is optional.
- *
- * @param string $value Field value.
- *
- * @return string|null
- */
- public function parse_date_field( $value ) {
- if ( empty( $value ) ) {
- return null;
- }
-
- if ( preg_match( '/^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])([ 01-9:]*)$/', $value ) ) {
- // Don't include the time if the field had time in it.
- return current( explode( ' ', $value ) );
- }
-
- return null;
- }
-
- /**
- * Parse backorders from a CSV.
- *
- * @param string $value Field value.
- *
- * @return string
- */
- public function parse_backorders_field( $value ) {
- if ( empty( $value ) ) {
- return 'no';
- }
-
- $value = $this->parse_bool_field( $value );
-
- if ( 'notify' === $value ) {
- return 'notify';
- } elseif ( is_bool( $value ) ) {
- return $value ? 'yes' : 'no';
- }
-
- return 'no';
- }
-
- /**
- * Just skip current field.
- *
- * By default is applied wc_clean() to all not listed fields
- * in self::get_formatting_callback(), use this method to skip any formatting.
- *
- * @param string $value Field value.
- *
- * @return string
- */
- public function parse_skip_field( $value ) {
- return $value;
- }
-
- /**
- * Parse download file urls, we should allow shortcodes here.
- *
- * Allow shortcodes if present, othersiwe esc_url the value.
- *
- * @param string $value Field value.
- *
- * @return string
- */
- public function parse_download_file_field( $value ) {
- // Absolute file paths.
- if ( 0 === strpos( $value, 'http' ) ) {
- return esc_url_raw( $value );
- }
- // Relative and shortcode paths.
- return wc_clean( $value );
- }
-
- /**
- * Parse an int value field
- *
- * @param int $value field value.
- *
- * @return int
- */
- public function parse_int_field( $value ) {
- // Remove the ' prepended to fields that start with - if needed.
- $value = $this->unescape_data( $value );
-
- return intval( $value );
- }
-
- /**
- * Parse a description value field
- *
- * @param string $description field value.
- *
- * @return string
- */
- public function parse_description_field( $description ) {
- $parts = explode( "\\\\n", $description );
- foreach ( $parts as $key => $part ) {
- $parts[ $key ] = str_replace( '\n', "\n", $part );
- }
-
- return implode( '\\\n', $parts );
- }
-
- /**
- * Parse the published field. 1 is published, 0 is private, -1 is draft.
- * Alternatively, 'true' can be used for published and 'false' for draft.
- *
- * @param string $value Field value.
- *
- * @return float|string
- */
- public function parse_published_field( $value ) {
- if ( '' === $value ) {
- return $value;
- }
-
- // Remove the ' prepended to fields that start with - if needed.
- $value = $this->unescape_data( $value );
-
- if ( 'true' === strtolower( $value ) || 'false' === strtolower( $value ) ) {
- return wc_string_to_bool( $value ) ? 1 : -1;
- }
-
- return floatval( $value );
- }
-
- /**
- * Deprecated get formatting callback method.
- *
- * @deprecated 4.3.0
- * @return array
- */
- protected function get_formating_callback() {
- return $this->get_formatting_callback();
- }
-
- /**
- * Get formatting callback.
- *
- * @since 4.3.0
- * @return array
- */
- protected function get_formatting_callback() {
-
- /**
- * Columns not mentioned here will get parsed with 'wc_clean'.
- * column_name => callback.
- */
- $data_formatting = array(
- 'id' => array( $this, 'parse_id_field' ),
- 'type' => array( $this, 'parse_comma_field' ),
- 'published' => array( $this, 'parse_published_field' ),
- 'featured' => array( $this, 'parse_bool_field' ),
- 'date_on_sale_from' => array( $this, 'parse_date_field' ),
- 'date_on_sale_to' => array( $this, 'parse_date_field' ),
- 'name' => array( $this, 'parse_skip_field' ),
- 'short_description' => array( $this, 'parse_description_field' ),
- 'description' => array( $this, 'parse_description_field' ),
- 'manage_stock' => array( $this, 'parse_bool_field' ),
- 'low_stock_amount' => array( $this, 'parse_stock_quantity_field' ),
- 'backorders' => array( $this, 'parse_backorders_field' ),
- 'stock_status' => array( $this, 'parse_bool_field' ),
- 'sold_individually' => array( $this, 'parse_bool_field' ),
- 'width' => array( $this, 'parse_float_field' ),
- 'length' => array( $this, 'parse_float_field' ),
- 'height' => array( $this, 'parse_float_field' ),
- 'weight' => array( $this, 'parse_float_field' ),
- 'reviews_allowed' => array( $this, 'parse_bool_field' ),
- 'purchase_note' => 'wp_filter_post_kses',
- 'price' => 'wc_format_decimal',
- 'regular_price' => 'wc_format_decimal',
- 'stock_quantity' => array( $this, 'parse_stock_quantity_field' ),
- 'category_ids' => array( $this, 'parse_categories_field' ),
- 'tag_ids' => array( $this, 'parse_tags_field' ),
- 'tag_ids_spaces' => array( $this, 'parse_tags_spaces_field' ),
- 'shipping_class_id' => array( $this, 'parse_shipping_class_field' ),
- 'images' => array( $this, 'parse_images_field' ),
- 'parent_id' => array( $this, 'parse_relative_field' ),
- 'grouped_products' => array( $this, 'parse_relative_comma_field' ),
- 'upsell_ids' => array( $this, 'parse_relative_comma_field' ),
- 'cross_sell_ids' => array( $this, 'parse_relative_comma_field' ),
- 'download_limit' => array( $this, 'parse_int_field' ),
- 'download_expiry' => array( $this, 'parse_int_field' ),
- 'product_url' => 'esc_url_raw',
- 'menu_order' => 'intval',
- 'tax_status' => array( $this, 'parse_tax_status_field' ),
- );
-
- /**
- * Match special column names.
- */
- $regex_match_data_formatting = array(
- '/attributes:value*/' => array( $this, 'parse_comma_field' ),
- '/attributes:visible*/' => array( $this, 'parse_bool_field' ),
- '/attributes:taxonomy*/' => array( $this, 'parse_bool_field' ),
- '/downloads:url*/' => array( $this, 'parse_download_file_field' ),
- '/meta:*/' => 'wp_kses_post', // Allow some HTML in meta fields.
- );
-
- $callbacks = array();
-
- // Figure out the parse function for each column.
- foreach ( $this->get_mapped_keys() as $index => $heading ) {
- $callback = 'wc_clean';
-
- if ( isset( $data_formatting[ $heading ] ) ) {
- $callback = $data_formatting[ $heading ];
- } else {
- foreach ( $regex_match_data_formatting as $regex => $callback ) {
- if ( preg_match( $regex, $heading ) ) {
- $callback = $callback;
- break;
- }
- }
- }
-
- $callbacks[] = $callback;
- }
-
- return apply_filters( 'woocommerce_product_importer_formatting_callbacks', $callbacks, $this );
- }
-
- /**
- * Check if strings starts with determined word.
- *
- * @param string $haystack Complete sentence.
- * @param string $needle Excerpt.
- *
- * @return bool
- */
- protected function starts_with( $haystack, $needle ) {
- return substr( $haystack, 0, strlen( $needle ) ) === $needle;
- }
-
- /**
- * Expand special and internal data into the correct formats for the product CRUD.
- *
- * @param array $data Data to import.
- *
- * @return array
- */
- protected function expand_data( $data ) {
- $data = apply_filters( 'woocommerce_product_importer_pre_expand_data', $data );
-
- // Images field maps to image and gallery id fields.
- if ( isset( $data['images'] ) ) {
- $images = $data['images'];
- $data['raw_image_id'] = array_shift( $images );
-
- if ( ! empty( $images ) ) {
- $data['raw_gallery_image_ids'] = $images;
- }
- unset( $data['images'] );
- }
-
- // Type, virtual and downloadable are all stored in the same column.
- if ( isset( $data['type'] ) ) {
- $data['type'] = array_map( 'strtolower', $data['type'] );
- $data['virtual'] = in_array( 'virtual', $data['type'], true );
- $data['downloadable'] = in_array( 'downloadable', $data['type'], true );
-
- // Convert type to string.
- $data['type'] = current( array_diff( $data['type'], array( 'virtual', 'downloadable' ) ) );
-
- if ( ! $data['type'] ) {
- $data['type'] = 'simple';
- }
- }
-
- // Status is mapped from a special published field.
- if ( isset( $data['published'] ) ) {
- $statuses = array(
- -1 => 'draft',
- 0 => 'private',
- 1 => 'publish',
- );
- $data['status'] = isset( $statuses[ $data['published'] ] ) ? $statuses[ $data['published'] ] : 'draft';
-
- // Fix draft status of variations.
- if ( isset( $data['type'] ) && 'variation' === $data['type'] && -1 === $data['published'] ) {
- $data['status'] = 'publish';
- }
-
- unset( $data['published'] );
- }
-
- if ( isset( $data['stock_quantity'] ) ) {
- if ( '' === $data['stock_quantity'] ) {
- $data['manage_stock'] = false;
- $data['stock_status'] = isset( $data['stock_status'] ) ? $data['stock_status'] : true;
- } else {
- $data['manage_stock'] = true;
- }
- }
-
- // Stock is bool or 'backorder'.
- if ( isset( $data['stock_status'] ) ) {
- if ( 'backorder' === $data['stock_status'] ) {
- $data['stock_status'] = 'onbackorder';
- } else {
- $data['stock_status'] = $data['stock_status'] ? 'instock' : 'outofstock';
- }
- }
-
- // Prepare grouped products.
- if ( isset( $data['grouped_products'] ) ) {
- $data['children'] = $data['grouped_products'];
- unset( $data['grouped_products'] );
- }
-
- // Tag ids.
- if ( isset( $data['tag_ids_spaces'] ) ) {
- $data['tag_ids'] = $data['tag_ids_spaces'];
- unset( $data['tag_ids_spaces'] );
- }
-
- // Handle special column names which span multiple columns.
- $attributes = array();
- $downloads = array();
- $meta_data = array();
-
- foreach ( $data as $key => $value ) {
- if ( $this->starts_with( $key, 'attributes:name' ) ) {
- if ( ! empty( $value ) ) {
- $attributes[ str_replace( 'attributes:name', '', $key ) ]['name'] = $value;
- }
- unset( $data[ $key ] );
-
- } elseif ( $this->starts_with( $key, 'attributes:value' ) ) {
- $attributes[ str_replace( 'attributes:value', '', $key ) ]['value'] = $value;
- unset( $data[ $key ] );
-
- } elseif ( $this->starts_with( $key, 'attributes:taxonomy' ) ) {
- $attributes[ str_replace( 'attributes:taxonomy', '', $key ) ]['taxonomy'] = wc_string_to_bool( $value );
- unset( $data[ $key ] );
-
- } elseif ( $this->starts_with( $key, 'attributes:visible' ) ) {
- $attributes[ str_replace( 'attributes:visible', '', $key ) ]['visible'] = wc_string_to_bool( $value );
- unset( $data[ $key ] );
-
- } elseif ( $this->starts_with( $key, 'attributes:default' ) ) {
- if ( ! empty( $value ) ) {
- $attributes[ str_replace( 'attributes:default', '', $key ) ]['default'] = $value;
- }
- unset( $data[ $key ] );
-
- } elseif ( $this->starts_with( $key, 'downloads:name' ) ) {
- if ( ! empty( $value ) ) {
- $downloads[ str_replace( 'downloads:name', '', $key ) ]['name'] = $value;
- }
- unset( $data[ $key ] );
-
- } elseif ( $this->starts_with( $key, 'downloads:url' ) ) {
- if ( ! empty( $value ) ) {
- $downloads[ str_replace( 'downloads:url', '', $key ) ]['url'] = $value;
- }
- unset( $data[ $key ] );
-
- } elseif ( $this->starts_with( $key, 'meta:' ) ) {
- $meta_data[] = array(
- 'key' => str_replace( 'meta:', '', $key ),
- 'value' => $value,
- );
- unset( $data[ $key ] );
- }
- }
-
- if ( ! empty( $attributes ) ) {
- // Remove empty attributes and clear indexes.
- foreach ( $attributes as $attribute ) {
- if ( empty( $attribute['name'] ) ) {
- continue;
- }
-
- $data['raw_attributes'][] = $attribute;
- }
- }
-
- if ( ! empty( $downloads ) ) {
- $data['downloads'] = array();
-
- foreach ( $downloads as $key => $file ) {
- if ( empty( $file['url'] ) ) {
- continue;
- }
-
- $data['downloads'][] = array(
- 'name' => $file['name'] ? $file['name'] : wc_get_filename_from_url( $file['url'] ),
- 'file' => $file['url'],
- );
- }
- }
-
- if ( ! empty( $meta_data ) ) {
- $data['meta_data'] = $meta_data;
- }
-
- return $data;
- }
-
- /**
- * Map and format raw data to known fields.
- */
- protected function set_parsed_data() {
- $parse_functions = $this->get_formatting_callback();
- $mapped_keys = $this->get_mapped_keys();
- $use_mb = function_exists( 'mb_convert_encoding' );
-
- // Parse the data.
- foreach ( $this->raw_data as $row_index => $row ) {
- // Skip empty rows.
- if ( ! count( array_filter( $row ) ) ) {
- continue;
- }
-
- $this->parsing_raw_data_index = $row_index;
-
- $data = array();
-
- do_action( 'woocommerce_product_importer_before_set_parsed_data', $row, $mapped_keys );
-
- foreach ( $row as $id => $value ) {
- // Skip ignored columns.
- if ( empty( $mapped_keys[ $id ] ) ) {
- continue;
- }
-
- // Convert UTF8.
- if ( $use_mb ) {
- $encoding = mb_detect_encoding( $value, mb_detect_order(), true );
- if ( $encoding ) {
- $value = mb_convert_encoding( $value, 'UTF-8', $encoding );
- } else {
- $value = mb_convert_encoding( $value, 'UTF-8', 'UTF-8' );
- }
- } else {
- $value = wp_check_invalid_utf8( $value, true );
- }
-
- $data[ $mapped_keys[ $id ] ] = call_user_func( $parse_functions[ $id ], $value );
- }
-
- /**
- * Filter product importer parsed data.
- *
- * @param array $parsed_data Parsed data.
- * @param WC_Product_Importer $importer Importer instance.
- */
- $this->parsed_data[] = apply_filters( 'woocommerce_product_importer_parsed_data', $this->expand_data( $data ), $this );
- }
- }
-
- /**
- * Get a string to identify the row from parsed data.
- *
- * @param array $parsed_data Parsed data.
- *
- * @return string
- */
- protected function get_row_id( $parsed_data ) {
- $id = isset( $parsed_data['id'] ) ? absint( $parsed_data['id'] ) : 0;
- $sku = isset( $parsed_data['sku'] ) ? esc_attr( $parsed_data['sku'] ) : '';
- $name = isset( $parsed_data['name'] ) ? esc_attr( $parsed_data['name'] ) : '';
- $row_data = array();
-
- if ( $name ) {
- $row_data[] = $name;
- }
- if ( $id ) {
- /* translators: %d: product ID */
- $row_data[] = sprintf( __( 'ID %d', 'woocommerce' ), $id );
- }
- if ( $sku ) {
- /* translators: %s: product SKU */
- $row_data[] = sprintf( __( 'SKU %s', 'woocommerce' ), $sku );
- }
-
- return implode( ', ', $row_data );
- }
-
- /**
- * Process importer.
- *
- * Do not import products with IDs or SKUs that already exist if option
- * update existing is false, and likewise, if updating products, do not
- * process rows which do not exist if an ID/SKU is provided.
- *
- * @return array
- */
- public function import() {
- $this->start_time = time();
- $index = 0;
- $update_existing = $this->params['update_existing'];
- $data = array(
- 'imported' => array(),
- 'failed' => array(),
- 'updated' => array(),
- 'skipped' => array(),
- );
-
- foreach ( $this->parsed_data as $parsed_data_key => $parsed_data ) {
- do_action( 'woocommerce_product_import_before_import', $parsed_data );
-
- $id = isset( $parsed_data['id'] ) ? absint( $parsed_data['id'] ) : 0;
- $sku = isset( $parsed_data['sku'] ) ? $parsed_data['sku'] : '';
- $id_exists = false;
- $sku_exists = false;
-
- if ( $id ) {
- $product = wc_get_product( $id );
- $id_exists = $product && 'importing' !== $product->get_status();
- }
-
- if ( $sku ) {
- $id_from_sku = wc_get_product_id_by_sku( $sku );
- $product = $id_from_sku ? wc_get_product( $id_from_sku ) : false;
- $sku_exists = $product && 'importing' !== $product->get_status();
- }
-
- if ( $id_exists && ! $update_existing ) {
- $data['skipped'][] = new WP_Error(
- 'woocommerce_product_importer_error',
- esc_html__( 'A product with this ID already exists.', 'woocommerce' ),
- array(
- 'id' => $id,
- 'row' => $this->get_row_id( $parsed_data ),
- )
- );
- continue;
- }
-
- if ( $sku_exists && ! $update_existing ) {
- $data['skipped'][] = new WP_Error(
- 'woocommerce_product_importer_error',
- esc_html__( 'A product with this SKU already exists.', 'woocommerce' ),
- array(
- 'sku' => esc_attr( $sku ),
- 'row' => $this->get_row_id( $parsed_data ),
- )
- );
- continue;
- }
-
- if ( $update_existing && ( isset( $parsed_data['id'] ) || isset( $parsed_data['sku'] ) ) && ! $id_exists && ! $sku_exists ) {
- $data['skipped'][] = new WP_Error(
- 'woocommerce_product_importer_error',
- esc_html__( 'No matching product exists to update.', 'woocommerce' ),
- array(
- 'id' => $id,
- 'sku' => esc_attr( $sku ),
- 'row' => $this->get_row_id( $parsed_data ),
- )
- );
- continue;
- }
-
- $result = $this->process_item( $parsed_data );
-
- if ( is_wp_error( $result ) ) {
- $result->add_data( array( 'row' => $this->get_row_id( $parsed_data ) ) );
- $data['failed'][] = $result;
- } elseif ( $result['updated'] ) {
- $data['updated'][] = $result['id'];
- } else {
- $data['imported'][] = $result['id'];
- }
-
- $index ++;
-
- if ( $this->params['prevent_timeouts'] && ( $this->time_exceeded() || $this->memory_exceeded() ) ) {
- $this->file_position = $this->file_positions[ $index ];
- break;
- }
- }
-
- return $data;
- }
-}
diff --git a/includes/interfaces/class-wc-abstract-order-data-store-interface.php b/includes/interfaces/class-wc-abstract-order-data-store-interface.php
deleted file mode 100644
index c043c34e214..00000000000
--- a/includes/interfaces/class-wc-abstract-order-data-store-interface.php
+++ /dev/null
@@ -1,54 +0,0 @@
- [], 'failed' => []]
- *
- * @return array
- */
- public function import();
-
- /**
- * Get file raw keys.
- *
- * CSV - Headers.
- * XML - Element names.
- * JSON - Keys
- *
- * @return array
- */
- public function get_raw_keys();
-
- /**
- * Get file mapped headers.
- *
- * @return array
- */
- public function get_mapped_keys();
-
- /**
- * Get raw data.
- *
- * @return array
- */
- public function get_raw_data();
-
- /**
- * Get parsed data.
- *
- * @return array
- */
- public function get_parsed_data();
-
- /**
- * Get file pointer position from the last read.
- *
- * @return int
- */
- public function get_file_position();
-
- /**
- * Get file pointer position as a percentage of file size.
- *
- * @return int
- */
- public function get_percent_complete();
-}
diff --git a/includes/interfaces/class-wc-log-handler-interface.php b/includes/interfaces/class-wc-log-handler-interface.php
deleted file mode 100644
index d84e39720c8..00000000000
--- a/includes/interfaces/class-wc-log-handler-interface.php
+++ /dev/null
@@ -1,33 +0,0 @@
-id).
- * @return array
- */
- public function delete_meta( &$data, $meta );
-
- /**
- * Add new piece of meta.
- *
- * @param WC_Data $data Data object.
- * @param object $meta Meta object (containing ->key and ->value).
- * @return int meta ID
- */
- public function add_meta( &$data, $meta );
-
- /**
- * Update meta.
- *
- * @param WC_Data $data Data object.
- * @param object $meta Meta object (containing ->id, ->key and ->value).
- */
- public function update_meta( &$data, $meta );
-}
diff --git a/includes/interfaces/class-wc-order-data-store-interface.php b/includes/interfaces/class-wc-order-data-store-interface.php
deleted file mode 100644
index 6f00c8a3efe..00000000000
--- a/includes/interfaces/class-wc-order-data-store-interface.php
+++ /dev/null
@@ -1,141 +0,0 @@
-get_id() will be set.
- *
- * @param WC_Order_Item $item Item object.
- */
- public function save_item_data( &$item );
-}
diff --git a/includes/interfaces/class-wc-order-refund-data-store-interface.php b/includes/interfaces/class-wc-order-refund-data-store-interface.php
deleted file mode 100644
index b97864d06e3..00000000000
--- a/includes/interfaces/class-wc-order-refund-data-store-interface.php
+++ /dev/null
@@ -1,21 +0,0 @@
-id, $return[0]->parent_id.
- *
- * @return array
- */
- public function get_on_sale_products();
-
- /**
- * Returns a list of product IDs ( id as key => parent as value) that are
- * featured. Uses get_posts instead of wc_get_products since we want
- * some extra meta queries and ALL products (posts_per_page = -1).
- *
- * @return array
- */
- public function get_featured_product_ids();
-
- /**
- * Check if product sku is found for any other product IDs.
- *
- * @param int $product_id Product ID.
- * @param string $sku SKU.
- * @return bool
- */
- public function is_existing_sku( $product_id, $sku );
-
- /**
- * Return product ID based on SKU.
- *
- * @param string $sku SKU.
- * @return int
- */
- public function get_product_id_by_sku( $sku );
-
- /**
- * Returns an array of IDs of products that have sales starting soon.
- *
- * @return array
- */
- public function get_starting_sales();
-
- /**
- * Returns an array of IDs of products that have sales which are due to end.
- *
- * @return array
- */
- public function get_ending_sales();
-
- /**
- * Find a matching (enabled) variation within a variable product.
- *
- * @param WC_Product $product Variable product object.
- * @param array $match_attributes Array of attributes we want to try to match.
- * @return int Matching variation ID or 0.
- */
- public function find_matching_product_variation( $product, $match_attributes = array() );
-
- /**
- * Make sure all variations have a sort order set so they can be reordered correctly.
- *
- * @param int $parent_id Parent ID.
- */
- public function sort_all_product_variations( $parent_id );
-
- /**
- * Return a list of related products (using data like categories and IDs).
- *
- * @param array $cats_array List of categories IDs.
- * @param array $tags_array List of tags IDs.
- * @param array $exclude_ids Excluded IDs.
- * @param int $limit Limit of results.
- * @param int $product_id Product ID.
- * @return array
- */
- public function get_related_products( $cats_array, $tags_array, $exclude_ids, $limit, $product_id );
-
- /**
- * Update a product's stock amount directly.
- *
- * Uses queries rather than update_post_meta so we can do this in one query (to avoid stock issues).
- *
- * @param int $product_id_with_stock Product ID.
- * @param int|null $stock_quantity Stock quantity to update to.
- * @param string $operation Either set, increase or decrease.
- */
- public function update_product_stock( $product_id_with_stock, $stock_quantity = null, $operation = 'set' );
-
- /**
- * Update a product's sale count directly.
- *
- * Uses queries rather than update_post_meta so we can do this in one query for performance.
- *
- * @param int $product_id Product ID.
- * @param int|null $quantity Stock quantity to use for update.
- * @param string $operation Either set, increase or decrease.
- */
- public function update_product_sales( $product_id, $quantity = null, $operation = 'set' );
-
- /**
- * Get shipping class ID by slug.
- *
- * @param string $slug Shipping class slug.
- * @return int|false
- */
- public function get_shipping_class_id_by_slug( $slug );
-
- /**
- * Returns an array of products.
- *
- * @param array $args @see wc_get_products.
- * @return array
- */
- public function get_products( $args = array() );
-
- /**
- * Get the product type based on product ID.
- *
- * @param int $product_id Product ID.
- * @return bool|string
- */
- public function get_product_type( $product_id );
-}
diff --git a/includes/interfaces/class-wc-product-variable-data-store-interface.php b/includes/interfaces/class-wc-product-variable-data-store-interface.php
deleted file mode 100644
index b22893dc3a6..00000000000
--- a/includes/interfaces/class-wc-product-variable-data-store-interface.php
+++ /dev/null
@@ -1,83 +0,0 @@
- '' - the name of the action that will be triggered.
- * 'args' => null - the args array that will be passed with the action.
- * 'date' => null - the scheduled date of the action. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone.
- * 'date_compare' => '<=' - operator for testing "date". accepted values are '!=', '>', '>=', '<', '<=', '='.
- * 'modified' => null - the date the action was last updated. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone.
- * 'modified_compare' => '<=' - operator for testing "modified". accepted values are '!=', '>', '>=', '<', '<=', '='.
- * 'group' => '' - the group the action belongs to.
- * 'status' => '' - ActionScheduler_Store::STATUS_COMPLETE or ActionScheduler_Store::STATUS_PENDING.
- * 'claimed' => null - TRUE to find claimed actions, FALSE to find unclaimed actions, a string to find a specific claim ID.
- * 'per_page' => 5 - Number of results to return.
- * 'offset' => 0.
- * 'orderby' => 'date' - accepted values are 'hook', 'group', 'modified', or 'date'.
- * 'order' => 'ASC'.
- * @param string $return_format OBJECT, ARRAY_A, or ids.
- * @return array
- */
- public function search( $args = array(), $return_format = OBJECT );
-}
diff --git a/includes/interfaces/class-wc-shipping-zone-data-store-interface.php b/includes/interfaces/class-wc-shipping-zone-data-store-interface.php
deleted file mode 100644
index 7009c5b7209..00000000000
--- a/includes/interfaces/class-wc-shipping-zone-data-store-interface.php
+++ /dev/null
@@ -1,85 +0,0 @@
-
- * GET /orders/' . $filter_template . '' ), '2.1' );
- return;
- }
- $template = $filter_template;
- }
-
- $action_args = array(
- 'template_name' => $template_name,
- 'template_path' => $template_path,
- 'located' => $template,
- 'args' => $args,
- );
-
- if ( ! empty( $args ) && is_array( $args ) ) {
- if ( isset( $args['action_args'] ) ) {
- wc_doing_it_wrong(
- __FUNCTION__,
- __( 'action_args should not be overwritten when calling wc_get_template.', 'woocommerce' ),
- '3.6.0'
- );
- unset( $args['action_args'] );
- }
- extract( $args ); // @codingStandardsIgnoreLine
- }
-
- do_action( 'woocommerce_before_template_part', $action_args['template_name'], $action_args['template_path'], $action_args['located'], $action_args['args'] );
-
- include $action_args['located'];
-
- do_action( 'woocommerce_after_template_part', $action_args['template_name'], $action_args['template_path'], $action_args['located'], $action_args['args'] );
-}
-
-/**
- * Like wc_get_template, but returns the HTML instead of outputting.
- *
- * @see wc_get_template
- * @since 2.5.0
- * @param string $template_name Template name.
- * @param array $args Arguments. (default: array).
- * @param string $template_path Template path. (default: '').
- * @param string $default_path Default path. (default: '').
- *
- * @return string
- */
-function wc_get_template_html( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
- ob_start();
- wc_get_template( $template_name, $args, $template_path, $default_path );
- return ob_get_clean();
-}
-/**
- * Locate a template and return the path for inclusion.
- *
- * This is the load order:
- *
- * yourtheme/$template_path/$template_name
- * yourtheme/$template_name
- * $default_path/$template_name
- *
- * @param string $template_name Template name.
- * @param string $template_path Template path. (default: '').
- * @param string $default_path Default path. (default: '').
- * @return string
- */
-function wc_locate_template( $template_name, $template_path = '', $default_path = '' ) {
- if ( ! $template_path ) {
- $template_path = WC()->template_path();
- }
-
- if ( ! $default_path ) {
- $default_path = WC()->plugin_path() . '/templates/';
- }
-
- // Look within passed path within the theme - this is priority.
- if ( false !== strpos( $template_name, 'product_cat' ) || false !== strpos( $template_name, 'product_tag' ) ) {
- $cs_template = str_replace( '_', '-', $template_name );
- $template = locate_template(
- array(
- trailingslashit( $template_path ) . $cs_template,
- $cs_template,
- )
- );
- }
-
- if ( empty( $template ) ) {
- $template = locate_template(
- array(
- trailingslashit( $template_path ) . $template_name,
- $template_name,
- )
- );
- }
-
- // Get default template/.
- if ( ! $template || WC_TEMPLATE_DEBUG_MODE ) {
- if ( empty( $cs_template ) ) {
- $template = $default_path . $template_name;
- } else {
- $template = $default_path . $cs_template;
- }
- }
-
- // Return what we found.
- return apply_filters( 'woocommerce_locate_template', $template, $template_name, $template_path );
-}
-
-/**
- * Add a template to the template cache.
- *
- * @since 4.3.0
- * @param string $cache_key Object cache key.
- * @param string $template Located template.
- */
-function wc_set_template_cache( $cache_key, $template ) {
- wp_cache_set( $cache_key, $template, 'woocommerce' );
-
- $cached_templates = wp_cache_get( 'cached_templates', 'woocommerce' );
- if ( is_array( $cached_templates ) ) {
- $cached_templates[] = $cache_key;
- } else {
- $cached_templates = array( $cache_key );
- }
-
- wp_cache_set( 'cached_templates', $cached_templates, 'woocommerce' );
-}
-
-/**
- * Clear the template cache.
- *
- * @since 4.3.0
- */
-function wc_clear_template_cache() {
- $cached_templates = wp_cache_get( 'cached_templates', 'woocommerce' );
- if ( is_array( $cached_templates ) ) {
- foreach ( $cached_templates as $cache_key ) {
- wp_cache_delete( $cache_key, 'woocommerce' );
- }
-
- wp_cache_delete( 'cached_templates', 'woocommerce' );
- }
-}
-
-/**
- * Get Base Currency Code.
- *
- * @return string
- */
-function get_woocommerce_currency() {
- return apply_filters( 'woocommerce_currency', get_option( 'woocommerce_currency' ) );
-}
-
-/**
- * Get full list of currency codes.
- *
- * Currency symbols and names should follow the Unicode CLDR recommendation (http://cldr.unicode.org/translation/currency-names)
- *
- * @return array
- */
-function get_woocommerce_currencies() {
- static $currencies;
-
- if ( ! isset( $currencies ) ) {
- $currencies = array_unique(
- apply_filters(
- 'woocommerce_currencies',
- array(
- 'AED' => __( 'United Arab Emirates dirham', 'woocommerce' ),
- 'AFN' => __( 'Afghan afghani', 'woocommerce' ),
- 'ALL' => __( 'Albanian lek', 'woocommerce' ),
- 'AMD' => __( 'Armenian dram', 'woocommerce' ),
- 'ANG' => __( 'Netherlands Antillean guilder', 'woocommerce' ),
- 'AOA' => __( 'Angolan kwanza', 'woocommerce' ),
- 'ARS' => __( 'Argentine peso', 'woocommerce' ),
- 'AUD' => __( 'Australian dollar', 'woocommerce' ),
- 'AWG' => __( 'Aruban florin', 'woocommerce' ),
- 'AZN' => __( 'Azerbaijani manat', 'woocommerce' ),
- 'BAM' => __( 'Bosnia and Herzegovina convertible mark', 'woocommerce' ),
- 'BBD' => __( 'Barbadian dollar', 'woocommerce' ),
- 'BDT' => __( 'Bangladeshi taka', 'woocommerce' ),
- 'BGN' => __( 'Bulgarian lev', 'woocommerce' ),
- 'BHD' => __( 'Bahraini dinar', 'woocommerce' ),
- 'BIF' => __( 'Burundian franc', 'woocommerce' ),
- 'BMD' => __( 'Bermudian dollar', 'woocommerce' ),
- 'BND' => __( 'Brunei dollar', 'woocommerce' ),
- 'BOB' => __( 'Bolivian boliviano', 'woocommerce' ),
- 'BRL' => __( 'Brazilian real', 'woocommerce' ),
- 'BSD' => __( 'Bahamian dollar', 'woocommerce' ),
- 'BTC' => __( 'Bitcoin', 'woocommerce' ),
- 'BTN' => __( 'Bhutanese ngultrum', 'woocommerce' ),
- 'BWP' => __( 'Botswana pula', 'woocommerce' ),
- 'BYR' => __( 'Belarusian ruble (old)', 'woocommerce' ),
- 'BYN' => __( 'Belarusian ruble', 'woocommerce' ),
- 'BZD' => __( 'Belize dollar', 'woocommerce' ),
- 'CAD' => __( 'Canadian dollar', 'woocommerce' ),
- 'CDF' => __( 'Congolese franc', 'woocommerce' ),
- 'CHF' => __( 'Swiss franc', 'woocommerce' ),
- 'CLP' => __( 'Chilean peso', 'woocommerce' ),
- 'CNY' => __( 'Chinese yuan', 'woocommerce' ),
- 'COP' => __( 'Colombian peso', 'woocommerce' ),
- 'CRC' => __( 'Costa Rican colón', 'woocommerce' ),
- 'CUC' => __( 'Cuban convertible peso', 'woocommerce' ),
- 'CUP' => __( 'Cuban peso', 'woocommerce' ),
- 'CVE' => __( 'Cape Verdean escudo', 'woocommerce' ),
- 'CZK' => __( 'Czech koruna', 'woocommerce' ),
- 'DJF' => __( 'Djiboutian franc', 'woocommerce' ),
- 'DKK' => __( 'Danish krone', 'woocommerce' ),
- 'DOP' => __( 'Dominican peso', 'woocommerce' ),
- 'DZD' => __( 'Algerian dinar', 'woocommerce' ),
- 'EGP' => __( 'Egyptian pound', 'woocommerce' ),
- 'ERN' => __( 'Eritrean nakfa', 'woocommerce' ),
- 'ETB' => __( 'Ethiopian birr', 'woocommerce' ),
- 'EUR' => __( 'Euro', 'woocommerce' ),
- 'FJD' => __( 'Fijian dollar', 'woocommerce' ),
- 'FKP' => __( 'Falkland Islands pound', 'woocommerce' ),
- 'GBP' => __( 'Pound sterling', 'woocommerce' ),
- 'GEL' => __( 'Georgian lari', 'woocommerce' ),
- 'GGP' => __( 'Guernsey pound', 'woocommerce' ),
- 'GHS' => __( 'Ghana cedi', 'woocommerce' ),
- 'GIP' => __( 'Gibraltar pound', 'woocommerce' ),
- 'GMD' => __( 'Gambian dalasi', 'woocommerce' ),
- 'GNF' => __( 'Guinean franc', 'woocommerce' ),
- 'GTQ' => __( 'Guatemalan quetzal', 'woocommerce' ),
- 'GYD' => __( 'Guyanese dollar', 'woocommerce' ),
- 'HKD' => __( 'Hong Kong dollar', 'woocommerce' ),
- 'HNL' => __( 'Honduran lempira', 'woocommerce' ),
- 'HRK' => __( 'Croatian kuna', 'woocommerce' ),
- 'HTG' => __( 'Haitian gourde', 'woocommerce' ),
- 'HUF' => __( 'Hungarian forint', 'woocommerce' ),
- 'IDR' => __( 'Indonesian rupiah', 'woocommerce' ),
- 'ILS' => __( 'Israeli new shekel', 'woocommerce' ),
- 'IMP' => __( 'Manx pound', 'woocommerce' ),
- 'INR' => __( 'Indian rupee', 'woocommerce' ),
- 'IQD' => __( 'Iraqi dinar', 'woocommerce' ),
- 'IRR' => __( 'Iranian rial', 'woocommerce' ),
- 'IRT' => __( 'Iranian toman', 'woocommerce' ),
- 'ISK' => __( 'Icelandic króna', 'woocommerce' ),
- 'JEP' => __( 'Jersey pound', 'woocommerce' ),
- 'JMD' => __( 'Jamaican dollar', 'woocommerce' ),
- 'JOD' => __( 'Jordanian dinar', 'woocommerce' ),
- 'JPY' => __( 'Japanese yen', 'woocommerce' ),
- 'KES' => __( 'Kenyan shilling', 'woocommerce' ),
- 'KGS' => __( 'Kyrgyzstani som', 'woocommerce' ),
- 'KHR' => __( 'Cambodian riel', 'woocommerce' ),
- 'KMF' => __( 'Comorian franc', 'woocommerce' ),
- 'KPW' => __( 'North Korean won', 'woocommerce' ),
- 'KRW' => __( 'South Korean won', 'woocommerce' ),
- 'KWD' => __( 'Kuwaiti dinar', 'woocommerce' ),
- 'KYD' => __( 'Cayman Islands dollar', 'woocommerce' ),
- 'KZT' => __( 'Kazakhstani tenge', 'woocommerce' ),
- 'LAK' => __( 'Lao kip', 'woocommerce' ),
- 'LBP' => __( 'Lebanese pound', 'woocommerce' ),
- 'LKR' => __( 'Sri Lankan rupee', 'woocommerce' ),
- 'LRD' => __( 'Liberian dollar', 'woocommerce' ),
- 'LSL' => __( 'Lesotho loti', 'woocommerce' ),
- 'LYD' => __( 'Libyan dinar', 'woocommerce' ),
- 'MAD' => __( 'Moroccan dirham', 'woocommerce' ),
- 'MDL' => __( 'Moldovan leu', 'woocommerce' ),
- 'MGA' => __( 'Malagasy ariary', 'woocommerce' ),
- 'MKD' => __( 'Macedonian denar', 'woocommerce' ),
- 'MMK' => __( 'Burmese kyat', 'woocommerce' ),
- 'MNT' => __( 'Mongolian tögrög', 'woocommerce' ),
- 'MOP' => __( 'Macanese pataca', 'woocommerce' ),
- 'MRU' => __( 'Mauritanian ouguiya', 'woocommerce' ),
- 'MUR' => __( 'Mauritian rupee', 'woocommerce' ),
- 'MVR' => __( 'Maldivian rufiyaa', 'woocommerce' ),
- 'MWK' => __( 'Malawian kwacha', 'woocommerce' ),
- 'MXN' => __( 'Mexican peso', 'woocommerce' ),
- 'MYR' => __( 'Malaysian ringgit', 'woocommerce' ),
- 'MZN' => __( 'Mozambican metical', 'woocommerce' ),
- 'NAD' => __( 'Namibian dollar', 'woocommerce' ),
- 'NGN' => __( 'Nigerian naira', 'woocommerce' ),
- 'NIO' => __( 'Nicaraguan córdoba', 'woocommerce' ),
- 'NOK' => __( 'Norwegian krone', 'woocommerce' ),
- 'NPR' => __( 'Nepalese rupee', 'woocommerce' ),
- 'NZD' => __( 'New Zealand dollar', 'woocommerce' ),
- 'OMR' => __( 'Omani rial', 'woocommerce' ),
- 'PAB' => __( 'Panamanian balboa', 'woocommerce' ),
- 'PEN' => __( 'Sol', 'woocommerce' ),
- 'PGK' => __( 'Papua New Guinean kina', 'woocommerce' ),
- 'PHP' => __( 'Philippine peso', 'woocommerce' ),
- 'PKR' => __( 'Pakistani rupee', 'woocommerce' ),
- 'PLN' => __( 'Polish złoty', 'woocommerce' ),
- 'PRB' => __( 'Transnistrian ruble', 'woocommerce' ),
- 'PYG' => __( 'Paraguayan guaraní', 'woocommerce' ),
- 'QAR' => __( 'Qatari riyal', 'woocommerce' ),
- 'RON' => __( 'Romanian leu', 'woocommerce' ),
- 'RSD' => __( 'Serbian dinar', 'woocommerce' ),
- 'RUB' => __( 'Russian ruble', 'woocommerce' ),
- 'RWF' => __( 'Rwandan franc', 'woocommerce' ),
- 'SAR' => __( 'Saudi riyal', 'woocommerce' ),
- 'SBD' => __( 'Solomon Islands dollar', 'woocommerce' ),
- 'SCR' => __( 'Seychellois rupee', 'woocommerce' ),
- 'SDG' => __( 'Sudanese pound', 'woocommerce' ),
- 'SEK' => __( 'Swedish krona', 'woocommerce' ),
- 'SGD' => __( 'Singapore dollar', 'woocommerce' ),
- 'SHP' => __( 'Saint Helena pound', 'woocommerce' ),
- 'SLL' => __( 'Sierra Leonean leone', 'woocommerce' ),
- 'SOS' => __( 'Somali shilling', 'woocommerce' ),
- 'SRD' => __( 'Surinamese dollar', 'woocommerce' ),
- 'SSP' => __( 'South Sudanese pound', 'woocommerce' ),
- 'STN' => __( 'São Tomé and Príncipe dobra', 'woocommerce' ),
- 'SYP' => __( 'Syrian pound', 'woocommerce' ),
- 'SZL' => __( 'Swazi lilangeni', 'woocommerce' ),
- 'THB' => __( 'Thai baht', 'woocommerce' ),
- 'TJS' => __( 'Tajikistani somoni', 'woocommerce' ),
- 'TMT' => __( 'Turkmenistan manat', 'woocommerce' ),
- 'TND' => __( 'Tunisian dinar', 'woocommerce' ),
- 'TOP' => __( 'Tongan paʻanga', 'woocommerce' ),
- 'TRY' => __( 'Turkish lira', 'woocommerce' ),
- 'TTD' => __( 'Trinidad and Tobago dollar', 'woocommerce' ),
- 'TWD' => __( 'New Taiwan dollar', 'woocommerce' ),
- 'TZS' => __( 'Tanzanian shilling', 'woocommerce' ),
- 'UAH' => __( 'Ukrainian hryvnia', 'woocommerce' ),
- 'UGX' => __( 'Ugandan shilling', 'woocommerce' ),
- 'USD' => __( 'United States (US) dollar', 'woocommerce' ),
- 'UYU' => __( 'Uruguayan peso', 'woocommerce' ),
- 'UZS' => __( 'Uzbekistani som', 'woocommerce' ),
- 'VEF' => __( 'Venezuelan bolívar', 'woocommerce' ),
- 'VES' => __( 'Bolívar soberano', 'woocommerce' ),
- 'VND' => __( 'Vietnamese đồng', 'woocommerce' ),
- 'VUV' => __( 'Vanuatu vatu', 'woocommerce' ),
- 'WST' => __( 'Samoan tālā', 'woocommerce' ),
- 'XAF' => __( 'Central African CFA franc', 'woocommerce' ),
- 'XCD' => __( 'East Caribbean dollar', 'woocommerce' ),
- 'XOF' => __( 'West African CFA franc', 'woocommerce' ),
- 'XPF' => __( 'CFP franc', 'woocommerce' ),
- 'YER' => __( 'Yemeni rial', 'woocommerce' ),
- 'ZAR' => __( 'South African rand', 'woocommerce' ),
- 'ZMW' => __( 'Zambian kwacha', 'woocommerce' ),
- )
- )
- );
- }
-
- return $currencies;
-}
-
-/**
- * Get all available Currency symbols.
- *
- * Currency symbols and names should follow the Unicode CLDR recommendation (http://cldr.unicode.org/translation/currency-names)
- *
- * @since 4.1.0
- * @return array
- */
-function get_woocommerce_currency_symbols() {
-
- $symbols = apply_filters(
- 'woocommerce_currency_symbols',
- array(
- 'AED' => 'د.إ',
- 'AFN' => '؋',
- 'ALL' => 'L',
- 'AMD' => 'AMD',
- 'ANG' => 'ƒ',
- 'AOA' => 'Kz',
- 'ARS' => '$',
- 'AUD' => '$',
- 'AWG' => 'Afl.',
- 'AZN' => 'AZN',
- 'BAM' => 'KM',
- 'BBD' => '$',
- 'BDT' => '৳ ',
- 'BGN' => 'лв.',
- 'BHD' => '.د.ب',
- 'BIF' => 'Fr',
- 'BMD' => '$',
- 'BND' => '$',
- 'BOB' => 'Bs.',
- 'BRL' => 'R$',
- 'BSD' => '$',
- 'BTC' => '฿',
- 'BTN' => 'Nu.',
- 'BWP' => 'P',
- 'BYR' => 'Br',
- 'BYN' => 'Br',
- 'BZD' => '$',
- 'CAD' => '$',
- 'CDF' => 'Fr',
- 'CHF' => 'CHF',
- 'CLP' => '$',
- 'CNY' => '¥',
- 'COP' => '$',
- 'CRC' => '₡',
- 'CUC' => '$',
- 'CUP' => '$',
- 'CVE' => '$',
- 'CZK' => 'Kč',
- 'DJF' => 'Fr',
- 'DKK' => 'DKK',
- 'DOP' => 'RD$',
- 'DZD' => 'د.ج',
- 'EGP' => 'EGP',
- 'ERN' => 'Nfk',
- 'ETB' => 'Br',
- 'EUR' => '€',
- 'FJD' => '$',
- 'FKP' => '£',
- 'GBP' => '£',
- 'GEL' => '₾',
- 'GGP' => '£',
- 'GHS' => '₵',
- 'GIP' => '£',
- 'GMD' => 'D',
- 'GNF' => 'Fr',
- 'GTQ' => 'Q',
- 'GYD' => '$',
- 'HKD' => '$',
- 'HNL' => 'L',
- 'HRK' => 'kn',
- 'HTG' => 'G',
- 'HUF' => 'Ft',
- 'IDR' => 'Rp',
- 'ILS' => '₪',
- 'IMP' => '£',
- 'INR' => '₹',
- 'IQD' => 'ع.د',
- 'IRR' => '﷼',
- 'IRT' => 'تومان',
- 'ISK' => 'kr.',
- 'JEP' => '£',
- 'JMD' => '$',
- 'JOD' => 'د.ا',
- 'JPY' => '¥',
- 'KES' => 'KSh',
- 'KGS' => 'сом',
- 'KHR' => '៛',
- 'KMF' => 'Fr',
- 'KPW' => '₩',
- 'KRW' => '₩',
- 'KWD' => 'د.ك',
- 'KYD' => '$',
- 'KZT' => '₸',
- 'LAK' => '₭',
- 'LBP' => 'ل.ل',
- 'LKR' => 'රු',
- 'LRD' => '$',
- 'LSL' => 'L',
- 'LYD' => 'ل.د',
- 'MAD' => 'د.م.',
- 'MDL' => 'MDL',
- 'MGA' => 'Ar',
- 'MKD' => 'ден',
- 'MMK' => 'Ks',
- 'MNT' => '₮',
- 'MOP' => 'P',
- 'MRU' => 'UM',
- 'MUR' => '₨',
- 'MVR' => '.ރ',
- 'MWK' => 'MK',
- 'MXN' => '$',
- 'MYR' => 'RM',
- 'MZN' => 'MT',
- 'NAD' => 'N$',
- 'NGN' => '₦',
- 'NIO' => 'C$',
- 'NOK' => 'kr',
- 'NPR' => '₨',
- 'NZD' => '$',
- 'OMR' => 'ر.ع.',
- 'PAB' => 'B/.',
- 'PEN' => 'S/',
- 'PGK' => 'K',
- 'PHP' => '₱',
- 'PKR' => '₨',
- 'PLN' => 'zł',
- 'PRB' => 'р.',
- 'PYG' => '₲',
- 'QAR' => 'ر.ق',
- 'RMB' => '¥',
- 'RON' => 'lei',
- 'RSD' => 'рсд',
- 'RUB' => '₽',
- 'RWF' => 'Fr',
- 'SAR' => 'ر.س',
- 'SBD' => '$',
- 'SCR' => '₨',
- 'SDG' => 'ج.س.',
- 'SEK' => 'kr',
- 'SGD' => '$',
- 'SHP' => '£',
- 'SLL' => 'Le',
- 'SOS' => 'Sh',
- 'SRD' => '$',
- 'SSP' => '£',
- 'STN' => 'Db',
- 'SYP' => 'ل.س',
- 'SZL' => 'L',
- 'THB' => '฿',
- 'TJS' => 'ЅМ',
- 'TMT' => 'm',
- 'TND' => 'د.ت',
- 'TOP' => 'T$',
- 'TRY' => '₺',
- 'TTD' => '$',
- 'TWD' => 'NT$',
- 'TZS' => 'Sh',
- 'UAH' => '₴',
- 'UGX' => 'UGX',
- 'USD' => '$',
- 'UYU' => '$',
- 'UZS' => 'UZS',
- 'VEF' => 'Bs F',
- 'VES' => 'Bs.S',
- 'VND' => '₫',
- 'VUV' => 'Vt',
- 'WST' => 'T',
- 'XAF' => 'CFA',
- 'XCD' => '$',
- 'XOF' => 'CFA',
- 'XPF' => 'Fr',
- 'YER' => '﷼',
- 'ZAR' => 'R',
- 'ZMW' => 'ZK',
- )
- );
-
- return $symbols;
-}
-
-/**
- * Get Currency symbol.
- *
- * Currency symbols and names should follow the Unicode CLDR recommendation (http://cldr.unicode.org/translation/currency-names)
- *
- * @param string $currency Currency. (default: '').
- * @return string
- */
-function get_woocommerce_currency_symbol( $currency = '' ) {
- if ( ! $currency ) {
- $currency = get_woocommerce_currency();
- }
-
- $symbols = get_woocommerce_currency_symbols();
-
- $currency_symbol = isset( $symbols[ $currency ] ) ? $symbols[ $currency ] : '';
-
- return apply_filters( 'woocommerce_currency_symbol', $currency_symbol, $currency );
-}
-
-/**
- * Send HTML emails from WooCommerce.
- *
- * @param mixed $to Receiver.
- * @param mixed $subject Subject.
- * @param mixed $message Message.
- * @param string $headers Headers. (default: "Content-Type: text/html\r\n").
- * @param string $attachments Attachments. (default: "").
- * @return bool
- */
-function wc_mail( $to, $subject, $message, $headers = "Content-Type: text/html\r\n", $attachments = '' ) {
- $mailer = WC()->mailer();
-
- return $mailer->send( $to, $subject, $message, $headers, $attachments );
-}
-
-/**
- * Return "theme support" values from the current theme, if set.
- *
- * @since 3.3.0
- * @param string $prop Name of prop (or key::subkey for arrays of props) if you want a specific value. Leave blank to get all props as an array.
- * @param mixed $default Optional value to return if the theme does not declare support for a prop.
- * @return mixed Value of prop(s).
- */
-function wc_get_theme_support( $prop = '', $default = null ) {
- $theme_support = get_theme_support( 'woocommerce' );
- $theme_support = is_array( $theme_support ) ? $theme_support[0] : false;
-
- if ( ! $theme_support ) {
- return $default;
- }
-
- if ( $prop ) {
- $prop_stack = explode( '::', $prop );
- $prop_key = array_shift( $prop_stack );
-
- if ( isset( $theme_support[ $prop_key ] ) ) {
- $value = $theme_support[ $prop_key ];
-
- if ( count( $prop_stack ) ) {
- foreach ( $prop_stack as $prop_key ) {
- if ( is_array( $value ) && isset( $value[ $prop_key ] ) ) {
- $value = $value[ $prop_key ];
- } else {
- $value = $default;
- break;
- }
- }
- }
- } else {
- $value = $default;
- }
-
- return $value;
- }
-
- return $theme_support;
-}
-
-/**
- * Get an image size by name or defined dimensions.
- *
- * The returned variable is filtered by woocommerce_get_image_size_{image_size} filter to
- * allow 3rd party customisation.
- *
- * Sizes defined by the theme take priority over settings. Settings are hidden when a theme
- * defines sizes.
- *
- * @param array|string $image_size Name of the image size to get, or an array of dimensions.
- * @return array Array of dimensions including width, height, and cropping mode. Cropping mode is 0 for no crop, and 1 for hard crop.
- */
-function wc_get_image_size( $image_size ) {
- $cache_key = 'size-' . ( is_array( $image_size ) ? implode( '-', $image_size ) : $image_size );
- $size = wp_cache_get( $cache_key, 'woocommerce' );
-
- if ( $size ) {
- return $size;
- }
-
- $size = array(
- 'width' => 600,
- 'height' => 600,
- 'crop' => 1,
- );
-
- if ( is_array( $image_size ) ) {
- $size = array(
- 'width' => isset( $image_size[0] ) ? absint( $image_size[0] ) : 600,
- 'height' => isset( $image_size[1] ) ? absint( $image_size[1] ) : 600,
- 'crop' => isset( $image_size[2] ) ? absint( $image_size[2] ) : 1,
- );
- $image_size = $size['width'] . '_' . $size['height'];
- } else {
- $image_size = str_replace( 'woocommerce_', '', $image_size );
-
- // Legacy size mapping.
- if ( 'shop_single' === $image_size ) {
- $image_size = 'single';
- } elseif ( 'shop_catalog' === $image_size ) {
- $image_size = 'thumbnail';
- } elseif ( 'shop_thumbnail' === $image_size ) {
- $image_size = 'gallery_thumbnail';
- }
-
- if ( 'single' === $image_size ) {
- $size['width'] = absint( wc_get_theme_support( 'single_image_width', get_option( 'woocommerce_single_image_width', 600 ) ) );
- $size['height'] = '';
- $size['crop'] = 0;
-
- } elseif ( 'gallery_thumbnail' === $image_size ) {
- $size['width'] = absint( wc_get_theme_support( 'gallery_thumbnail_image_width', 100 ) );
- $size['height'] = $size['width'];
- $size['crop'] = 1;
-
- } elseif ( 'thumbnail' === $image_size ) {
- $size['width'] = absint( wc_get_theme_support( 'thumbnail_image_width', get_option( 'woocommerce_thumbnail_image_width', 300 ) ) );
- $cropping = get_option( 'woocommerce_thumbnail_cropping', '1:1' );
-
- if ( 'uncropped' === $cropping ) {
- $size['height'] = '';
- $size['crop'] = 0;
- } elseif ( 'custom' === $cropping ) {
- $width = max( 1, get_option( 'woocommerce_thumbnail_cropping_custom_width', '4' ) );
- $height = max( 1, get_option( 'woocommerce_thumbnail_cropping_custom_height', '3' ) );
- $size['height'] = absint( NumberUtil::round( ( $size['width'] / $width ) * $height ) );
- $size['crop'] = 1;
- } else {
- $cropping_split = explode( ':', $cropping );
- $width = max( 1, current( $cropping_split ) );
- $height = max( 1, end( $cropping_split ) );
- $size['height'] = absint( NumberUtil::round( ( $size['width'] / $width ) * $height ) );
- $size['crop'] = 1;
- }
- }
- }
-
- $size = apply_filters( 'woocommerce_get_image_size_' . $image_size, $size );
-
- wp_cache_set( $cache_key, $size, 'woocommerce' );
-
- return $size;
-}
-
-/**
- * Queue some JavaScript code to be output in the footer.
- *
- * @param string $code Code.
- */
-function wc_enqueue_js( $code ) {
- global $wc_queued_js;
-
- if ( empty( $wc_queued_js ) ) {
- $wc_queued_js = '';
- }
-
- $wc_queued_js .= "\n" . $code . "\n";
-}
-
-/**
- * Output any queued javascript code in the footer.
- */
-function wc_print_js() {
- global $wc_queued_js;
-
- if ( ! empty( $wc_queued_js ) ) {
- // Sanitize.
- $wc_queued_js = wp_check_invalid_utf8( $wc_queued_js );
- $wc_queued_js = preg_replace( '/&#(x)?0*(?(1)27|39);?/i', "'", $wc_queued_js );
- $wc_queued_js = str_replace( "\r", '', $wc_queued_js );
-
- $js = "\n\n";
-
- /**
- * Queued jsfilter.
- *
- * @since 2.6.0
- * @param string $js JavaScript code.
- */
- echo apply_filters( 'woocommerce_queued_js', $js ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
-
- unset( $wc_queued_js );
- }
-}
-
-/**
- * Set a cookie - wrapper for setcookie using WP constants.
- *
- * @param string $name Name of the cookie being set.
- * @param string $value Value of the cookie.
- * @param integer $expire Expiry of the cookie.
- * @param bool $secure Whether the cookie should be served only over https.
- * @param bool $httponly Whether the cookie is only accessible over HTTP, not scripting languages like JavaScript. @since 3.6.0.
- */
-function wc_setcookie( $name, $value, $expire = 0, $secure = false, $httponly = false ) {
- if ( ! headers_sent() ) {
- setcookie( $name, $value, $expire, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $secure, apply_filters( 'woocommerce_cookie_httponly', $httponly, $name, $value, $expire, $secure ) );
- } elseif ( Constants::is_true( 'WP_DEBUG' ) ) {
- headers_sent( $file, $line );
- trigger_error( "{$name} cookie cannot be set - headers already sent by {$file} on line {$line}", E_USER_NOTICE ); // @codingStandardsIgnoreLine
- }
-}
-
-/**
- * Get the URL to the WooCommerce REST API.
- *
- * @since 2.1
- * @param string $path an endpoint to include in the URL.
- * @return string the URL.
- */
-function get_woocommerce_api_url( $path ) {
- if ( Constants::is_defined( 'WC_API_REQUEST_VERSION' ) ) {
- $version = Constants::get_constant( 'WC_API_REQUEST_VERSION' );
- } else {
- $version = substr( WC_API::VERSION, 0, 1 );
- }
-
- $url = get_home_url( null, "wc-api/v{$version}/", is_ssl() ? 'https' : 'http' );
-
- if ( ! empty( $path ) && is_string( $path ) ) {
- $url .= ltrim( $path, '/' );
- }
-
- return $url;
-}
-
-/**
- * Get a log file path.
- *
- * @since 2.2
- *
- * @param string $handle name.
- * @return string the log file path.
- */
-function wc_get_log_file_path( $handle ) {
- return WC_Log_Handler_File::get_log_file_path( $handle );
-}
-
-/**
- * Get a log file name.
- *
- * @since 3.3
- *
- * @param string $handle Name.
- * @return string The log file name.
- */
-function wc_get_log_file_name( $handle ) {
- return WC_Log_Handler_File::get_log_file_name( $handle );
-}
-
-/**
- * Recursively get page children.
- *
- * @param int $page_id Page ID.
- * @return int[]
- */
-function wc_get_page_children( $page_id ) {
- $page_ids = get_posts(
- array(
- 'post_parent' => $page_id,
- 'post_type' => 'page',
- 'numberposts' => -1, // @codingStandardsIgnoreLine
- 'post_status' => 'any',
- 'fields' => 'ids',
- )
- );
-
- if ( ! empty( $page_ids ) ) {
- foreach ( $page_ids as $page_id ) {
- $page_ids = array_merge( $page_ids, wc_get_page_children( $page_id ) );
- }
- }
-
- return $page_ids;
-}
-
-/**
- * Flushes rewrite rules when the shop page (or it's children) gets saved.
- */
-function flush_rewrite_rules_on_shop_page_save() {
- $screen = get_current_screen();
- $screen_id = $screen ? $screen->id : '';
-
- // Check if this is the edit page.
- if ( 'page' !== $screen_id ) {
- return;
- }
-
- // Check if page is edited.
- if ( empty( $_GET['post'] ) || empty( $_GET['action'] ) || ( isset( $_GET['action'] ) && 'edit' !== $_GET['action'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
- return;
- }
-
- $post_id = intval( $_GET['post'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
- $shop_page_id = wc_get_page_id( 'shop' );
-
- if ( $shop_page_id === $post_id || in_array( $post_id, wc_get_page_children( $shop_page_id ), true ) ) {
- do_action( 'woocommerce_flush_rewrite_rules' );
- }
-}
-add_action( 'admin_footer', 'flush_rewrite_rules_on_shop_page_save' );
-
-/**
- * Various rewrite rule fixes.
- *
- * @since 2.2
- * @param array $rules Rules.
- * @return array
- */
-function wc_fix_rewrite_rules( $rules ) {
- global $wp_rewrite;
-
- $permalinks = wc_get_permalink_structure();
-
- // Fix the rewrite rules when the product permalink have %product_cat% flag.
- if ( preg_match( '`/(.+)(/%product_cat%)`', $permalinks['product_rewrite_slug'], $matches ) ) {
- foreach ( $rules as $rule => $rewrite ) {
- if ( preg_match( '`^' . preg_quote( $matches[1], '`' ) . '/\(`', $rule ) && preg_match( '/^(index\.php\?product_cat)(?!(.*product))/', $rewrite ) ) {
- unset( $rules[ $rule ] );
- }
- }
- }
-
- // If the shop page is used as the base, we need to handle shop page subpages to avoid 404s.
- if ( ! $permalinks['use_verbose_page_rules'] ) {
- return $rules;
- }
-
- $shop_page_id = wc_get_page_id( 'shop' );
- if ( $shop_page_id ) {
- $page_rewrite_rules = array();
- $subpages = wc_get_page_children( $shop_page_id );
-
- // Subpage rules.
- foreach ( $subpages as $subpage ) {
- $uri = get_page_uri( $subpage );
- $page_rewrite_rules[ $uri . '/?$' ] = 'index.php?pagename=' . $uri;
- $wp_generated_rewrite_rules = $wp_rewrite->generate_rewrite_rules( $uri, EP_PAGES, true, true, false, false );
- foreach ( $wp_generated_rewrite_rules as $key => $value ) {
- $wp_generated_rewrite_rules[ $key ] = $value . '&pagename=' . $uri;
- }
- $page_rewrite_rules = array_merge( $page_rewrite_rules, $wp_generated_rewrite_rules );
- }
-
- // Merge with rules.
- $rules = array_merge( $page_rewrite_rules, $rules );
- }
-
- return $rules;
-}
-add_filter( 'rewrite_rules_array', 'wc_fix_rewrite_rules' );
-
-/**
- * Prevent product attachment links from breaking when using complex rewrite structures.
- *
- * @param string $link Link.
- * @param int $post_id Post ID.
- * @return string
- */
-function wc_fix_product_attachment_link( $link, $post_id ) {
- $parent_type = get_post_type( wp_get_post_parent_id( $post_id ) );
- if ( 'product' === $parent_type || 'product_variation' === $parent_type ) {
- $link = home_url( '/?attachment_id=' . $post_id );
- }
- return $link;
-}
-add_filter( 'attachment_link', 'wc_fix_product_attachment_link', 10, 2 );
-
-/**
- * Protect downloads from ms-files.php in multisite.
- *
- * @param string $rewrite rewrite rules.
- * @return string
- */
-function wc_ms_protect_download_rewite_rules( $rewrite ) {
- if ( ! is_multisite() || 'redirect' === get_option( 'woocommerce_file_download_method' ) ) {
- return $rewrite;
- }
-
- $rule = "\n# WooCommerce Rules - Protect Files from ms-files.php\n\n";
- $rule .= "' . esc_html( is_object( $class ) ? get_class( $class ) : $class ) . '',
- 'woocommerce_logging_class',
- 'WC_Logger_Interface'
- ),
- '3.0'
- );
-
- $logger = is_a( $logger, 'WC_Logger' ) ? $logger : new WC_Logger();
- }
-
- return $logger;
-}
-
-/**
- * Trigger logging cleanup using the logging class.
- *
- * @since 3.4.0
- */
-function wc_cleanup_logs() {
- $logger = wc_get_logger();
-
- if ( is_callable( array( $logger, 'clear_expired_logs' ) ) ) {
- $logger->clear_expired_logs();
- }
-}
-add_action( 'woocommerce_cleanup_logs', 'wc_cleanup_logs' );
-
-/**
- * Prints human-readable information about a variable.
- *
- * Some server environments block some debugging functions. This function provides a safe way to
- * turn an expression into a printable, readable form without calling blocked functions.
- *
- * @since 3.0
- *
- * @param mixed $expression The expression to be printed.
- * @param bool $return Optional. Default false. Set to true to return the human-readable string.
- * @return string|bool False if expression could not be printed. True if the expression was printed.
- * If $return is true, a string representation will be returned.
- */
-function wc_print_r( $expression, $return = false ) {
- $alternatives = array(
- array(
- 'func' => 'print_r',
- 'args' => array( $expression, true ),
- ),
- array(
- 'func' => 'var_export',
- 'args' => array( $expression, true ),
- ),
- array(
- 'func' => 'json_encode',
- 'args' => array( $expression ),
- ),
- array(
- 'func' => 'serialize',
- 'args' => array( $expression ),
- ),
- );
-
- $alternatives = apply_filters( 'woocommerce_print_r_alternatives', $alternatives, $expression );
-
- foreach ( $alternatives as $alternative ) {
- if ( function_exists( $alternative['func'] ) ) {
- $res = $alternative['func']( ...$alternative['args'] );
- if ( $return ) {
- return $res; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
- }
-
- echo $res; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
- return true;
- }
- }
-
- return false;
-}
-
-/**
- * Registers the default log handler.
- *
- * @since 3.0
- * @param array $handlers Handlers.
- * @return array
- */
-function wc_register_default_log_handler( $handlers ) {
- $handler_class = Constants::get_constant( 'WC_LOG_HANDLER' );
- if ( ! class_exists( $handler_class ) ) {
- $handler_class = WC_Log_Handler_File::class;
- }
-
- array_push( $handlers, new $handler_class() );
-
- return $handlers;
-}
-add_filter( 'woocommerce_register_log_handlers', 'wc_register_default_log_handler' );
-
-/**
- * Based on wp_list_pluck, this calls a method instead of returning a property.
- *
- * @since 3.0.0
- * @param array $list List of objects or arrays.
- * @param int|string $callback_or_field Callback method from the object to place instead of the entire object.
- * @param int|string $index_key Optional. Field from the object to use as keys for the new array.
- * Default null.
- * @return array Array of values.
- */
-function wc_list_pluck( $list, $callback_or_field, $index_key = null ) {
- // Use wp_list_pluck if this isn't a callback.
- $first_el = current( $list );
- if ( ! is_object( $first_el ) || ! is_callable( array( $first_el, $callback_or_field ) ) ) {
- return wp_list_pluck( $list, $callback_or_field, $index_key );
- }
- if ( ! $index_key ) {
- /*
- * This is simple. Could at some point wrap array_column()
- * if we knew we had an array of arrays.
- */
- foreach ( $list as $key => $value ) {
- $list[ $key ] = $value->{$callback_or_field}();
- }
- return $list;
- }
-
- /*
- * When index_key is not set for a particular item, push the value
- * to the end of the stack. This is how array_column() behaves.
- */
- $newlist = array();
- foreach ( $list as $value ) {
- // Get index. @since 3.2.0 this supports a callback.
- if ( is_callable( array( $value, $index_key ) ) ) {
- $newlist[ $value->{$index_key}() ] = $value->{$callback_or_field}();
- } elseif ( isset( $value->$index_key ) ) {
- $newlist[ $value->$index_key ] = $value->{$callback_or_field}();
- } else {
- $newlist[] = $value->{$callback_or_field}();
- }
- }
- return $newlist;
-}
-
-/**
- * Get permalink settings for things like products and taxonomies.
- *
- * As of 3.3.0, the permalink settings are stored to the option instead of
- * being blank and inheritting from the locale. This speeds up page loading
- * times by negating the need to switch locales on each page load.
- *
- * This is more inline with WP core behavior which does not localize slugs.
- *
- * @since 3.0.0
- * @return array
- */
-function wc_get_permalink_structure() {
- $saved_permalinks = (array) get_option( 'woocommerce_permalinks', array() );
- $permalinks = wp_parse_args(
- array_filter( $saved_permalinks ),
- array(
- 'product_base' => _x( 'product', 'slug', 'woocommerce' ),
- 'category_base' => _x( 'product-category', 'slug', 'woocommerce' ),
- 'tag_base' => _x( 'product-tag', 'slug', 'woocommerce' ),
- 'attribute_base' => '',
- 'use_verbose_page_rules' => false,
- )
- );
-
- if ( $saved_permalinks !== $permalinks ) {
- update_option( 'woocommerce_permalinks', $permalinks );
- }
-
- $permalinks['product_rewrite_slug'] = untrailingslashit( $permalinks['product_base'] );
- $permalinks['category_rewrite_slug'] = untrailingslashit( $permalinks['category_base'] );
- $permalinks['tag_rewrite_slug'] = untrailingslashit( $permalinks['tag_base'] );
- $permalinks['attribute_rewrite_slug'] = untrailingslashit( $permalinks['attribute_base'] );
-
- return $permalinks;
-}
-
-/**
- * Switch WooCommerce to site language.
- *
- * @since 3.1.0
- */
-function wc_switch_to_site_locale() {
- if ( function_exists( 'switch_to_locale' ) ) {
- switch_to_locale( get_locale() );
-
- // Filter on plugin_locale so load_plugin_textdomain loads the correct locale.
- add_filter( 'plugin_locale', 'get_locale' );
-
- // Init WC locale.
- WC()->load_plugin_textdomain();
- }
-}
-
-/**
- * Switch WooCommerce language to original.
- *
- * @since 3.1.0
- */
-function wc_restore_locale() {
- if ( function_exists( 'restore_previous_locale' ) ) {
- restore_previous_locale();
-
- // Remove filter.
- remove_filter( 'plugin_locale', 'get_locale' );
-
- // Init WC locale.
- WC()->load_plugin_textdomain();
- }
-}
-
-/**
- * Convert plaintext phone number to clickable phone number.
- *
- * Remove formatting and allow "+".
- * Example and specs: https://developer.mozilla.org/en/docs/Web/HTML/Element/a#Creating_a_phone_link
- *
- * @since 3.1.0
- *
- * @param string $phone Content to convert phone number.
- * @return string Content with converted phone number.
- */
-function wc_make_phone_clickable( $phone ) {
- $number = trim( preg_replace( '/[^\d|\+]/', '', $phone ) );
-
- return $number ? '' . esc_html( $phone ) . '' : '';
-}
-
-/**
- * Get an item of post data if set, otherwise return a default value.
- *
- * @since 3.0.9
- * @param string $key Meta key.
- * @param string $default Default value.
- * @return mixed Value sanitized by wc_clean.
- */
-function wc_get_post_data_by_key( $key, $default = '' ) {
- // phpcs:ignore WordPress.Security.ValidatedSanitizedInput, WordPress.Security.NonceVerification.Missing
- return wc_clean( wp_unslash( wc_get_var( $_POST[ $key ], $default ) ) );
-}
-
-/**
- * Get data if set, otherwise return a default value or null. Prevents notices when data is not set.
- *
- * @since 3.2.0
- * @param mixed $var Variable.
- * @param string $default Default value.
- * @return mixed
- */
-function wc_get_var( &$var, $default = null ) {
- return isset( $var ) ? $var : $default;
-}
-
-/**
- * Read in WooCommerce headers when reading plugin headers.
- *
- * @since 3.2.0
- * @param array $headers Headers.
- * @return array
- */
-function wc_enable_wc_plugin_headers( $headers ) {
- if ( ! class_exists( 'WC_Plugin_Updates' ) ) {
- include_once dirname( __FILE__ ) . '/admin/plugin-updates/class-wc-plugin-updates.php';
- }
-
- // WC requires at least - allows developers to define which version of WooCommerce the plugin requires to run.
- $headers[] = WC_Plugin_Updates::VERSION_REQUIRED_HEADER;
-
- // WC tested up to - allows developers to define which version of WooCommerce they have tested up to.
- $headers[] = WC_Plugin_Updates::VERSION_TESTED_HEADER;
-
- // Woo - This is used in WooCommerce extensions and is picked up by the helper.
- $headers[] = 'Woo';
-
- return $headers;
-}
-add_filter( 'extra_theme_headers', 'wc_enable_wc_plugin_headers' );
-add_filter( 'extra_plugin_headers', 'wc_enable_wc_plugin_headers' );
-
-/**
- * Prevent auto-updating the WooCommerce plugin on major releases if there are untested extensions active.
- *
- * @since 3.2.0
- * @param bool $should_update If should update.
- * @param object $plugin Plugin data.
- * @return bool
- */
-function wc_prevent_dangerous_auto_updates( $should_update, $plugin ) {
- if ( ! isset( $plugin->plugin, $plugin->new_version ) ) {
- return $should_update;
- }
-
- if ( 'woocommerce/woocommerce.php' !== $plugin->plugin ) {
- return $should_update;
- }
-
- if ( ! class_exists( 'WC_Plugin_Updates' ) ) {
- include_once dirname( __FILE__ ) . '/admin/plugin-updates/class-wc-plugin-updates.php';
- }
-
- $new_version = wc_clean( $plugin->new_version );
- $plugin_updates = new WC_Plugin_Updates();
- $untested_plugins = $plugin_updates->get_untested_plugins( $new_version, 'major' );
- if ( ! empty( $untested_plugins ) ) {
- return false;
- }
-
- return $should_update;
-}
-add_filter( 'auto_update_plugin', 'wc_prevent_dangerous_auto_updates', 99, 2 );
-
-/**
- * Delete expired transients.
- *
- * Deletes all expired transients. The multi-table delete syntax is used.
- * to delete the transient record from table a, and the corresponding.
- * transient_timeout record from table b.
- *
- * Based on code inside core's upgrade_network() function.
- *
- * @since 3.2.0
- * @return int Number of transients that were cleared.
- */
-function wc_delete_expired_transients() {
- global $wpdb;
-
- // phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
- $sql = "DELETE a, b FROM $wpdb->options a, $wpdb->options b
- WHERE a.option_name LIKE %s
- AND a.option_name NOT LIKE %s
- AND b.option_name = CONCAT( '_transient_timeout_', SUBSTRING( a.option_name, 12 ) )
- AND b.option_value < %d";
- $rows = $wpdb->query( $wpdb->prepare( $sql, $wpdb->esc_like( '_transient_' ) . '%', $wpdb->esc_like( '_transient_timeout_' ) . '%', time() ) );
-
- $sql = "DELETE a, b FROM $wpdb->options a, $wpdb->options b
- WHERE a.option_name LIKE %s
- AND a.option_name NOT LIKE %s
- AND b.option_name = CONCAT( '_site_transient_timeout_', SUBSTRING( a.option_name, 17 ) )
- AND b.option_value < %d";
- $rows2 = $wpdb->query( $wpdb->prepare( $sql, $wpdb->esc_like( '_site_transient_' ) . '%', $wpdb->esc_like( '_site_transient_timeout_' ) . '%', time() ) );
- // phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
-
- return absint( $rows + $rows2 );
-}
-add_action( 'woocommerce_installed', 'wc_delete_expired_transients' );
-
-/**
- * Make a URL relative, if possible.
- *
- * @since 3.2.0
- * @param string $url URL to make relative.
- * @return string
- */
-function wc_get_relative_url( $url ) {
- return wc_is_external_resource( $url ) ? $url : str_replace( array( 'http://', 'https://' ), '//', $url );
-}
-
-/**
- * See if a resource is remote.
- *
- * @since 3.2.0
- * @param string $url URL to check.
- * @return bool
- */
-function wc_is_external_resource( $url ) {
- $wp_base = str_replace( array( 'http://', 'https://' ), '//', get_home_url( null, '/', 'http' ) );
-
- return strstr( $url, '://' ) && ! strstr( $url, $wp_base );
-}
-
-/**
- * See if theme/s is activate or not.
- *
- * @since 3.3.0
- * @param string|array $theme Theme name or array of theme names to check.
- * @return boolean
- */
-function wc_is_active_theme( $theme ) {
- return is_array( $theme ) ? in_array( get_template(), $theme, true ) : get_template() === $theme;
-}
-
-/**
- * Is the site using a default WP theme?
- *
- * @return boolean
- */
-function wc_is_wp_default_theme_active() {
- return wc_is_active_theme(
- array(
- 'twentytwentyone',
- 'twentytwenty',
- 'twentynineteen',
- 'twentyseventeen',
- 'twentysixteen',
- 'twentyfifteen',
- 'twentyfourteen',
- 'twentythirteen',
- 'twentyeleven',
- 'twentytwelve',
- 'twentyten',
- )
- );
-}
-
-/**
- * Cleans up session data - cron callback.
- *
- * @since 3.3.0
- */
-function wc_cleanup_session_data() {
- $session_class = apply_filters( 'woocommerce_session_handler', 'WC_Session_Handler' );
- $session = new $session_class();
-
- if ( is_callable( array( $session, 'cleanup_sessions' ) ) ) {
- $session->cleanup_sessions();
- }
-}
-add_action( 'woocommerce_cleanup_sessions', 'wc_cleanup_session_data' );
-
-/**
- * Convert a decimal (e.g. 3.5) to a fraction (e.g. 7/2).
- * From: https://www.designedbyaturtle.co.uk/2015/converting-a-decimal-to-a-fraction-in-php/
- *
- * @param float $decimal the decimal number.
- * @return array|bool a 1/2 would be [1, 2] array (this can be imploded with '/' to form a string).
- */
-function wc_decimal_to_fraction( $decimal ) {
- if ( 0 > $decimal || ! is_numeric( $decimal ) ) {
- // Negative digits need to be passed in as positive numbers and prefixed as negative once the response is imploded.
- return false;
- }
-
- if ( 0 === $decimal ) {
- return array( 0, 1 );
- }
-
- $tolerance = 1.e-4;
- $numerator = 1;
- $h2 = 0;
- $denominator = 0;
- $k2 = 1;
- $b = 1 / $decimal;
-
- do {
- $b = 1 / $b;
- $a = floor( $b );
- $aux = $numerator;
- $numerator = $a * $numerator + $h2;
- $h2 = $aux;
- $aux = $denominator;
- $denominator = $a * $denominator + $k2;
- $k2 = $aux;
- $b = $b - $a;
- } while ( abs( $decimal - $numerator / $denominator ) > $decimal * $tolerance );
-
- return array( $numerator, $denominator );
-}
-
-/**
- * Round discount.
- *
- * @param double $value Amount to round.
- * @param int $precision DP to round.
- * @return float
- */
-function wc_round_discount( $value, $precision ) {
- if ( version_compare( PHP_VERSION, '5.3.0', '>=' ) ) {
- return NumberUtil::round( $value, $precision, WC_DISCOUNT_ROUNDING_MODE ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.round_modeFound
- }
-
- if ( 2 === WC_DISCOUNT_ROUNDING_MODE ) {
- return wc_legacy_round_half_down( $value, $precision );
- }
-
- return NumberUtil::round( $value, $precision );
-}
-
-/**
- * Return the html selected attribute if stringified $value is found in array of stringified $options
- * or if stringified $value is the same as scalar stringified $options.
- *
- * @param string|int $value Value to find within options.
- * @param string|int|array $options Options to go through when looking for value.
- * @return string
- */
-function wc_selected( $value, $options ) {
- if ( is_array( $options ) ) {
- $options = array_map( 'strval', $options );
- return selected( in_array( (string) $value, $options, true ), true, false );
- }
-
- return selected( $value, $options, false );
-}
-
-/**
- * Retrieves the MySQL server version. Based on $wpdb.
- *
- * @since 3.4.1
- * @return array Vesion information.
- */
-function wc_get_server_database_version() {
- global $wpdb;
-
- if ( empty( $wpdb->is_mysql ) ) {
- return array(
- 'string' => '',
- 'number' => '',
- );
- }
-
- // phpcs:disable WordPress.DB.RestrictedFunctions, PHPCompatibility.Extensions.RemovedExtensions.mysql_DeprecatedRemoved
- if ( $wpdb->use_mysqli ) {
- $server_info = mysqli_get_server_info( $wpdb->dbh );
- } else {
- $server_info = mysql_get_server_info( $wpdb->dbh );
- }
- // phpcs:enable WordPress.DB.RestrictedFunctions, PHPCompatibility.Extensions.RemovedExtensions.mysql_DeprecatedRemoved
-
- return array(
- 'string' => $server_info,
- 'number' => preg_replace( '/([^\d.]+).*/', '', $server_info ),
- );
-}
-
-/**
- * Initialize and load the cart functionality.
- *
- * @since 3.6.4
- * @return void
- */
-function wc_load_cart() {
- if ( ! did_action( 'before_woocommerce_init' ) || doing_action( 'before_woocommerce_init' ) ) {
- /* translators: 1: wc_load_cart 2: woocommerce_init */
- wc_doing_it_wrong( __FUNCTION__, sprintf( __( '%1$s should not be called before the %2$s action.', 'woocommerce' ), 'wc_load_cart', 'woocommerce_init' ), '3.7' );
- return;
- }
-
- // Ensure dependencies are loaded in all contexts.
- include_once WC_ABSPATH . 'includes/wc-cart-functions.php';
- include_once WC_ABSPATH . 'includes/wc-notice-functions.php';
-
- WC()->initialize_session();
- WC()->initialize_cart();
-}
-
-/**
- * Test whether the context of execution comes from async action scheduler.
- *
- * @since 4.0.0
- * @return bool
- */
-function wc_is_running_from_async_action_scheduler() {
- // phpcs:ignore WordPress.Security.NonceVerification.Recommended
- return isset( $_REQUEST['action'] ) && 'as_async_request_queue_runner' === $_REQUEST['action'];
-}
-
-/**
- * Polyfill for wp_cache_get_multiple for WP versions before 5.5.
- *
- * @param array $keys Array of keys to get from group.
- * @param string $group Optional. Where the cache contents are grouped. Default empty.
- * @param bool $force Optional. Whether to force an update of the local cache from the persistent
- * cache. Default false.
- * @return array|bool Array of values.
- */
-function wc_cache_get_multiple( $keys, $group = '', $force = false ) {
- if ( function_exists( 'wp_cache_get_multiple' ) ) {
- return wp_cache_get_multiple( $keys, $group, $force );
- }
- $values = array();
- foreach ( $keys as $key ) {
- $values[ $key ] = wp_cache_get( $key, $group, $force );
- }
- return $values;
-}
diff --git a/includes/wc-deprecated-functions.php b/includes/wc-deprecated-functions.php
deleted file mode 100644
index ea5f57f7191..00000000000
--- a/includes/wc-deprecated-functions.php
+++ /dev/null
@@ -1,1125 +0,0 @@
-is_rest_api_request() ) {
- do_action( 'deprecated_function_run', $function, $replacement, $version );
- $log_string = "The {$function} function is deprecated since version {$version}.";
- $log_string .= $replacement ? " Replace with {$replacement}." : '';
- error_log( $log_string );
- } else {
- _deprecated_function( $function, $version, $replacement );
- }
- // @codingStandardsIgnoreEnd
-}
-
-/**
- * Wrapper for deprecated hook so we can apply some extra logic.
- *
- * @since 3.3.0
- * @param string $hook The hook that was used.
- * @param string $version The version of WordPress that deprecated the hook.
- * @param string $replacement The hook that should have been used.
- * @param string $message A message regarding the change.
- */
-function wc_deprecated_hook( $hook, $version, $replacement = null, $message = null ) {
- // @codingStandardsIgnoreStart
- if ( is_ajax() || WC()->is_rest_api_request() ) {
- do_action( 'deprecated_hook_run', $hook, $replacement, $version, $message );
-
- $message = empty( $message ) ? '' : ' ' . $message;
- $log_string = "{$hook} is deprecated since version {$version}";
- $log_string .= $replacement ? "! Use {$replacement} instead." : ' with no alternative available.';
-
- error_log( $log_string . $message );
- } else {
- _deprecated_hook( $hook, $version, $replacement, $message );
- }
- // @codingStandardsIgnoreEnd
-}
-
-/**
- * When catching an exception, this allows us to log it if unexpected.
- *
- * @since 3.3.0
- * @param Exception $exception_object The exception object.
- * @param string $function The function which threw exception.
- * @param array $args The args passed to the function.
- */
-function wc_caught_exception( $exception_object, $function = '', $args = array() ) {
- // @codingStandardsIgnoreStart
- $message = $exception_object->getMessage();
- $message .= '. Args: ' . print_r( $args, true ) . '.';
-
- do_action( 'woocommerce_caught_exception', $exception_object, $function, $args );
- error_log( "Exception caught in {$function}. {$message}." );
- // @codingStandardsIgnoreEnd
-}
-
-/**
- * Wrapper for _doing_it_wrong().
- *
- * @since 3.0.0
- * @param string $function Function used.
- * @param string $message Message to log.
- * @param string $version Version the message was added in.
- */
-function wc_doing_it_wrong( $function, $message, $version ) {
- // @codingStandardsIgnoreStart
- $message .= ' Backtrace: ' . wp_debug_backtrace_summary();
-
- if ( is_ajax() || WC()->is_rest_api_request() ) {
- do_action( 'doing_it_wrong_run', $function, $message, $version );
- error_log( "{$function} was called incorrectly. {$message}. This message was added in version {$version}." );
- } else {
- _doing_it_wrong( $function, $message, $version );
- }
- // @codingStandardsIgnoreEnd
-}
-
-/**
- * Wrapper for deprecated arguments so we can apply some extra logic.
- *
- * @since 3.0.0
- * @param string $argument
- * @param string $version
- * @param string $replacement
- */
-function wc_deprecated_argument( $argument, $version, $message = null ) {
- if ( is_ajax() || WC()->is_rest_api_request() ) {
- do_action( 'deprecated_argument_run', $argument, $message, $version );
- error_log( "The {$argument} argument is deprecated since version {$version}. {$message}" );
- } else {
- _deprecated_argument( $argument, $version, $message );
- }
-}
-
-/**
- * @deprecated 2.1
- */
-function woocommerce_show_messages() {
- wc_deprecated_function( 'woocommerce_show_messages', '2.1', 'wc_print_notices' );
- wc_print_notices();
-}
-
-/**
- * @deprecated 2.1
- */
-function woocommerce_weekend_area_js() {
- wc_deprecated_function( 'woocommerce_weekend_area_js', '2.1' );
-}
-
-/**
- * @deprecated 2.1
- */
-function woocommerce_tooltip_js() {
- wc_deprecated_function( 'woocommerce_tooltip_js', '2.1' );
-}
-
-/**
- * @deprecated 2.1
- */
-function woocommerce_datepicker_js() {
- wc_deprecated_function( 'woocommerce_datepicker_js', '2.1' );
-}
-
-/**
- * @deprecated 2.1
- */
-function woocommerce_admin_scripts() {
- wc_deprecated_function( 'woocommerce_admin_scripts', '2.1' );
-}
-
-/**
- * @deprecated 2.1
- */
-function woocommerce_create_page( $slug, $option = '', $page_title = '', $page_content = '', $post_parent = 0 ) {
- wc_deprecated_function( 'woocommerce_create_page', '2.1', 'wc_create_page' );
- return wc_create_page( $slug, $option, $page_title, $page_content, $post_parent );
-}
-
-/**
- * @deprecated 2.1
- */
-function woocommerce_readfile_chunked( $file, $retbytes = true ) {
- wc_deprecated_function( 'woocommerce_readfile_chunked', '2.1', 'WC_Download_Handler::readfile_chunked()' );
- return WC_Download_Handler::readfile_chunked( $file );
-}
-
-/**
- * Formal total costs - format to the number of decimal places for the base currency.
- *
- * @access public
- * @param mixed $number
- * @deprecated 2.1
- * @return string
- */
-function woocommerce_format_total( $number ) {
- wc_deprecated_function( __FUNCTION__, '2.1', 'wc_format_decimal()' );
- return wc_format_decimal( $number, wc_get_price_decimals(), false );
-}
-
-/**
- * Get product name with extra details such as SKU price and attributes. Used within admin.
- *
- * @access public
- * @param WC_Product $product
- * @deprecated 2.1
- * @return string
- */
-function woocommerce_get_formatted_product_name( $product ) {
- wc_deprecated_function( __FUNCTION__, '2.1', 'WC_Product::get_formatted_name()' );
- return $product->get_formatted_name();
-}
-
-/**
- * Handle IPN requests for the legacy paypal gateway by calling gateways manually if needed.
- *
- * @access public
- */
-function woocommerce_legacy_paypal_ipn() {
- if ( ! empty( $_GET['paypalListener'] ) && 'paypal_standard_IPN' === $_GET['paypalListener'] ) {
- WC()->payment_gateways();
- do_action( 'woocommerce_api_wc_gateway_paypal' );
- }
-}
-add_action( 'init', 'woocommerce_legacy_paypal_ipn' );
-
-/**
- * @deprecated 3.0
- */
-function get_product( $the_product = false, $args = array() ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_product' );
- return wc_get_product( $the_product, $args );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_protected_product_add_to_cart( $passed, $product_id ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_protected_product_add_to_cart' );
- return wc_protected_product_add_to_cart( $passed, $product_id );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_empty_cart() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_empty_cart' );
- wc_empty_cart();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_load_persistent_cart( $user_login, $user = 0 ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_load_persistent_cart' );
- return wc_load_persistent_cart( $user_login, $user );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_add_to_cart_message( $product_id ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_add_to_cart_message' );
- wc_add_to_cart_message( $product_id );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_clear_cart_after_payment() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_clear_cart_after_payment' );
- wc_clear_cart_after_payment();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_cart_totals_subtotal_html() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_cart_totals_subtotal_html' );
- wc_cart_totals_subtotal_html();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_cart_totals_shipping_html() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_cart_totals_shipping_html' );
- wc_cart_totals_shipping_html();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_cart_totals_coupon_html( $coupon ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_cart_totals_coupon_html' );
- wc_cart_totals_coupon_html( $coupon );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_cart_totals_order_total_html() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_cart_totals_order_total_html' );
- wc_cart_totals_order_total_html();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_cart_totals_fee_html( $fee ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_cart_totals_fee_html' );
- wc_cart_totals_fee_html( $fee );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_cart_totals_shipping_method_label( $method ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_cart_totals_shipping_method_label' );
- return wc_cart_totals_shipping_method_label( $method );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_template_part( $slug, $name = '' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_template_part' );
- wc_get_template_part( $slug, $name );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_template' );
- wc_get_template( $template_name, $args, $template_path, $default_path );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_locate_template( $template_name, $template_path = '', $default_path = '' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_locate_template' );
- return wc_locate_template( $template_name, $template_path, $default_path );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_mail( $to, $subject, $message, $headers = "Content-Type: text/html\r\n", $attachments = "" ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_mail' );
- wc_mail( $to, $subject, $message, $headers, $attachments );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_disable_admin_bar( $show_admin_bar ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_disable_admin_bar' );
- return wc_disable_admin_bar( $show_admin_bar );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_create_new_customer( $email, $username = '', $password = '' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_create_new_customer' );
- return wc_create_new_customer( $email, $username, $password );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_set_customer_auth_cookie( $customer_id ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_set_customer_auth_cookie' );
- wc_set_customer_auth_cookie( $customer_id );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_update_new_customer_past_orders( $customer_id ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_update_new_customer_past_orders' );
- return wc_update_new_customer_past_orders( $customer_id );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_paying_customer( $order_id ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_paying_customer' );
- wc_paying_customer( $order_id );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_customer_bought_product( $customer_email, $user_id, $product_id ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_customer_bought_product' );
- return wc_customer_bought_product( $customer_email, $user_id, $product_id );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_customer_has_capability( $allcaps, $caps, $args ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_customer_has_capability' );
- return wc_customer_has_capability( $allcaps, $caps, $args );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_sanitize_taxonomy_name( $taxonomy ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_sanitize_taxonomy_name' );
- return wc_sanitize_taxonomy_name( $taxonomy );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_filename_from_url( $file_url ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_filename_from_url' );
- return wc_get_filename_from_url( $file_url );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_dimension( $dim, $to_unit ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_dimension' );
- return wc_get_dimension( $dim, $to_unit );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_weight( $weight, $to_unit ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_weight' );
- return wc_get_weight( $weight, $to_unit );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_trim_zeros( $price ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_trim_zeros' );
- return wc_trim_zeros( $price );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_round_tax_total( $tax ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_round_tax_total' );
- return wc_round_tax_total( $tax );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_format_decimal( $number, $dp = false, $trim_zeros = false ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_format_decimal' );
- return wc_format_decimal( $number, $dp, $trim_zeros );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_clean( $var ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_clean' );
- return wc_clean( $var );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_array_overlay( $a1, $a2 ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_array_overlay' );
- return wc_array_overlay( $a1, $a2 );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_price( $price, $args = array() ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_price' );
- return wc_price( $price, $args );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_let_to_num( $size ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_let_to_num' );
- return wc_let_to_num( $size );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_date_format() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_date_format' );
- return wc_date_format();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_time_format() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_time_format' );
- return wc_time_format();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_timezone_string() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_timezone_string' );
- return wc_timezone_string();
-}
-
-if ( ! function_exists( 'woocommerce_rgb_from_hex' ) ) {
- /**
- * @deprecated 3.0
- */
- function woocommerce_rgb_from_hex( $color ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_rgb_from_hex' );
- return wc_rgb_from_hex( $color );
- }
-}
-
-if ( ! function_exists( 'woocommerce_hex_darker' ) ) {
- /**
- * @deprecated 3.0
- */
- function woocommerce_hex_darker( $color, $factor = 30 ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_hex_darker' );
- return wc_hex_darker( $color, $factor );
- }
-}
-
-if ( ! function_exists( 'woocommerce_hex_lighter' ) ) {
- /**
- * @deprecated 3.0
- */
- function woocommerce_hex_lighter( $color, $factor = 30 ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_hex_lighter' );
- return wc_hex_lighter( $color, $factor );
- }
-}
-
-if ( ! function_exists( 'woocommerce_light_or_dark' ) ) {
- /**
- * @deprecated 3.0
- */
- function woocommerce_light_or_dark( $color, $dark = '#000000', $light = '#FFFFFF' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_light_or_dark' );
- return wc_light_or_dark( $color, $dark, $light );
- }
-}
-
-if ( ! function_exists( 'woocommerce_format_hex' ) ) {
- /**
- * @deprecated 3.0
- */
- function woocommerce_format_hex( $hex ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_format_hex' );
- return wc_format_hex( $hex );
- }
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_order_id_by_order_key( $order_key ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_order_id_by_order_key' );
- return wc_get_order_id_by_order_key( $order_key );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_downloadable_file_permission( $download_id, $product_id, $order ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_downloadable_file_permission' );
- return wc_downloadable_file_permission( $download_id, $product_id, $order );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_downloadable_product_permissions( $order_id ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_downloadable_product_permissions' );
- wc_downloadable_product_permissions( $order_id );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_add_order_item( $order_id, $item ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_add_order_item' );
- return wc_add_order_item( $order_id, $item );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_delete_order_item( $item_id ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_delete_order_item' );
- return wc_delete_order_item( $item_id );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_update_order_item_meta( $item_id, $meta_key, $meta_value, $prev_value = '' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_update_order_item_meta' );
- return wc_update_order_item_meta( $item_id, $meta_key, $meta_value, $prev_value );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_add_order_item_meta( $item_id, $meta_key, $meta_value, $unique = false ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_add_order_item_meta' );
- return wc_add_order_item_meta( $item_id, $meta_key, $meta_value, $unique );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_delete_order_item_meta( $item_id, $meta_key, $meta_value = '', $delete_all = false ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_delete_order_item_meta' );
- return wc_delete_order_item_meta( $item_id, $meta_key, $meta_value, $delete_all );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_order_item_meta( $item_id, $key, $single = true ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_order_item_meta' );
- return wc_get_order_item_meta( $item_id, $key, $single );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_cancel_unpaid_orders() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_cancel_unpaid_orders' );
- wc_cancel_unpaid_orders();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_processing_order_count() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_processing_order_count' );
- return wc_processing_order_count();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_page_id( $page ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_page_id' );
- return wc_get_page_id( $page );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_endpoint_url( $endpoint, $value = '', $permalink = '' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_endpoint_url' );
- return wc_get_endpoint_url( $endpoint, $value, $permalink );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_lostpassword_url( $url ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_lostpassword_url' );
- return wc_lostpassword_url( $url );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_customer_edit_account_url() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_customer_edit_account_url' );
- return wc_customer_edit_account_url();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_nav_menu_items( $items, $args ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_nav_menu_items' );
- return wc_nav_menu_items( $items );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_nav_menu_item_classes( $menu_items, $args ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_nav_menu_item_classes' );
- return wc_nav_menu_item_classes( $menu_items );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_list_pages( $pages ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_list_pages' );
- return wc_list_pages( $pages );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_product_dropdown_categories( $args = array(), $deprecated_hierarchical = 1, $deprecated_show_uncategorized = 1, $deprecated_orderby = '' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_product_dropdown_categories' );
- return wc_product_dropdown_categories( $args, $deprecated_hierarchical, $deprecated_show_uncategorized, $deprecated_orderby );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_walk_category_dropdown_tree( $a1 = '', $a2 = '', $a3 = '' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_walk_category_dropdown_tree' );
- return wc_walk_category_dropdown_tree( $a1, $a2, $a3 );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_taxonomy_metadata_wpdbfix() {
- wc_deprecated_function( __FUNCTION__, '3.0' );
-}
-
-/**
- * @deprecated 3.0
- */
-function wc_taxonomy_metadata_wpdbfix() {
- wc_deprecated_function( __FUNCTION__, '3.0' );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_order_terms( $the_term, $next_id, $taxonomy, $index = 0, $terms = null ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_reorder_terms' );
- return wc_reorder_terms( $the_term, $next_id, $taxonomy, $index, $terms );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_set_term_order( $term_id, $index, $taxonomy, $recursive = false ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_set_term_order' );
- return wc_set_term_order( $term_id, $index, $taxonomy, $recursive );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_terms_clauses( $clauses, $taxonomies, $args ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_terms_clauses' );
- return wc_terms_clauses( $clauses, $taxonomies, $args );
-}
-
-/**
- * @deprecated 3.0
- */
-function _woocommerce_term_recount( $terms, $taxonomy, $callback, $terms_are_term_taxonomy_ids ) {
- wc_deprecated_function( __FUNCTION__, '3.0', '_wc_term_recount' );
- return _wc_term_recount( $terms, $taxonomy, $callback, $terms_are_term_taxonomy_ids );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_recount_after_stock_change( $product_id ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_recount_after_stock_change' );
- return wc_recount_after_stock_change( $product_id );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_change_term_counts( $terms, $taxonomies, $args ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_change_term_counts' );
- return wc_change_term_counts( $terms, $taxonomies );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_product_ids_on_sale() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_product_ids_on_sale' );
- return wc_get_product_ids_on_sale();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_featured_product_ids() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_featured_product_ids' );
- return wc_get_featured_product_ids();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_product_terms( $object_id, $taxonomy, $fields = 'all' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_product_terms' );
- return wc_get_product_terms( $object_id, $taxonomy, array( 'fields' => $fields ) );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_product_post_type_link( $permalink, $post ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_product_post_type_link' );
- return wc_product_post_type_link( $permalink, $post );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_placeholder_img_src() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_placeholder_img_src' );
- return wc_placeholder_img_src();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_placeholder_img( $size = 'woocommerce_thumbnail' ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_placeholder_img' );
- return wc_placeholder_img( $size );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_formatted_variation( $variation = '', $flat = false ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_formatted_variation' );
- return wc_get_formatted_variation( $variation, $flat );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_scheduled_sales() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_scheduled_sales' );
- return wc_scheduled_sales();
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_get_attachment_image_attributes( $attr ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_get_attachment_image_attributes' );
- return wc_get_attachment_image_attributes( $attr );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_prepare_attachment_for_js( $response ) {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_prepare_attachment_for_js' );
- return wc_prepare_attachment_for_js( $response );
-}
-
-/**
- * @deprecated 3.0
- */
-function woocommerce_track_product_view() {
- wc_deprecated_function( __FUNCTION__, '3.0', 'wc_track_product_view' );
- return wc_track_product_view();
-}
-
-/**
- * @deprecated 2.3 has no replacement
- */
-function woocommerce_compile_less_styles() {
- wc_deprecated_function( 'woocommerce_compile_less_styles', '2.3' );
-}
-
-/**
- * woocommerce_calc_shipping was an option used to determine if shipping was enabled prior to version 2.6.0. This has since been replaced with wc_shipping_enabled() function and
- * the woocommerce_ship_to_countries setting.
- * @deprecated 2.6.0
- * @return string
- */
-function woocommerce_calc_shipping_backwards_compatibility( $value ) {
- if ( Constants::is_defined( 'WC_UPDATING' ) ) {
- return $value;
- }
- return 'disabled' === get_option( 'woocommerce_ship_to_countries' ) ? 'no' : 'yes';
-}
-add_filter( 'pre_option_woocommerce_calc_shipping', 'woocommerce_calc_shipping_backwards_compatibility' );
-
-/**
- * @deprecated 3.0.0
- * @see WC_Structured_Data class
- *
- * @return string
- */
-function woocommerce_get_product_schema() {
- wc_deprecated_function( 'woocommerce_get_product_schema', '3.0' );
-
- global $product;
-
- $schema = "Product";
-
- // Downloadable product schema handling
- if ( $product->is_downloadable() ) {
- switch ( $product->download_type ) {
- case 'application' :
- $schema = "SoftwareApplication";
- break;
- case 'music' :
- $schema = "MusicAlbum";
- break;
- default :
- $schema = "Product";
- break;
- }
- }
-
- return 'http://schema.org/' . $schema;
-}
-
-/**
- * Save product price.
- *
- * This is a private function (internal use ONLY) used until a data manipulation api is built.
- *
- * @deprecated 3.0.0
- * @param int $product_id
- * @param float $regular_price
- * @param float $sale_price
- * @param string $date_from
- * @param string $date_to
- */
-function _wc_save_product_price( $product_id, $regular_price, $sale_price = '', $date_from = '', $date_to = '' ) {
- wc_doing_it_wrong( '_wc_save_product_price()', 'This function is not for developer use and is deprecated.', '3.0' );
-
- $product_id = absint( $product_id );
- $regular_price = wc_format_decimal( $regular_price );
- $sale_price = '' === $sale_price ? '' : wc_format_decimal( $sale_price );
- $date_from = wc_clean( $date_from );
- $date_to = wc_clean( $date_to );
-
- update_post_meta( $product_id, '_regular_price', $regular_price );
- update_post_meta( $product_id, '_sale_price', $sale_price );
-
- // Save Dates
- update_post_meta( $product_id, '_sale_price_dates_from', $date_from ? strtotime( $date_from ) : '' );
- update_post_meta( $product_id, '_sale_price_dates_to', $date_to ? strtotime( $date_to ) : '' );
-
- if ( $date_to && ! $date_from ) {
- $date_from = strtotime( 'NOW', current_time( 'timestamp' ) );
- update_post_meta( $product_id, '_sale_price_dates_from', $date_from );
- }
-
- // Update price if on sale
- if ( '' !== $sale_price && '' === $date_to && '' === $date_from ) {
- update_post_meta( $product_id, '_price', $sale_price );
- } else {
- update_post_meta( $product_id, '_price', $regular_price );
- }
-
- if ( '' !== $sale_price && $date_from && strtotime( $date_from ) < strtotime( 'NOW', current_time( 'timestamp' ) ) ) {
- update_post_meta( $product_id, '_price', $sale_price );
- }
-
- if ( $date_to && strtotime( $date_to ) < strtotime( 'NOW', current_time( 'timestamp' ) ) ) {
- update_post_meta( $product_id, '_price', $regular_price );
- update_post_meta( $product_id, '_sale_price_dates_from', '' );
- update_post_meta( $product_id, '_sale_price_dates_to', '' );
- }
-}
-
-/**
- * Return customer avatar URL.
- *
- * @deprecated 3.1.0
- * @since 2.6.0
- * @param string $email the customer's email.
- * @return string the URL to the customer's avatar.
- */
-function wc_get_customer_avatar_url( $email ) {
- // Deprecated in favor of WordPress get_avatar_url() function.
- wc_deprecated_function( 'wc_get_customer_avatar_url()', '3.1', 'get_avatar_url()' );
-
- return get_avatar_url( $email );
-}
-
-/**
- * WooCommerce Core Supported Themes.
- *
- * @deprecated 3.3.0
- * @since 2.2
- * @return string[]
- */
-function wc_get_core_supported_themes() {
- wc_deprecated_function( 'wc_get_core_supported_themes()', '3.3' );
- return array( 'twentyseventeen', 'twentysixteen', 'twentyfifteen', 'twentyfourteen', 'twentythirteen', 'twentyeleven', 'twentytwelve', 'twentyten' );
-}
-
-/**
- * Get min/max price meta query args.
- *
- * @deprecated 3.6.0
- * @since 3.0.0
- * @param array $args Min price and max price arguments.
- * @return array
- */
-function wc_get_min_max_price_meta_query( $args ) {
- wc_deprecated_function( 'wc_get_min_max_price_meta_query()', '3.6' );
-
- $current_min_price = isset( $args['min_price'] ) ? floatval( $args['min_price'] ) : 0;
- $current_max_price = isset( $args['max_price'] ) ? floatval( $args['max_price'] ) : PHP_INT_MAX;
-
- return apply_filters(
- 'woocommerce_get_min_max_price_meta_query',
- array(
- 'key' => '_price',
- 'value' => array( $current_min_price, $current_max_price ),
- 'compare' => 'BETWEEN',
- 'type' => 'DECIMAL(10,' . wc_get_price_decimals() . ')',
- ),
- $args
- );
-}
-
-/**
- * When a term is split, ensure meta data maintained.
- *
- * @deprecated 3.6.0
- * @param int $old_term_id Old term ID.
- * @param int $new_term_id New term ID.
- * @param string $term_taxonomy_id Term taxonomy ID.
- * @param string $taxonomy Taxonomy.
- */
-function wc_taxonomy_metadata_update_content_for_split_terms( $old_term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) {
- wc_deprecated_function( 'wc_taxonomy_metadata_update_content_for_split_terms', '3.6' );
-}
-
-/**
- * WooCommerce Term Meta API.
- *
- * WC tables for storing term meta are deprecated from WordPress 4.4 since 4.4 has its own table.
- * This function serves as a wrapper, using the new table if present, or falling back to the WC table.
- *
- * @deprecated 3.6.0
- * @param int $term_id Term ID.
- * @param string $meta_key Meta key.
- * @param mixed $meta_value Meta value.
- * @param string $prev_value Previous value. (default: '').
- * @return bool
- */
-function update_woocommerce_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
- wc_deprecated_function( 'update_woocommerce_term_meta', '3.6', 'update_term_meta' );
- return function_exists( 'update_term_meta' ) ? update_term_meta( $term_id, $meta_key, $meta_value, $prev_value ) : update_metadata( 'woocommerce_term', $term_id, $meta_key, $meta_value, $prev_value );
-}
-
-/**
- * WooCommerce Term Meta API.
- *
- * WC tables for storing term meta are deprecated from WordPress 4.4 since 4.4 has its own table.
- * This function serves as a wrapper, using the new table if present, or falling back to the WC table.
- *
- * @deprecated 3.6.0
- * @param int $term_id Term ID.
- * @param string $meta_key Meta key.
- * @param mixed $meta_value Meta value.
- * @param bool $unique Make meta key unique. (default: false).
- * @return bool
- */
-function add_woocommerce_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
- wc_deprecated_function( 'add_woocommerce_term_meta', '3.6', 'add_term_meta' );
- return function_exists( 'add_term_meta' ) ? add_term_meta( $term_id, $meta_key, $meta_value, $unique ) : add_metadata( 'woocommerce_term', $term_id, $meta_key, $meta_value, $unique );
-}
-
-/**
- * WooCommerce Term Meta API
- *
- * WC tables for storing term meta are deprecated from WordPress 4.4 since 4.4 has its own table.
- * This function serves as a wrapper, using the new table if present, or falling back to the WC table.
- *
- * @deprecated 3.6.0
- * @param int $term_id Term ID.
- * @param string $meta_key Meta key.
- * @param string $meta_value Meta value (default: '').
- * @param bool $deprecated Deprecated param (default: false).
- * @return bool
- */
-function delete_woocommerce_term_meta( $term_id, $meta_key, $meta_value = '', $deprecated = false ) {
- wc_deprecated_function( 'delete_woocommerce_term_meta', '3.6', 'delete_term_meta' );
- return function_exists( 'delete_term_meta' ) ? delete_term_meta( $term_id, $meta_key, $meta_value ) : delete_metadata( 'woocommerce_term', $term_id, $meta_key, $meta_value );
-}
-
-/**
- * WooCommerce Term Meta API
- *
- * WC tables for storing term meta are deprecated from WordPress 4.4 since 4.4 has its own table.
- * This function serves as a wrapper, using the new table if present, or falling back to the WC table.
- *
- * @deprecated 3.6.0
- * @param int $term_id Term ID.
- * @param string $key Meta key.
- * @param bool $single Whether to return a single value. (default: true).
- * @return mixed
- */
-function get_woocommerce_term_meta( $term_id, $key, $single = true ) {
- wc_deprecated_function( 'get_woocommerce_term_meta', '3.6', 'get_term_meta' );
- return function_exists( 'get_term_meta' ) ? get_term_meta( $term_id, $key, $single ) : get_metadata( 'woocommerce_term', $term_id, $key, $single );
-}
diff --git a/includes/wc-formatting-functions.php b/includes/wc-formatting-functions.php
deleted file mode 100644
index a48b3df5937..00000000000
--- a/includes/wc-formatting-functions.php
+++ /dev/null
@@ -1,1516 +0,0 @@
-strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
-
- if ( is_wp_error( $value ) ) {
- $value = '';
- }
-
- $value = esc_url_raw( trim( $value ) );
- $value = str_replace( 'http://', '', $value );
- return untrailingslashit( $value );
-}
-
-/**
- * Gets the filename part of a download URL.
- *
- * @param string $file_url File URL.
- * @return string
- */
-function wc_get_filename_from_url( $file_url ) {
- $parts = wp_parse_url( $file_url );
- if ( isset( $parts['path'] ) ) {
- return basename( $parts['path'] );
- }
-}
-
-/**
- * Normalise dimensions, unify to cm then convert to wanted unit value.
- *
- * Usage:
- * wc_get_dimension( 55, 'in' );
- * wc_get_dimension( 55, 'in', 'm' );
- *
- * @param int|float $dimension Dimension.
- * @param string $to_unit Unit to convert to.
- * Options: 'in', 'm', 'cm', 'm'.
- * @param string $from_unit Unit to convert from.
- * Defaults to ''.
- * Options: 'in', 'm', 'cm', 'm'.
- * @return float
- */
-function wc_get_dimension( $dimension, $to_unit, $from_unit = '' ) {
- $to_unit = strtolower( $to_unit );
-
- if ( empty( $from_unit ) ) {
- $from_unit = strtolower( get_option( 'woocommerce_dimension_unit' ) );
- }
-
- // Unify all units to cm first.
- if ( $from_unit !== $to_unit ) {
- switch ( $from_unit ) {
- case 'in':
- $dimension *= 2.54;
- break;
- case 'm':
- $dimension *= 100;
- break;
- case 'mm':
- $dimension *= 0.1;
- break;
- case 'yd':
- $dimension *= 91.44;
- break;
- }
-
- // Output desired unit.
- switch ( $to_unit ) {
- case 'in':
- $dimension *= 0.3937;
- break;
- case 'm':
- $dimension *= 0.01;
- break;
- case 'mm':
- $dimension *= 10;
- break;
- case 'yd':
- $dimension *= 0.010936133;
- break;
- }
- }
-
- return ( $dimension < 0 ) ? 0 : $dimension;
-}
-
-/**
- * Normalise weights, unify to kg then convert to wanted unit value.
- *
- * Usage:
- * wc_get_weight(55, 'kg');
- * wc_get_weight(55, 'kg', 'lbs');
- *
- * @param int|float $weight Weight.
- * @param string $to_unit Unit to convert to.
- * Options: 'g', 'kg', 'lbs', 'oz'.
- * @param string $from_unit Unit to convert from.
- * Defaults to ''.
- * Options: 'g', 'kg', 'lbs', 'oz'.
- * @return float
- */
-function wc_get_weight( $weight, $to_unit, $from_unit = '' ) {
- $weight = (float) $weight;
- $to_unit = strtolower( $to_unit );
-
- if ( empty( $from_unit ) ) {
- $from_unit = strtolower( get_option( 'woocommerce_weight_unit' ) );
- }
-
- // Unify all units to kg first.
- if ( $from_unit !== $to_unit ) {
- switch ( $from_unit ) {
- case 'g':
- $weight *= 0.001;
- break;
- case 'lbs':
- $weight *= 0.453592;
- break;
- case 'oz':
- $weight *= 0.0283495;
- break;
- }
-
- // Output desired unit.
- switch ( $to_unit ) {
- case 'g':
- $weight *= 1000;
- break;
- case 'lbs':
- $weight *= 2.20462;
- break;
- case 'oz':
- $weight *= 35.274;
- break;
- }
- }
-
- return ( $weight < 0 ) ? 0 : $weight;
-}
-
-/**
- * Trim trailing zeros off prices.
- *
- * @param string|float|int $price Price.
- * @return string
- */
-function wc_trim_zeros( $price ) {
- return preg_replace( '/' . preg_quote( wc_get_price_decimal_separator(), '/' ) . '0++$/', '', $price );
-}
-
-/**
- * Round a tax amount.
- *
- * @param double $value Amount to round.
- * @param int $precision DP to round. Defaults to wc_get_price_decimals.
- * @return float
- */
-function wc_round_tax_total( $value, $precision = null ) {
- $precision = is_null( $precision ) ? wc_get_price_decimals() : intval( $precision );
-
- if ( version_compare( PHP_VERSION, '5.3.0', '>=' ) ) {
- $rounded_tax = NumberUtil::round( $value, $precision, wc_get_tax_rounding_mode() ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.round_modeFound
- } elseif ( 2 === wc_get_tax_rounding_mode() ) {
- $rounded_tax = wc_legacy_round_half_down( $value, $precision );
- } else {
- $rounded_tax = NumberUtil::round( $value, $precision );
- }
-
- return apply_filters( 'wc_round_tax_total', $rounded_tax, $value, $precision, WC_TAX_ROUNDING_MODE );
-}
-
-/**
- * Round half down in PHP 5.2.
- *
- * @since 3.2.6
- * @param float $value Value to round.
- * @param int $precision Precision to round down to.
- * @return float
- */
-function wc_legacy_round_half_down( $value, $precision ) {
- $value = wc_float_to_string( $value );
-
- if ( false !== strstr( $value, '.' ) ) {
- $value = explode( '.', $value );
-
- if ( strlen( $value[1] ) > $precision && substr( $value[1], -1 ) === '5' ) {
- $value[1] = substr( $value[1], 0, -1 ) . '4';
- }
-
- $value = implode( '.', $value );
- }
-
- return NumberUtil::round( floatval( $value ), $precision );
-}
-
-/**
- * Make a refund total negative.
- *
- * @param float $amount Refunded amount.
- *
- * @return float
- */
-function wc_format_refund_total( $amount ) {
- return $amount * -1;
-}
-
-/**
- * Format decimal numbers ready for DB storage.
- *
- * Sanitize, remove decimals, and optionally round + trim off zeros.
- *
- * This function does not remove thousands - this should be done before passing a value to the function.
- *
- * @param float|string $number Expects either a float or a string with a decimal separator only (no thousands).
- * @param mixed $dp number Number of decimal points to use, blank to use woocommerce_price_num_decimals, or false to avoid all rounding.
- * @param bool $trim_zeros From end of string.
- * @return string
- */
-function wc_format_decimal( $number, $dp = false, $trim_zeros = false ) {
- $locale = localeconv();
- $decimals = array( wc_get_price_decimal_separator(), $locale['decimal_point'], $locale['mon_decimal_point'] );
-
- // Remove locale from string.
- if ( ! is_float( $number ) ) {
- $number = str_replace( $decimals, '.', $number );
-
- // Convert multiple dots to just one.
- $number = preg_replace( '/\.(?![^.]+$)|[^0-9.-]/', '', wc_clean( $number ) );
- }
-
- if ( false !== $dp ) {
- $dp = intval( '' === $dp ? wc_get_price_decimals() : $dp );
- $number = number_format( floatval( $number ), $dp, '.', '' );
- } elseif ( is_float( $number ) ) {
- // DP is false - don't use number format, just return a string using whatever is given. Remove scientific notation using sprintf.
- $number = str_replace( $decimals, '.', sprintf( '%.' . wc_get_rounding_precision() . 'f', $number ) );
- // We already had a float, so trailing zeros are not needed.
- $trim_zeros = true;
- }
-
- if ( $trim_zeros && strstr( $number, '.' ) ) {
- $number = rtrim( rtrim( $number, '0' ), '.' );
- }
-
- return $number;
-}
-
-/**
- * Convert a float to a string without locale formatting which PHP adds when changing floats to strings.
- *
- * @param float $float Float value to format.
- * @return string
- */
-function wc_float_to_string( $float ) {
- if ( ! is_float( $float ) ) {
- return $float;
- }
-
- $locale = localeconv();
- $string = strval( $float );
- $string = str_replace( $locale['decimal_point'], '.', $string );
-
- return $string;
-}
-
-/**
- * Format a price with WC Currency Locale settings.
- *
- * @param string $value Price to localize.
- * @return string
- */
-function wc_format_localized_price( $value ) {
- return apply_filters( 'woocommerce_format_localized_price', str_replace( '.', wc_get_price_decimal_separator(), strval( $value ) ), $value );
-}
-
-/**
- * Format a decimal with PHP Locale settings.
- *
- * @param string $value Decimal to localize.
- * @return string
- */
-function wc_format_localized_decimal( $value ) {
- $locale = localeconv();
- return apply_filters( 'woocommerce_format_localized_decimal', str_replace( '.', $locale['decimal_point'], strval( $value ) ), $value );
-}
-
-/**
- * Format a coupon code.
- *
- * @since 3.0.0
- * @param string $value Coupon code to format.
- * @return string
- */
-function wc_format_coupon_code( $value ) {
- return apply_filters( 'woocommerce_coupon_code', $value );
-}
-
-/**
- * Sanitize a coupon code.
- *
- * Uses sanitize_post_field since coupon codes are stored as
- * post_titles - the sanitization and escaping must match.
- *
- * @since 3.6.0
- * @param string $value Coupon code to format.
- * @return string
- */
-function wc_sanitize_coupon_code( $value ) {
- return wp_filter_kses( sanitize_post_field( 'post_title', $value, 0, 'db' ) );
-}
-
-/**
- * Clean variables using sanitize_text_field. Arrays are cleaned recursively.
- * Non-scalar values are ignored.
- *
- * @param string|array $var Data to sanitize.
- * @return string|array
- */
-function wc_clean( $var ) {
- if ( is_array( $var ) ) {
- return array_map( 'wc_clean', $var );
- } else {
- return is_scalar( $var ) ? sanitize_text_field( $var ) : $var;
- }
-}
-
-/**
- * Function wp_check_invalid_utf8 with recursive array support.
- *
- * @param string|array $var Data to sanitize.
- * @return string|array
- */
-function wc_check_invalid_utf8( $var ) {
- if ( is_array( $var ) ) {
- return array_map( 'wc_check_invalid_utf8', $var );
- } else {
- return wp_check_invalid_utf8( $var );
- }
-}
-
-/**
- * Run wc_clean over posted textarea but maintain line breaks.
- *
- * @since 3.0.0
- * @param string $var Data to sanitize.
- * @return string
- */
-function wc_sanitize_textarea( $var ) {
- return implode( "\n", array_map( 'wc_clean', explode( "\n", $var ) ) );
-}
-
-/**
- * Sanitize a string destined to be a tooltip.
- *
- * @since 2.3.10 Tooltips are encoded with htmlspecialchars to prevent XSS. Should not be used in conjunction with esc_attr()
- * @param string $var Data to sanitize.
- * @return string
- */
-function wc_sanitize_tooltip( $var ) {
- return htmlspecialchars(
- wp_kses(
- html_entity_decode( $var ),
- array(
- 'br' => array(),
- 'em' => array(),
- 'strong' => array(),
- 'small' => array(),
- 'span' => array(),
- 'ul' => array(),
- 'li' => array(),
- 'ol' => array(),
- 'p' => array(),
- )
- )
- );
-}
-
-/**
- * Merge two arrays.
- *
- * @param array $a1 First array to merge.
- * @param array $a2 Second array to merge.
- * @return array
- */
-function wc_array_overlay( $a1, $a2 ) {
- foreach ( $a1 as $k => $v ) {
- if ( ! array_key_exists( $k, $a2 ) ) {
- continue;
- }
- if ( is_array( $v ) && is_array( $a2[ $k ] ) ) {
- $a1[ $k ] = wc_array_overlay( $v, $a2[ $k ] );
- } else {
- $a1[ $k ] = $a2[ $k ];
- }
- }
- return $a1;
-}
-
-/**
- * Formats a stock amount by running it through a filter.
- *
- * @param int|float $amount Stock amount.
- * @return int|float
- */
-function wc_stock_amount( $amount ) {
- return apply_filters( 'woocommerce_stock_amount', $amount );
-}
-
-/**
- * Get the price format depending on the currency position.
- *
- * @return string
- */
-function get_woocommerce_price_format() {
- $currency_pos = get_option( 'woocommerce_currency_pos' );
- $format = '%1$s%2$s';
-
- switch ( $currency_pos ) {
- case 'left':
- $format = '%1$s%2$s';
- break;
- case 'right':
- $format = '%2$s%1$s';
- break;
- case 'left_space':
- $format = '%1$s %2$s';
- break;
- case 'right_space':
- $format = '%2$s %1$s';
- break;
- }
-
- return apply_filters( 'woocommerce_price_format', $format, $currency_pos );
-}
-
-/**
- * Return the thousand separator for prices.
- *
- * @since 2.3
- * @return string
- */
-function wc_get_price_thousand_separator() {
- return stripslashes( apply_filters( 'wc_get_price_thousand_separator', get_option( 'woocommerce_price_thousand_sep' ) ) );
-}
-
-/**
- * Return the decimal separator for prices.
- *
- * @since 2.3
- * @return string
- */
-function wc_get_price_decimal_separator() {
- $separator = apply_filters( 'wc_get_price_decimal_separator', get_option( 'woocommerce_price_decimal_sep' ) );
- return $separator ? stripslashes( $separator ) : '.';
-}
-
-/**
- * Return the number of decimals after the decimal point.
- *
- * @since 2.3
- * @return int
- */
-function wc_get_price_decimals() {
- return absint( apply_filters( 'wc_get_price_decimals', get_option( 'woocommerce_price_num_decimals', 2 ) ) );
-}
-
-/**
- * Format the price with a currency symbol.
- *
- * @param float $price Raw price.
- * @param array $args Arguments to format a price {
- * Array of arguments.
- * Defaults to empty array.
- *
- * @type bool $ex_tax_label Adds exclude tax label.
- * Defaults to false.
- * @type string $currency Currency code.
- * Defaults to empty string (Use the result from get_woocommerce_currency()).
- * @type string $decimal_separator Decimal separator.
- * Defaults the result of wc_get_price_decimal_separator().
- * @type string $thousand_separator Thousand separator.
- * Defaults the result of wc_get_price_thousand_separator().
- * @type string $decimals Number of decimals.
- * Defaults the result of wc_get_price_decimals().
- * @type string $price_format Price format depending on the currency position.
- * Defaults the result of get_woocommerce_price_format().
- * }
- * @return string
- */
-function wc_price( $price, $args = array() ) {
- $args = apply_filters(
- 'wc_price_args',
- wp_parse_args(
- $args,
- array(
- 'ex_tax_label' => false,
- 'currency' => '',
- 'decimal_separator' => wc_get_price_decimal_separator(),
- 'thousand_separator' => wc_get_price_thousand_separator(),
- 'decimals' => wc_get_price_decimals(),
- 'price_format' => get_woocommerce_price_format(),
- )
- )
- );
-
- $original_price = $price;
-
- // Convert to float to avoid issues on PHP 8.
- $price = (float) $price;
-
- $unformatted_price = $price;
- $negative = $price < 0;
-
- /**
- * Filter raw price.
- *
- * @param float $raw_price Raw price.
- * @param float|string $original_price Original price as float, or empty string. Since 5.0.0.
- */
- $price = apply_filters( 'raw_woocommerce_price', $negative ? $price * -1 : $price, $original_price );
-
- /**
- * Filter formatted price.
- *
- * @param float $formatted_price Formatted price.
- * @param float $price Unformatted price.
- * @param int $decimals Number of decimals.
- * @param string $decimal_separator Decimal separator.
- * @param string $thousand_separator Thousand separator.
- * @param float|string $original_price Original price as float, or empty string. Since 5.0.0.
- */
- $price = apply_filters( 'formatted_woocommerce_price', number_format( $price, $args['decimals'], $args['decimal_separator'], $args['thousand_separator'] ), $price, $args['decimals'], $args['decimal_separator'], $args['thousand_separator'], $original_price );
-
- if ( apply_filters( 'woocommerce_price_trim_zeros', false ) && $args['decimals'] > 0 ) {
- $price = wc_trim_zeros( $price );
- }
-
- $formatted_price = ( $negative ? '-' : '' ) . sprintf( $args['price_format'], '' . get_woocommerce_currency_symbol( $args['currency'] ) . '', $price );
- $return = '' . $formatted_price . '';
-
- if ( $args['ex_tax_label'] && wc_tax_enabled() ) {
- $return .= ' ' . WC()->countries->ex_tax_or_vat() . '';
- }
-
- /**
- * Filters the string of price markup.
- *
- * @param string $return Price HTML markup.
- * @param string $price Formatted price.
- * @param array $args Pass on the args.
- * @param float $unformatted_price Price as float to allow plugins custom formatting. Since 3.2.0.
- * @param float|string $original_price Original price as float, or empty string. Since 5.0.0.
- */
- return apply_filters( 'wc_price', $return, $price, $args, $unformatted_price, $original_price );
-}
-
-/**
- * Notation to numbers.
- *
- * This function transforms the php.ini notation for numbers (like '2M') to an integer.
- *
- * @param string $size Size value.
- * @return int
- */
-function wc_let_to_num( $size ) {
- $l = substr( $size, -1 );
- $ret = (int) substr( $size, 0, -1 );
- switch ( strtoupper( $l ) ) {
- case 'P':
- $ret *= 1024;
- // No break.
- case 'T':
- $ret *= 1024;
- // No break.
- case 'G':
- $ret *= 1024;
- // No break.
- case 'M':
- $ret *= 1024;
- // No break.
- case 'K':
- $ret *= 1024;
- // No break.
- }
- return $ret;
-}
-
-/**
- * WooCommerce Date Format - Allows to change date format for everything WooCommerce.
- *
- * @return string
- */
-function wc_date_format() {
- $date_format = get_option( 'date_format' );
- if ( empty( $date_format ) ) {
- // Return default date format if the option is empty.
- $date_format = 'F j, Y';
- }
- return apply_filters( 'woocommerce_date_format', $date_format );
-}
-
-/**
- * WooCommerce Time Format - Allows to change time format for everything WooCommerce.
- *
- * @return string
- */
-function wc_time_format() {
- $time_format = get_option( 'time_format' );
- if ( empty( $time_format ) ) {
- // Return default time format if the option is empty.
- $time_format = 'g:i a';
- }
- return apply_filters( 'woocommerce_time_format', $time_format );
-}
-
-/**
- * Convert mysql datetime to PHP timestamp, forcing UTC. Wrapper for strtotime.
- *
- * Based on wcs_strtotime_dark_knight() from WC Subscriptions by Prospress.
- *
- * @since 3.0.0
- * @param string $time_string Time string.
- * @param int|null $from_timestamp Timestamp to convert from.
- * @return int
- */
-function wc_string_to_timestamp( $time_string, $from_timestamp = null ) {
- $original_timezone = date_default_timezone_get();
-
- // @codingStandardsIgnoreStart
- date_default_timezone_set( 'UTC' );
-
- if ( null === $from_timestamp ) {
- $next_timestamp = strtotime( $time_string );
- } else {
- $next_timestamp = strtotime( $time_string, $from_timestamp );
- }
-
- date_default_timezone_set( $original_timezone );
- // @codingStandardsIgnoreEnd
-
- return $next_timestamp;
-}
-
-/**
- * Convert a date string to a WC_DateTime.
- *
- * @since 3.1.0
- * @param string $time_string Time string.
- * @return WC_DateTime
- */
-function wc_string_to_datetime( $time_string ) {
- // Strings are defined in local WP timezone. Convert to UTC.
- if ( 1 === preg_match( '/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(Z|((-|\+)\d{2}:\d{2}))$/', $time_string, $date_bits ) ) {
- $offset = ! empty( $date_bits[7] ) ? iso8601_timezone_to_offset( $date_bits[7] ) : wc_timezone_offset();
- $timestamp = gmmktime( $date_bits[4], $date_bits[5], $date_bits[6], $date_bits[2], $date_bits[3], $date_bits[1] ) - $offset;
- } else {
- $timestamp = wc_string_to_timestamp( get_gmt_from_date( gmdate( 'Y-m-d H:i:s', wc_string_to_timestamp( $time_string ) ) ) );
- }
- $datetime = new WC_DateTime( "@{$timestamp}", new DateTimeZone( 'UTC' ) );
-
- // Set local timezone or offset.
- if ( get_option( 'timezone_string' ) ) {
- $datetime->setTimezone( new DateTimeZone( wc_timezone_string() ) );
- } else {
- $datetime->set_utc_offset( wc_timezone_offset() );
- }
-
- return $datetime;
-}
-
-/**
- * WooCommerce Timezone - helper to retrieve the timezone string for a site until.
- * a WP core method exists (see https://core.trac.wordpress.org/ticket/24730).
- *
- * Adapted from https://secure.php.net/manual/en/function.timezone-name-from-abbr.php#89155.
- *
- * @since 2.1
- * @return string PHP timezone string for the site
- */
-function wc_timezone_string() {
- // Added in WordPress 5.3 Ref https://developer.wordpress.org/reference/functions/wp_timezone_string/.
- if ( function_exists( 'wp_timezone_string' ) ) {
- return wp_timezone_string();
- }
-
- // If site timezone string exists, return it.
- $timezone = get_option( 'timezone_string' );
- if ( $timezone ) {
- return $timezone;
- }
-
- // Get UTC offset, if it isn't set then return UTC.
- $utc_offset = floatval( get_option( 'gmt_offset', 0 ) );
- if ( ! is_numeric( $utc_offset ) || 0.0 === $utc_offset ) {
- return 'UTC';
- }
-
- // Adjust UTC offset from hours to seconds.
- $utc_offset = (int) ( $utc_offset * 3600 );
-
- // Attempt to guess the timezone string from the UTC offset.
- $timezone = timezone_name_from_abbr( '', $utc_offset );
- if ( $timezone ) {
- return $timezone;
- }
-
- // Last try, guess timezone string manually.
- foreach ( timezone_abbreviations_list() as $abbr ) {
- foreach ( $abbr as $city ) {
- // WordPress restrict the use of date(), since it's affected by timezone settings, but in this case is just what we need to guess the correct timezone.
- if ( (bool) date( 'I' ) === (bool) $city['dst'] && $city['timezone_id'] && intval( $city['offset'] ) === $utc_offset ) { // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
- return $city['timezone_id'];
- }
- }
- }
-
- // Fallback to UTC.
- return 'UTC';
-}
-
-/**
- * Get timezone offset in seconds.
- *
- * @since 3.0.0
- * @return float
- */
-function wc_timezone_offset() {
- $timezone = get_option( 'timezone_string' );
-
- if ( $timezone ) {
- $timezone_object = new DateTimeZone( $timezone );
- return $timezone_object->getOffset( new DateTime( 'now' ) );
- } else {
- return floatval( get_option( 'gmt_offset', 0 ) ) * HOUR_IN_SECONDS;
- }
-}
-
-/**
- * Callback which can flatten post meta (gets the first value if it's an array).
- *
- * @since 3.0.0
- * @param array $value Value to flatten.
- * @return mixed
- */
-function wc_flatten_meta_callback( $value ) {
- return is_array( $value ) ? current( $value ) : $value;
-}
-
-if ( ! function_exists( 'wc_rgb_from_hex' ) ) {
-
- /**
- * Convert RGB to HEX.
- *
- * @param mixed $color Color.
- *
- * @return array
- */
- function wc_rgb_from_hex( $color ) {
- $color = str_replace( '#', '', $color );
- // Convert shorthand colors to full format, e.g. "FFF" -> "FFFFFF".
- $color = preg_replace( '~^(.)(.)(.)$~', '$1$1$2$2$3$3', $color );
-
- $rgb = array();
- $rgb['R'] = hexdec( $color[0] . $color[1] );
- $rgb['G'] = hexdec( $color[2] . $color[3] );
- $rgb['B'] = hexdec( $color[4] . $color[5] );
-
- return $rgb;
- }
-}
-
-if ( ! function_exists( 'wc_hex_darker' ) ) {
-
- /**
- * Make HEX color darker.
- *
- * @param mixed $color Color.
- * @param int $factor Darker factor.
- * Defaults to 30.
- * @return string
- */
- function wc_hex_darker( $color, $factor = 30 ) {
- $base = wc_rgb_from_hex( $color );
- $color = '#';
-
- foreach ( $base as $k => $v ) {
- $amount = $v / 100;
- $amount = NumberUtil::round( $amount * $factor );
- $new_decimal = $v - $amount;
-
- $new_hex_component = dechex( $new_decimal );
- if ( strlen( $new_hex_component ) < 2 ) {
- $new_hex_component = '0' . $new_hex_component;
- }
- $color .= $new_hex_component;
- }
-
- return $color;
- }
-}
-
-if ( ! function_exists( 'wc_hex_lighter' ) ) {
-
- /**
- * Make HEX color lighter.
- *
- * @param mixed $color Color.
- * @param int $factor Lighter factor.
- * Defaults to 30.
- * @return string
- */
- function wc_hex_lighter( $color, $factor = 30 ) {
- $base = wc_rgb_from_hex( $color );
- $color = '#';
-
- foreach ( $base as $k => $v ) {
- $amount = 255 - $v;
- $amount = $amount / 100;
- $amount = NumberUtil::round( $amount * $factor );
- $new_decimal = $v + $amount;
-
- $new_hex_component = dechex( $new_decimal );
- if ( strlen( $new_hex_component ) < 2 ) {
- $new_hex_component = '0' . $new_hex_component;
- }
- $color .= $new_hex_component;
- }
-
- return $color;
- }
-}
-
-if ( ! function_exists( 'wc_hex_is_light' ) ) {
-
- /**
- * Determine whether a hex color is light.
- *
- * @param mixed $color Color.
- * @return bool True if a light color.
- */
- function wc_hex_is_light( $color ) {
- $hex = str_replace( '#', '', $color );
-
- $c_r = hexdec( substr( $hex, 0, 2 ) );
- $c_g = hexdec( substr( $hex, 2, 2 ) );
- $c_b = hexdec( substr( $hex, 4, 2 ) );
-
- $brightness = ( ( $c_r * 299 ) + ( $c_g * 587 ) + ( $c_b * 114 ) ) / 1000;
-
- return $brightness > 155;
- }
-}
-
-if ( ! function_exists( 'wc_light_or_dark' ) ) {
-
- /**
- * Detect if we should use a light or dark color on a background color.
- *
- * @param mixed $color Color.
- * @param string $dark Darkest reference.
- * Defaults to '#000000'.
- * @param string $light Lightest reference.
- * Defaults to '#FFFFFF'.
- * @return string
- */
- function wc_light_or_dark( $color, $dark = '#000000', $light = '#FFFFFF' ) {
- return wc_hex_is_light( $color ) ? $dark : $light;
- }
-}
-
-if ( ! function_exists( 'wc_format_hex' ) ) {
-
- /**
- * Format string as hex.
- *
- * @param string $hex HEX color.
- * @return string|null
- */
- function wc_format_hex( $hex ) {
- $hex = trim( str_replace( '#', '', $hex ) );
-
- if ( strlen( $hex ) === 3 ) {
- $hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
- }
-
- return $hex ? '#' . $hex : null;
- }
-}
-
-/**
- * Format the postcode according to the country and length of the postcode.
- *
- * @param string $postcode Unformatted postcode.
- * @param string $country Base country.
- * @return string
- */
-function wc_format_postcode( $postcode, $country ) {
- $postcode = wc_normalize_postcode( $postcode );
-
- switch ( $country ) {
- case 'CA':
- case 'GB':
- $postcode = substr_replace( $postcode, ' ', -3, 0 );
- break;
- case 'IE':
- $postcode = substr_replace( $postcode, ' ', 3, 0 );
- break;
- case 'BR':
- case 'PL':
- $postcode = substr_replace( $postcode, '-', -3, 0 );
- break;
- case 'JP':
- $postcode = substr_replace( $postcode, '-', 3, 0 );
- break;
- case 'PT':
- $postcode = substr_replace( $postcode, '-', 4, 0 );
- break;
- case 'PR':
- case 'US':
- $postcode = rtrim( substr_replace( $postcode, '-', 5, 0 ), '-' );
- break;
- case 'NL':
- $postcode = substr_replace( $postcode, ' ', 4, 0 );
- break;
- }
-
- return apply_filters( 'woocommerce_format_postcode', trim( $postcode ), $country );
-}
-
-/**
- * Normalize postcodes.
- *
- * Remove spaces and convert characters to uppercase.
- *
- * @since 2.6.0
- * @param string $postcode Postcode.
- * @return string
- */
-function wc_normalize_postcode( $postcode ) {
- return preg_replace( '/[\s\-]/', '', trim( wc_strtoupper( $postcode ) ) );
-}
-
-/**
- * Format phone numbers.
- *
- * @param string $phone Phone number.
- * @return string
- */
-function wc_format_phone_number( $phone ) {
- if ( ! WC_Validation::is_phone( $phone ) ) {
- return '';
- }
- return preg_replace( '/[^0-9\+\-\(\)\s]/', '-', preg_replace( '/[\x00-\x1F\x7F-\xFF]/', '', $phone ) );
-}
-
-/**
- * Sanitize phone number.
- * Allows only numbers and "+" (plus sign).
- *
- * @since 3.6.0
- * @param string $phone Phone number.
- * @return string
- */
-function wc_sanitize_phone_number( $phone ) {
- return preg_replace( '/[^\d+]/', '', $phone );
-}
-
-/**
- * Wrapper for mb_strtoupper which see's if supported first.
- *
- * @since 3.1.0
- * @param string $string String to format.
- * @return string
- */
-function wc_strtoupper( $string ) {
- return function_exists( 'mb_strtoupper' ) ? mb_strtoupper( $string ) : strtoupper( $string );
-}
-
-/**
- * Make a string lowercase.
- * Try to use mb_strtolower() when available.
- *
- * @since 2.3
- * @param string $string String to format.
- * @return string
- */
-function wc_strtolower( $string ) {
- return function_exists( 'mb_strtolower' ) ? mb_strtolower( $string ) : strtolower( $string );
-}
-
-/**
- * Trim a string and append a suffix.
- *
- * @param string $string String to trim.
- * @param integer $chars Amount of characters.
- * Defaults to 200.
- * @param string $suffix Suffix.
- * Defaults to '...'.
- * @return string
- */
-function wc_trim_string( $string, $chars = 200, $suffix = '...' ) {
- if ( strlen( $string ) > $chars ) {
- if ( function_exists( 'mb_substr' ) ) {
- $string = mb_substr( $string, 0, ( $chars - mb_strlen( $suffix ) ) ) . $suffix;
- } else {
- $string = substr( $string, 0, ( $chars - strlen( $suffix ) ) ) . $suffix;
- }
- }
- return $string;
-}
-
-/**
- * Format content to display shortcodes.
- *
- * @since 2.3.0
- * @param string $raw_string Raw string.
- * @return string
- */
-function wc_format_content( $raw_string ) {
- return apply_filters( 'woocommerce_format_content', apply_filters( 'woocommerce_short_description', $raw_string ), $raw_string );
-}
-
-/**
- * Format product short description.
- * Adds support for Jetpack Markdown.
- *
- * @codeCoverageIgnore
- * @since 2.4.0
- * @param string $content Product short description.
- * @return string
- */
-function wc_format_product_short_description( $content ) {
- // Add support for Jetpack Markdown.
- if ( class_exists( 'WPCom_Markdown' ) ) {
- $markdown = WPCom_Markdown::get_instance();
-
- return wpautop(
- $markdown->transform(
- $content,
- array(
- 'unslash' => false,
- )
- )
- );
- }
-
- return $content;
-}
-
-/**
- * Formats curency symbols when saved in settings.
- *
- * @codeCoverageIgnore
- * @param string $value Option value.
- * @param array $option Option name.
- * @param string $raw_value Raw value.
- * @return string
- */
-function wc_format_option_price_separators( $value, $option, $raw_value ) {
- return wp_kses_post( $raw_value );
-}
-add_filter( 'woocommerce_admin_settings_sanitize_option_woocommerce_price_decimal_sep', 'wc_format_option_price_separators', 10, 3 );
-add_filter( 'woocommerce_admin_settings_sanitize_option_woocommerce_price_thousand_sep', 'wc_format_option_price_separators', 10, 3 );
-
-/**
- * Formats decimals when saved in settings.
- *
- * @codeCoverageIgnore
- * @param string $value Option value.
- * @param array $option Option name.
- * @param string $raw_value Raw value.
- * @return string
- */
-function wc_format_option_price_num_decimals( $value, $option, $raw_value ) {
- return is_null( $raw_value ) ? 2 : absint( $raw_value );
-}
-add_filter( 'woocommerce_admin_settings_sanitize_option_woocommerce_price_num_decimals', 'wc_format_option_price_num_decimals', 10, 3 );
-
-/**
- * Formats hold stock option and sets cron event up.
- *
- * @codeCoverageIgnore
- * @param string $value Option value.
- * @param array $option Option name.
- * @param string $raw_value Raw value.
- * @return string
- */
-function wc_format_option_hold_stock_minutes( $value, $option, $raw_value ) {
- $value = ! empty( $raw_value ) ? absint( $raw_value ) : ''; // Allow > 0 or set to ''.
-
- wp_clear_scheduled_hook( 'woocommerce_cancel_unpaid_orders' );
-
- if ( '' !== $value ) {
- $cancel_unpaid_interval = apply_filters( 'woocommerce_cancel_unpaid_orders_interval_minutes', absint( $value ) );
- wp_schedule_single_event( time() + ( absint( $cancel_unpaid_interval ) * 60 ), 'woocommerce_cancel_unpaid_orders' );
- }
-
- return $value;
-}
-add_filter( 'woocommerce_admin_settings_sanitize_option_woocommerce_hold_stock_minutes', 'wc_format_option_hold_stock_minutes', 10, 3 );
-
-/**
- * Sanitize terms from an attribute text based.
- *
- * @since 2.4.5
- * @param string $term Term value.
- * @return string
- */
-function wc_sanitize_term_text_based( $term ) {
- return trim( wp_strip_all_tags( wp_unslash( $term ) ) );
-}
-
-if ( ! function_exists( 'wc_make_numeric_postcode' ) ) {
- /**
- * Make numeric postcode.
- *
- * Converts letters to numbers so we can do a simple range check on postcodes.
- * E.g. PE30 becomes 16050300 (P = 16, E = 05, 3 = 03, 0 = 00)
- *
- * @since 2.6.0
- * @param string $postcode Regular postcode.
- * @return string
- */
- function wc_make_numeric_postcode( $postcode ) {
- $postcode = str_replace( array( ' ', '-' ), '', $postcode );
- $postcode_length = strlen( $postcode );
- $letters_to_numbers = array_merge( array( 0 ), range( 'A', 'Z' ) );
- $letters_to_numbers = array_flip( $letters_to_numbers );
- $numeric_postcode = '';
-
- for ( $i = 0; $i < $postcode_length; $i ++ ) {
- if ( is_numeric( $postcode[ $i ] ) ) {
- $numeric_postcode .= str_pad( $postcode[ $i ], 2, '0', STR_PAD_LEFT );
- } elseif ( isset( $letters_to_numbers[ $postcode[ $i ] ] ) ) {
- $numeric_postcode .= str_pad( $letters_to_numbers[ $postcode[ $i ] ], 2, '0', STR_PAD_LEFT );
- } else {
- $numeric_postcode .= '00';
- }
- }
-
- return $numeric_postcode;
- }
-}
-
-/**
- * Format the stock amount ready for display based on settings.
- *
- * @since 3.0.0
- * @param WC_Product $product Product object for which the stock you need to format.
- * @return string
- */
-function wc_format_stock_for_display( $product ) {
- $display = __( 'In stock', 'woocommerce' );
- $stock_amount = $product->get_stock_quantity();
-
- switch ( get_option( 'woocommerce_stock_format' ) ) {
- case 'low_amount':
- if ( $stock_amount <= wc_get_low_stock_amount( $product ) ) {
- /* translators: %s: stock amount */
- $display = sprintf( __( 'Only %s left in stock', 'woocommerce' ), wc_format_stock_quantity_for_display( $stock_amount, $product ) );
- }
- break;
- case '':
- /* translators: %s: stock amount */
- $display = sprintf( __( '%s in stock', 'woocommerce' ), wc_format_stock_quantity_for_display( $stock_amount, $product ) );
- break;
- }
-
- if ( $product->backorders_allowed() && $product->backorders_require_notification() ) {
- $display .= ' ' . __( '(can be backordered)', 'woocommerce' );
- }
-
- return $display;
-}
-
-/**
- * Format the stock quantity ready for display.
- *
- * @since 3.0.0
- * @param int $stock_quantity Stock quantity.
- * @param WC_Product $product Product instance so that we can pass through the filters.
- * @return string
- */
-function wc_format_stock_quantity_for_display( $stock_quantity, $product ) {
- return apply_filters( 'woocommerce_format_stock_quantity', $stock_quantity, $product );
-}
-
-/**
- * Format a sale price for display.
- *
- * @since 3.0.0
- * @param string $regular_price Regular price.
- * @param string $sale_price Sale price.
- * @return string
- */
-function wc_format_sale_price( $regular_price, $sale_price ) {
- $price = '%3$s
'; - - switch ( $args['type'] ) { - case 'country': - $countries = 'shipping_country' === $key ? WC()->countries->get_shipping_countries() : WC()->countries->get_allowed_countries(); - - if ( 1 === count( $countries ) ) { - - $field .= '' . current( array_values( $countries ) ) . ''; - - $field .= ''; - - } else { - - $field = ''; - - $field .= ''; - - } - - break; - case 'state': - /* Get country this state field is representing */ - $for_country = isset( $args['country'] ) ? $args['country'] : WC()->checkout->get_value( 'billing_state' === $key ? 'billing_country' : 'shipping_country' ); - $states = WC()->countries->get_states( $for_country ); - - if ( is_array( $states ) && empty( $states ) ) { - - $field_container = ''; - - $field .= ''; - - } elseif ( ! is_null( $for_country ) && is_array( $states ) ) { - - $field .= ''; - - } else { - - $field .= ''; - - } - - break; - case 'textarea': - $field .= ''; - - break; - case 'checkbox': - $field = ''; - - break; - case 'text': - case 'password': - case 'datetime': - case 'datetime-local': - case 'date': - case 'month': - case 'time': - case 'week': - case 'number': - case 'email': - case 'url': - case 'tel': - $field .= ''; - - break; - case 'hidden': - $field .= ''; - - break; - case 'select': - $field = ''; - $options = ''; - - if ( ! empty( $args['options'] ) ) { - foreach ( $args['options'] as $option_key => $option_text ) { - if ( '' === $option_key ) { - // If we have a blank option, select2 needs a placeholder. - if ( empty( $args['placeholder'] ) ) { - $args['placeholder'] = $option_text ? $option_text : __( 'Choose an option', 'woocommerce' ); - } - $custom_attributes[] = 'data-allow_clear="true"'; - } - $options .= ''; - } - - $field .= ''; - } - - break; - case 'radio': - $label_id .= '_' . current( array_keys( $args['options'] ) ); - - if ( ! empty( $args['options'] ) ) { - foreach ( $args['options'] as $option_key => $option_text ) { - $field .= ''; - $field .= ''; - } - } - - break; - } - - if ( ! empty( $field ) ) { - $field_html = ''; - - if ( $args['label'] && 'checkbox' !== $args['type'] ) { - $field_html .= ''; - } - - $field_html .= '' . $field; - - if ( $args['description'] ) { - $field_html .= ''; - } - - $field_html .= ''; - - $container_class = esc_attr( implode( ' ', $args['class'] ) ); - $container_id = esc_attr( $args['id'] ) . '_field'; - $field = sprintf( $field_container, $container_class, $container_id, $field_html ); - } - - /** - * Filter by type. - */ - $field = apply_filters( 'woocommerce_form_field_' . $args['type'], $field, $key, $args, $value ); - - /** - * General filter on form fields. - * - * @since 3.4.0 - */ - $field = apply_filters( 'woocommerce_form_field', $field, $key, $args, $value ); - - if ( $args['return'] ) { - return $field; - } else { - // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped - echo $field; - } - } -} - -if ( ! function_exists( 'get_product_search_form' ) ) { - - /** - * Display product search form. - * - * Will first attempt to locate the product-searchform.php file in either the child or. - * the parent, then load it. If it doesn't exist, then the default search form. - * will be displayed. - * - * The default searchform uses html5. - * - * @param bool $echo (default: true). - * @return string - */ - function get_product_search_form( $echo = true ) { - global $product_search_form_index; - - ob_start(); - - if ( empty( $product_search_form_index ) ) { - $product_search_form_index = 0; - } - - do_action( 'pre_get_product_search_form' ); - - wc_get_template( - 'product-searchform.php', - array( - 'index' => $product_search_form_index++, - ) - ); - - $form = apply_filters( 'get_product_search_form', ob_get_clean() ); - - if ( ! $echo ) { - return $form; - } - - // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped - echo $form; - } -} - -if ( ! function_exists( 'woocommerce_output_auth_header' ) ) { - - /** - * Output the Auth header. - */ - function woocommerce_output_auth_header() { - wc_get_template( 'auth/header.php' ); - } -} - -if ( ! function_exists( 'woocommerce_output_auth_footer' ) ) { - - /** - * Output the Auth footer. - */ - function woocommerce_output_auth_footer() { - wc_get_template( 'auth/footer.php' ); - } -} - -if ( ! function_exists( 'woocommerce_single_variation' ) ) { - - /** - * Output placeholders for the single variation. - */ - function woocommerce_single_variation() { - echo ''; - } -} - -if ( ! function_exists( 'woocommerce_single_variation_add_to_cart_button' ) ) { - - /** - * Output the add to cart button for variations. - */ - function woocommerce_single_variation_add_to_cart_button() { - wc_get_template( 'single-product/add-to-cart/variation-add-to-cart-button.php' ); - } -} - -if ( ! function_exists( 'wc_dropdown_variation_attribute_options' ) ) { - - /** - * Output a list of variation attributes for use in the cart forms. - * - * @param array $args Arguments. - * @since 2.4.0 - */ - function wc_dropdown_variation_attribute_options( $args = array() ) { - $args = wp_parse_args( - apply_filters( 'woocommerce_dropdown_variation_attribute_options_args', $args ), - array( - 'options' => false, - 'attribute' => false, - 'product' => false, - 'selected' => false, - 'name' => '', - 'id' => '', - 'class' => '', - 'show_option_none' => __( 'Choose an option', 'woocommerce' ), - ) - ); - - // Get selected value. - if ( false === $args['selected'] && $args['attribute'] && $args['product'] instanceof WC_Product ) { - $selected_key = 'attribute_' . sanitize_title( $args['attribute'] ); - // phpcs:disable WordPress.Security.NonceVerification.Recommended - $args['selected'] = isset( $_REQUEST[ $selected_key ] ) ? wc_clean( wp_unslash( $_REQUEST[ $selected_key ] ) ) : $args['product']->get_variation_default_attribute( $args['attribute'] ); - // phpcs:enable WordPress.Security.NonceVerification.Recommended - } - - $options = $args['options']; - $product = $args['product']; - $attribute = $args['attribute']; - $name = $args['name'] ? $args['name'] : 'attribute_' . sanitize_title( $attribute ); - $id = $args['id'] ? $args['id'] : sanitize_title( $attribute ); - $class = $args['class']; - $show_option_none = (bool) $args['show_option_none']; - $show_option_none_text = $args['show_option_none'] ? $args['show_option_none'] : __( 'Choose an option', 'woocommerce' ); // We'll do our best to hide the placeholder, but we'll need to show something when resetting options. - - if ( empty( $options ) && ! empty( $product ) && ! empty( $attribute ) ) { - $attributes = $product->get_variation_attributes(); - $options = $attributes[ $attribute ]; - } - - $html = ''; - - // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped - echo apply_filters( 'woocommerce_dropdown_variation_attribute_options_html', $html, $args ); - } -} - -if ( ! function_exists( 'woocommerce_account_content' ) ) { - - /** - * My Account content output. - */ - function woocommerce_account_content() { - global $wp; - - if ( ! empty( $wp->query_vars ) ) { - foreach ( $wp->query_vars as $key => $value ) { - // Ignore pagename param. - if ( 'pagename' === $key ) { - continue; - } - - if ( has_action( 'woocommerce_account_' . $key . '_endpoint' ) ) { - do_action( 'woocommerce_account_' . $key . '_endpoint', $value ); - return; - } - } - } - - // No endpoint found? Default to dashboard. - wc_get_template( - 'myaccount/dashboard.php', - array( - 'current_user' => get_user_by( 'id', get_current_user_id() ), - ) - ); - } -} - -if ( ! function_exists( 'woocommerce_account_navigation' ) ) { - - /** - * My Account navigation template. - */ - function woocommerce_account_navigation() { - wc_get_template( 'myaccount/navigation.php' ); - } -} - -if ( ! function_exists( 'woocommerce_account_orders' ) ) { - - /** - * My Account > Orders template. - * - * @param int $current_page Current page number. - */ - function woocommerce_account_orders( $current_page ) { - $current_page = empty( $current_page ) ? 1 : absint( $current_page ); - $customer_orders = wc_get_orders( - apply_filters( - 'woocommerce_my_account_my_orders_query', - array( - 'customer' => get_current_user_id(), - 'page' => $current_page, - 'paginate' => true, - ) - ) - ); - - wc_get_template( - 'myaccount/orders.php', - array( - 'current_page' => absint( $current_page ), - 'customer_orders' => $customer_orders, - 'has_orders' => 0 < $customer_orders->total, - ) - ); - } -} - -if ( ! function_exists( 'woocommerce_account_view_order' ) ) { - - /** - * My Account > View order template. - * - * @param int $order_id Order ID. - */ - function woocommerce_account_view_order( $order_id ) { - WC_Shortcode_My_Account::view_order( absint( $order_id ) ); - } -} - -if ( ! function_exists( 'woocommerce_account_downloads' ) ) { - - /** - * My Account > Downloads template. - */ - function woocommerce_account_downloads() { - wc_get_template( 'myaccount/downloads.php' ); - } -} - -if ( ! function_exists( 'woocommerce_account_edit_address' ) ) { - - /** - * My Account > Edit address template. - * - * @param string $type Address type. - */ - function woocommerce_account_edit_address( $type ) { - $type = wc_edit_address_i18n( sanitize_title( $type ), true ); - - WC_Shortcode_My_Account::edit_address( $type ); - } -} - -if ( ! function_exists( 'woocommerce_account_payment_methods' ) ) { - - /** - * My Account > Downloads template. - */ - function woocommerce_account_payment_methods() { - wc_get_template( 'myaccount/payment-methods.php' ); - } -} - -if ( ! function_exists( 'woocommerce_account_add_payment_method' ) ) { - - /** - * My Account > Add payment method template. - */ - function woocommerce_account_add_payment_method() { - WC_Shortcode_My_Account::add_payment_method(); - } -} - -if ( ! function_exists( 'woocommerce_account_edit_account' ) ) { - - /** - * My Account > Edit account template. - */ - function woocommerce_account_edit_account() { - WC_Shortcode_My_Account::edit_account(); - } -} - -if ( ! function_exists( 'wc_no_products_found' ) ) { - - /** - * Handles the loop when no products were found/no product exist. - */ - function wc_no_products_found() { - wc_get_template( 'loop/no-products-found.php' ); - } -} - - -if ( ! function_exists( 'wc_get_email_order_items' ) ) { - /** - * Get HTML for the order items to be shown in emails. - * - * @param WC_Order $order Order object. - * @param array $args Arguments. - * - * @since 3.0.0 - * @return string - */ - function wc_get_email_order_items( $order, $args = array() ) { - ob_start(); - - $defaults = array( - 'show_sku' => false, - 'show_image' => false, - 'image_size' => array( 32, 32 ), - 'plain_text' => false, - 'sent_to_admin' => false, - ); - - $args = wp_parse_args( $args, $defaults ); - $template = $args['plain_text'] ? 'emails/plain/email-order-items.php' : 'emails/email-order-items.php'; - - wc_get_template( - $template, - apply_filters( - 'woocommerce_email_order_items_args', - array( - 'order' => $order, - 'items' => $order->get_items(), - 'show_download_links' => $order->is_download_permitted() && ! $args['sent_to_admin'], - 'show_sku' => $args['show_sku'], - 'show_purchase_note' => $order->is_paid() && ! $args['sent_to_admin'], - 'show_image' => $args['show_image'], - 'image_size' => $args['image_size'], - 'plain_text' => $args['plain_text'], - 'sent_to_admin' => $args['sent_to_admin'], - ) - ) - ); - - return apply_filters( 'woocommerce_email_order_items_table', ob_get_clean(), $order ); - } -} - -if ( ! function_exists( 'wc_display_item_meta' ) ) { - /** - * Display item meta data. - * - * @since 3.0.0 - * @param WC_Order_Item $item Order Item. - * @param array $args Arguments. - * @return string|void - */ - function wc_display_item_meta( $item, $args = array() ) { - $strings = array(); - $html = ''; - $args = wp_parse_args( - $args, - array( - 'before' => '', - 'separator' => '' . wp_kses_post( apply_filters( 'wc_empty_cart_message', __( 'Your cart is currently empty.', 'woocommerce' ) ) ) . '
'; -} - -/** - * Disable search engines indexing core, dynamic, cart/checkout pages. - * - * @todo Deprecated this function after dropping support for WP 5.6. - * @since 3.2.0 - */ -function wc_page_noindex() { - // wp_no_robots is deprecated since WP 5.7. - if ( function_exists( 'wp_robots_no_robots' ) ) { - return; - } - - if ( is_page( wc_get_page_id( 'cart' ) ) || is_page( wc_get_page_id( 'checkout' ) ) || is_page( wc_get_page_id( 'myaccount' ) ) ) { - wp_no_robots(); - } -} -add_action( 'wp_head', 'wc_page_noindex' ); - -/** - * Disable search engines indexing core, dynamic, cart/checkout pages. - * Uses "wp_robots" filter introduced in WP 5.7. - * - * @since 5.0.0 - * @param array $robots Associative array of robots directives. - * @return array Filtered robots directives. - */ -function wc_page_no_robots( $robots ) { - if ( is_page( wc_get_page_id( 'cart' ) ) || is_page( wc_get_page_id( 'checkout' ) ) || is_page( wc_get_page_id( 'myaccount' ) ) ) { - return wp_robots_no_robots( $robots ); - } - - return $robots; -} -add_filter( 'wp_robots', 'wc_page_no_robots' ); - -/** - * Get a slug identifying the current theme. - * - * @since 3.3.0 - * @return string - */ -function wc_get_theme_slug_for_templates() { - return apply_filters( 'woocommerce_theme_slug_for_templates', get_option( 'template' ) ); -} - -/** - * Gets and formats a list of cart item data + variations for display on the frontend. - * - * @since 3.3.0 - * @param array $cart_item Cart item object. - * @param bool $flat Should the data be returned flat or in a list. - * @return string - */ -function wc_get_formatted_cart_item_data( $cart_item, $flat = false ) { - $item_data = array(); - - // Variation values are shown only if they are not found in the title as of 3.0. - // This is because variation titles display the attributes. - if ( $cart_item['data']->is_type( 'variation' ) && is_array( $cart_item['variation'] ) ) { - foreach ( $cart_item['variation'] as $name => $value ) { - $taxonomy = wc_attribute_taxonomy_name( str_replace( 'attribute_pa_', '', urldecode( $name ) ) ); - - if ( taxonomy_exists( $taxonomy ) ) { - // If this is a term slug, get the term's nice name. - $term = get_term_by( 'slug', $value, $taxonomy ); - if ( ! is_wp_error( $term ) && $term && $term->name ) { - $value = $term->name; - } - $label = wc_attribute_label( $taxonomy ); - } else { - // If this is a custom option slug, get the options name. - $value = apply_filters( 'woocommerce_variation_option_name', $value, null, $taxonomy, $cart_item['data'] ); - $label = wc_attribute_label( str_replace( 'attribute_', '', $name ), $cart_item['data'] ); - } - - // Check the nicename against the title. - if ( '' === $value || wc_is_attribute_in_product_name( $value, $cart_item['data']->get_name() ) ) { - continue; - } - - $item_data[] = array( - 'key' => $label, - 'value' => $value, - ); - } - } - - // Filter item data to allow 3rd parties to add more to the array. - $item_data = apply_filters( 'woocommerce_get_item_data', $item_data, $cart_item ); - - // Format item data ready to display. - foreach ( $item_data as $key => $data ) { - // Set hidden to true to not display meta on cart. - if ( ! empty( $data['hidden'] ) ) { - unset( $item_data[ $key ] ); - continue; - } - $item_data[ $key ]['key'] = ! empty( $data['key'] ) ? $data['key'] : $data['name']; - $item_data[ $key ]['display'] = ! empty( $data['display'] ) ? $data['display'] : $data['value']; - } - - // Output flat or in list format. - if ( count( $item_data ) > 0 ) { - ob_start(); - - if ( $flat ) { - foreach ( $item_data as $data ) { - echo esc_html( $data['key'] ) . ': ' . wp_kses_post( $data['display'] ) . "\n"; - } - } else { - wc_get_template( 'cart/cart-item-data.php', array( 'item_data' => $item_data ) ); - } - - return ob_get_clean(); - } - - return ''; -} - -/** - * Gets the url to remove an item from the cart. - * - * @since 3.3.0 - * @param string $cart_item_key contains the id of the cart item. - * @return string url to page - */ -function wc_get_cart_remove_url( $cart_item_key ) { - $cart_page_url = wc_get_cart_url(); - return apply_filters( 'woocommerce_get_remove_url', $cart_page_url ? wp_nonce_url( add_query_arg( 'remove_item', $cart_item_key, $cart_page_url ), 'woocommerce-cart' ) : '' ); -} - -/** - * Gets the url to re-add an item into the cart. - * - * @since 3.3.0 - * @param string $cart_item_key Cart item key to undo. - * @return string url to page - */ -function wc_get_cart_undo_url( $cart_item_key ) { - $cart_page_url = wc_get_cart_url(); - - $query_args = array( - 'undo_item' => $cart_item_key, - ); - - return apply_filters( 'woocommerce_get_undo_url', $cart_page_url ? wp_nonce_url( add_query_arg( $query_args, $cart_page_url ), 'woocommerce-cart' ) : '', $cart_item_key ); -} - -/** - * Outputs all queued notices on WC pages. - * - * @since 3.5.0 - */ -function woocommerce_output_all_notices() { - echo '