woocommerce/includes/admin/settings/class-wc-settings-shipping.php

350 lines
12 KiB
PHP
Raw Normal View History

2013-07-26 14:36:28 +00:00
<?php
/**
2015-11-03 13:53:50 +00:00
* WooCommerce Shipping Settings
2013-07-26 14:36:28 +00:00
*
* @author WooThemes
* @category Admin
* @package WooCommerce/Admin
2016-01-05 11:23:15 +00:00
* @version 2.6.0
2013-07-26 14:36:28 +00:00
*/
if ( ! defined( 'ABSPATH' ) ) {
2016-01-05 11:23:15 +00:00
exit;
}
2013-07-26 14:36:28 +00:00
2017-02-16 11:46:01 +00:00
if ( ! class_exists( 'WC_Settings_Shipping', false ) ) :
2013-07-26 14:36:28 +00:00
/**
2015-11-03 13:31:20 +00:00
* WC_Settings_Shipping.
2013-07-26 14:36:28 +00:00
*/
class WC_Settings_Shipping extends WC_Settings_Page {
/**
* Constructor.
*/
public function __construct() {
$this->id = 'shipping';
$this->label = __( 'Shipping', 'woocommerce' );
add_filter( 'woocommerce_settings_tabs_array', array( $this, 'add_settings_page' ), 20 );
add_action( 'woocommerce_sections_' . $this->id, array( $this, 'output_sections' ) );
add_action( 'woocommerce_settings_' . $this->id, array( $this, 'output' ) );
add_action( 'woocommerce_settings_save_' . $this->id, array( $this, 'save' ) );
}
2016-01-05 11:23:15 +00:00
/**
* Add this page to settings.
*/
public function add_settings_page( $pages ) {
return wc_shipping_enabled() ? parent::add_settings_page( $pages ) : $pages;
}
2013-07-26 14:36:28 +00:00
/**
2015-11-03 13:31:20 +00:00
* Get sections.
2013-07-26 14:36:28 +00:00
*
* @return array
*/
public function get_sections() {
$sections = array(
'' => __( 'Shipping zones', 'woocommerce' ),
'options' => __( 'Shipping options', 'woocommerce' ),
'classes' => __( 'Shipping classes', 'woocommerce' ),
2013-07-26 14:36:28 +00:00
);
if ( ! defined( 'WC_INSTALLING' ) ) {
// Load shipping methods so we can show any global options they may have
$shipping_methods = WC()->shipping->load_shipping_methods();
2013-07-26 14:36:28 +00:00
foreach ( $shipping_methods as $method ) {
if ( ! $method->has_settings() ) {
continue;
}
$title = empty( $method->method_title ) ? ucfirst( $method->id ) : $method->method_title;
$sections[ strtolower( $method->id ) ] = esc_html( $title );
}
2013-07-26 14:36:28 +00:00
}
return apply_filters( 'woocommerce_get_sections_' . $this->id, $sections );
2013-07-26 14:36:28 +00:00
}
/**
2015-11-03 13:31:20 +00:00
* Get settings array.
2013-07-26 14:36:28 +00:00
*
* @return array
*/
public function get_settings() {
2016-01-05 11:23:15 +00:00
$settings = apply_filters( 'woocommerce_shipping_settings', array(
2013-07-26 14:36:28 +00:00
array( 'title' => __( 'Shipping options', 'woocommerce' ), 'type' => 'title', 'id' => 'shipping_options' ),
2013-07-26 14:36:28 +00:00
array(
2016-01-05 11:23:15 +00:00
'title' => __( 'Calculations', 'woocommerce' ),
'desc' => __( 'Enable the shipping calculator on the cart page', 'woocommerce' ),
'id' => 'woocommerce_enable_shipping_calc',
'default' => 'yes',
'type' => 'checkbox',
2016-01-05 11:23:15 +00:00
'checkboxgroup' => 'start',
'autoload' => false,
2013-07-26 14:36:28 +00:00
),
array(
'desc' => __( 'Hide shipping costs until an address is entered', 'woocommerce' ),
'id' => 'woocommerce_shipping_cost_requires_address',
'default' => 'no',
'type' => 'checkbox',
'checkboxgroup' => 'end',
'autoload' => false,
2013-07-26 14:36:28 +00:00
),
array(
'title' => __( 'Shipping destination', 'woocommerce' ),
'desc' => __( 'This controls which shipping address is used by default.', 'woocommerce' ),
2014-04-08 15:29:29 +00:00
'id' => 'woocommerce_ship_to_destination',
2015-01-06 17:39:09 +00:00
'default' => 'billing',
'type' => 'radio',
'options' => array(
2016-01-05 11:23:15 +00:00
'shipping' => __( 'Default to customer shipping address', 'woocommerce' ),
'billing' => __( 'Default to customer billing address', 'woocommerce' ),
'billing_only' => __( 'Force shipping to the customer billing address', 'woocommerce' ),
),
'autoload' => false,
'desc_tip' => true,
'show_if_checked' => 'option',
2013-07-26 14:36:28 +00:00
),
array(
'title' => __( 'Debug mode', 'woocommerce' ),
'desc' => __( 'Enable debug mode', 'woocommerce' ),
'desc_tip' => __( 'Enable shipping debug mode to show matching shipping zones and to bypass shipping rate cache.', 'woocommerce' ),
'id' => 'woocommerce_shipping_debug_mode',
'default' => 'no',
'type' => 'checkbox',
'autoload' => false,
),
2013-07-26 14:36:28 +00:00
array( 'type' => 'sectionend', 'id' => 'shipping_options' ),
) );
return apply_filters( 'woocommerce_get_settings_' . $this->id, $settings );
2013-07-26 14:36:28 +00:00
}
/**
2015-11-03 13:31:20 +00:00
* Output the settings.
2013-07-26 14:36:28 +00:00
*/
public function output() {
2016-01-05 11:23:15 +00:00
global $current_section, $hide_save_button;
2013-07-26 14:36:28 +00:00
// Load shipping methods so we can show any global options they may have
$shipping_methods = WC()->shipping->load_shipping_methods();
if ( '' === $current_section ) {
$this->output_zones_screen();
} elseif ( 'options' === $current_section ) {
$settings = $this->get_settings();
WC_Admin_Settings::output_fields( $settings );
} elseif ( 'classes' === $current_section ) {
$hide_save_button = true;
$this->output_shipping_class_screen();
} else {
foreach ( $shipping_methods as $method ) {
2016-02-26 15:26:39 +00:00
if ( in_array( $current_section, array( $method->id, sanitize_title( get_class( $method ) ) ) ) && $method->has_settings() ) {
$method->admin_options();
2013-07-26 14:36:28 +00:00
}
}
2013-07-26 14:36:28 +00:00
}
}
/**
2015-11-03 13:31:20 +00:00
* Save settings.
2013-07-26 14:36:28 +00:00
*/
public function save() {
global $current_section;
2013-07-26 14:36:28 +00:00
2016-01-05 11:23:15 +00:00
switch ( $current_section ) {
case 'options' :
WC_Admin_Settings::save_fields( $this->get_settings() );
break;
case 'classes' :
2016-01-05 11:23:15 +00:00
case '' :
break;
default :
$wc_shipping = WC_Shipping::instance();
foreach ( $wc_shipping->get_shipping_methods() as $method_id => $method ) {
2016-02-26 15:26:39 +00:00
if ( in_array( $current_section, array( $method->id, sanitize_title( get_class( $method ) ) ) ) ) {
2016-01-05 11:23:15 +00:00
do_action( 'woocommerce_update_options_' . $this->id . '_' . $method->id );
}
}
break;
}
2013-07-26 14:36:28 +00:00
2016-01-05 11:23:15 +00:00
// Increments the transient version to invalidate cache
WC_Cache_Helper::get_transient_version( 'shipping', true );
}
2013-07-26 14:36:28 +00:00
2016-01-05 11:23:15 +00:00
/**
* Handles output of the shipping zones page in admin.
2016-01-05 11:23:15 +00:00
*/
protected function output_zones_screen() {
global $hide_save_button;
2016-01-05 11:23:15 +00:00
if ( isset( $_REQUEST['zone_id'] ) ) {
$hide_save_button = true;
2016-09-24 02:22:57 +00:00
$this->zone_methods_screen( wc_clean( $_REQUEST['zone_id'] ) );
2016-01-05 11:23:15 +00:00
} elseif ( isset( $_REQUEST['instance_id'] ) ) {
$this->instance_settings_screen( absint( $_REQUEST['instance_id'] ) );
} else {
$hide_save_button = true;
2016-01-05 11:23:15 +00:00
$this->zones_screen();
}
}
/**
* Show method for a zone
* @param int $zone_id
*/
protected function zone_methods_screen( $zone_id ) {
2016-09-24 02:22:57 +00:00
if ( 'new' === $zone_id ) {
$zone = new WC_Shipping_Zone();
} else {
2016-10-10 17:41:07 +00:00
$zone = WC_Shipping_Zones::get_zone( absint( $zone_id ) );
2016-09-24 02:22:57 +00:00
}
2016-01-05 11:23:15 +00:00
if ( ! $zone ) {
wp_die( __( 'Zone does not exist!', 'woocommerce' ) );
}
2016-09-24 02:22:57 +00:00
$allowed_countries = WC()->countries->get_allowed_countries();
$wc_shipping = WC_Shipping ::instance();
$shipping_methods = $wc_shipping->get_shipping_methods();
$continents = WC()->countries->get_continents();
// Prepare locations
$locations = array();
$postcodes = array();
foreach ( $zone->get_zone_locations() as $location ) {
if ( 'postcode' === $location->type ) {
$postcodes[] = $location->code;
} else {
$locations[] = $location->type . ':' . $location->code;
}
}
2016-01-05 11:23:15 +00:00
wp_localize_script( 'wc-shipping-zone-methods', 'shippingZoneMethodsLocalizeScript', array(
2016-02-10 13:21:16 +00:00
'methods' => $zone->get_shipping_methods(),
2016-09-24 02:22:57 +00:00
'zone_name' => $zone->get_zone_name(),
'zone_id' => $zone->get_id(),
2016-01-05 11:23:15 +00:00
'wc_shipping_zones_nonce' => wp_create_nonce( 'wc_shipping_zones_nonce' ),
'strings' => array(
'unload_confirmation_msg' => __( 'Your changed data will be lost if you leave this page without saving.', 'woocommerce' ),
'save_changes_prompt' => __( 'Do you wish to save your changes first? Your changed data will be discarded if you choose to cancel.', 'woocommerce' ),
'save_failed' => __( 'Your changes were not saved. Please retry.', 'woocommerce' ),
'add_method_failed' => __( 'Shipping method could not be added. Please retry.', 'woocommerce' ),
'yes' => __( 'Yes', 'woocommerce' ),
'no' => __( 'No', 'woocommerce' ),
'default_zone_name' => __( 'Zone', 'woocommerce' ),
2016-01-05 11:23:15 +00:00
),
) );
wp_enqueue_script( 'wc-shipping-zone-methods' );
include_once( dirname( __FILE__ ) . '/views/html-admin-page-shipping-zone-methods.php' );
2016-01-05 11:23:15 +00:00
}
/**
* Show zones
*/
protected function zones_screen() {
global $wpdb;
2016-01-05 11:23:15 +00:00
$allowed_countries = WC()->countries->get_allowed_countries();
$continents = WC()->countries->get_continents();
$method_count = wc_get_shipping_method_count();
2016-01-05 11:23:15 +00:00
wp_localize_script( 'wc-shipping-zones', 'shippingZonesLocalizeScript', array(
'zones' => WC_Shipping_Zones::get_zones(),
'default_zone' => array(
2016-01-05 11:23:15 +00:00
'zone_id' => 0,
'zone_name' => '',
'zone_order' => null,
),
'wc_shipping_zones_nonce' => wp_create_nonce( 'wc_shipping_zones_nonce' ),
'strings' => array(
2016-06-20 11:50:52 +00:00
'unload_confirmation_msg' => __( 'Your changed data will be lost if you leave this page without saving.', 'woocommerce' ),
2016-10-10 16:50:29 +00:00
'delete_confirmation_msg' => __( 'Are you sure you want to delete this zone? This action cannot be undone.', 'woocommerce' ),
2016-06-20 11:50:52 +00:00
'save_failed' => __( 'Your changes were not saved. Please retry.', 'woocommerce' ),
'no_shipping_methods_offered' => __( 'No shipping methods offered to this zone.', 'woocommerce' ),
2016-01-05 11:23:15 +00:00
),
) );
wp_enqueue_script( 'wc-shipping-zones' );
include_once( dirname( __FILE__ ) . '/views/html-admin-page-shipping-zones.php' );
2016-01-05 11:23:15 +00:00
}
/**
* Show instance settings
* @param int $instance_id
*/
protected function instance_settings_screen( $instance_id ) {
2016-01-05 11:23:15 +00:00
$zone = WC_Shipping_Zones::get_zone_by( 'instance_id', $instance_id );
$shipping_method = WC_Shipping_Zones::get_shipping_method( $instance_id );
if ( ! $shipping_method ) {
wp_die( __( 'Invalid shipping method!', 'woocommerce' ) );
}
if ( ! $zone ) {
wp_die( __( 'Zone does not exist!', 'woocommerce' ) );
}
if ( ! $shipping_method->has_settings() ) {
wp_die( __( 'This shipping method does not have any settings to configure.', 'woocommerce' ) );
}
if ( ! empty( $_POST['save'] ) ) {
2016-01-05 11:23:15 +00:00
if ( empty( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( $_REQUEST['_wpnonce'], 'woocommerce-settings' ) ) {
2016-01-05 11:23:15 +00:00
echo '<div class="updated error"><p>' . __( 'Edit failed. Please try again.', 'woocommerce' ) . '</p></div>';
}
2016-01-05 11:23:15 +00:00
$shipping_method->process_admin_options();
$shipping_method->display_errors();
2013-07-26 14:36:28 +00:00
}
include_once( dirname( __FILE__ ) . '/views/html-admin-page-shipping-zones-instance.php' );
2013-07-26 14:36:28 +00:00
}
/**
* Handles output of the shipping class settings screen.
*/
protected function output_shipping_class_screen() {
$wc_shipping = WC_Shipping::instance();
wp_localize_script( 'wc-shipping-classes', 'shippingClassesLocalizeScript', array(
'classes' => $wc_shipping->get_shipping_classes(),
'default_shipping_class' => array(
'term_id' => 0,
'name' => '',
'description' => '',
),
'wc_shipping_classes_nonce' => wp_create_nonce( 'wc_shipping_classes_nonce' ),
'strings' => array(
'unload_confirmation_msg' => __( 'Your changed data will be lost if you leave this page without saving.', 'woocommerce' ),
'save_failed' => __( 'Your changes were not saved. Please retry.', 'woocommerce' ),
),
) );
wp_enqueue_script( 'wc-shipping-classes' );
// Extendable columns to show on the shipping classes screen.
$shipping_class_columns = apply_filters( 'woocommerce_shipping_classes_columns', array(
'wc-shipping-class-name' => __( 'Shipping class', 'woocommerce' ),
'wc-shipping-class-slug' => __( 'Slug', 'woocommerce' ),
'wc-shipping-class-description' => __( 'Description', 'woocommerce' ),
'wc-shipping-class-count' => __( 'Product count', 'woocommerce' ),
) );
include_once( dirname( __FILE__ ) . '/views/html-admin-page-shipping-classes.php' );
}
2013-07-26 14:36:28 +00:00
}
endif;
return new WC_Settings_Shipping();