| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096 |
- <?php
- /**
- * Checkout functionality
- *
- * The WooCommerce checkout class handles the checkout process, collecting user data and processing the payment.
- *
- * @package WooCommerce/Classes
- * @version 3.4.0
- */
- defined( 'ABSPATH' ) || exit;
- /**
- * Checkout class.
- */
- class WC_Checkout {
- /**
- * The single instance of the class.
- *
- * @var WC_Checkout|null
- */
- protected static $instance = null;
- /**
- * Checkout fields are stored here.
- *
- * @var array|null
- */
- protected $fields = null;
- /**
- * Holds posted data for backwards compatibility.
- *
- * @var array
- */
- protected $legacy_posted_data = array();
- /**
- * Gets the main WC_Checkout Instance.
- *
- * @since 2.1
- * @static
- * @return WC_Checkout Main instance
- */
- public static function instance() {
- if ( is_null( self::$instance ) ) {
- self::$instance = new self();
- // Hook in actions once.
- add_action( 'woocommerce_checkout_billing', array( self::$instance, 'checkout_form_billing' ) );
- add_action( 'woocommerce_checkout_shipping', array( self::$instance, 'checkout_form_shipping' ) );
- // woocommerce_checkout_init action is ran once when the class is first constructed.
- do_action( 'woocommerce_checkout_init', self::$instance );
- }
- return self::$instance;
- }
- /**
- * See if variable is set. Used to support legacy public variables which are no longer defined.
- *
- * @param string $key Key.
- * @return bool
- */
- public function __isset( $key ) {
- return in_array(
- $key,
- array(
- 'enable_signup',
- 'enable_guest_checkout',
- 'must_create_account',
- 'checkout_fields',
- 'posted',
- 'shipping_method',
- 'payment_method',
- 'customer_id',
- 'shipping_methods',
- ),
- true
- );
- }
- /**
- * Sets the legacy public variables for backwards compatibility.
- *
- * @param string $key Key.
- * @param mixed $value Value.
- */
- public function __set( $key, $value ) {
- switch ( $key ) {
- case 'enable_signup':
- $bool_value = wc_string_to_bool( $value );
- if ( $bool_value !== $this->is_registration_enabled() ) {
- remove_filter( 'woocommerce_checkout_registration_enabled', '__return_true', 0 );
- remove_filter( 'woocommerce_checkout_registration_enabled', '__return_false', 0 );
- add_filter( 'woocommerce_checkout_registration_enabled', $bool_value ? '__return_true' : '__return_false', 0 );
- }
- break;
- case 'enable_guest_checkout':
- $bool_value = wc_string_to_bool( $value );
- if ( $bool_value === $this->is_registration_required() ) {
- remove_filter( 'woocommerce_checkout_registration_required', '__return_true', 0 );
- remove_filter( 'woocommerce_checkout_registration_required', '__return_false', 0 );
- add_filter( 'woocommerce_checkout_registration_required', $bool_value ? '__return_false' : '__return_true', 0 );
- }
- break;
- case 'checkout_fields':
- $this->fields = $value;
- break;
- case 'shipping_methods':
- WC()->session->set( 'chosen_shipping_methods', $value );
- break;
- case 'posted':
- $this->legacy_posted_data = $value;
- break;
- }
- }
- /**
- * Gets the legacy public variables for backwards compatibility.
- *
- * @param string $key Key.
- * @return array|string
- */
- public function __get( $key ) {
- if ( in_array( $key, array( 'posted', 'shipping_method', 'payment_method' ), true ) && empty( $this->legacy_posted_data ) ) {
- $this->legacy_posted_data = $this->get_posted_data();
- }
- switch ( $key ) {
- case 'enable_signup':
- return $this->is_registration_enabled();
- case 'enable_guest_checkout':
- return ! $this->is_registration_required();
- case 'must_create_account':
- return $this->is_registration_required() && ! is_user_logged_in();
- case 'checkout_fields':
- return $this->get_checkout_fields();
- case 'posted':
- wc_doing_it_wrong( 'WC_Checkout->posted', 'Use $_POST directly.', '3.0.0' );
- return $this->legacy_posted_data;
- case 'shipping_method':
- return $this->legacy_posted_data['shipping_method'];
- case 'payment_method':
- return $this->legacy_posted_data['payment_method'];
- case 'customer_id':
- return apply_filters( 'woocommerce_checkout_customer_id', get_current_user_id() );
- case 'shipping_methods':
- return (array) WC()->session->get( 'chosen_shipping_methods' );
- }
- }
- /**
- * Cloning is forbidden.
- */
- public function __clone() {
- wc_doing_it_wrong( __FUNCTION__, __( 'Cloning is forbidden.', 'woocommerce' ), '2.1' );
- }
- /**
- * Unserializing instances of this class is forbidden.
- */
- public function __wakeup() {
- wc_doing_it_wrong( __FUNCTION__, __( 'Unserializing instances of this class is forbidden.', 'woocommerce' ), '2.1' );
- }
- /**
- * Is registration required to checkout?
- *
- * @since 3.0.0
- * @return boolean
- */
- public function is_registration_required() {
- return apply_filters( 'woocommerce_checkout_registration_required', 'yes' !== get_option( 'woocommerce_enable_guest_checkout' ) );
- }
- /**
- * Is registration enabled on the checkout page?
- *
- * @since 3.0.0
- * @return boolean
- */
- public function is_registration_enabled() {
- return apply_filters( 'woocommerce_checkout_registration_enabled', 'yes' === get_option( 'woocommerce_enable_signup_and_login_from_checkout' ) );
- }
- /**
- * Get an array of checkout fields.
- *
- * @param string $fieldset to get.
- * @return array
- */
- public function get_checkout_fields( $fieldset = '' ) {
- if ( ! is_null( $this->fields ) ) {
- return $fieldset ? $this->fields[ $fieldset ] : $this->fields;
- }
- $this->fields = array(
- 'billing' => WC()->countries->get_address_fields(
- $this->get_value( 'billing_country' ),
- 'billing_'
- ),
- 'shipping' => WC()->countries->get_address_fields(
- $this->get_value( 'shipping_country' ),
- 'shipping_'
- ),
- 'account' => array(),
- 'order' => array(
- 'order_comments' => array(
- 'type' => 'textarea',
- 'class' => array( 'notes' ),
- 'label' => __( 'Order notes', 'woocommerce' ),
- 'placeholder' => esc_attr__(
- 'Notes about your order, e.g. special notes for delivery.',
- 'woocommerce'
- ),
- ),
- ),
- );
- if ( 'no' === get_option( 'woocommerce_registration_generate_username' ) ) {
- $this->fields['account']['account_username'] = array(
- 'type' => 'text',
- 'label' => __( 'Account username', 'woocommerce' ),
- 'required' => true,
- 'placeholder' => esc_attr__( 'Username', 'woocommerce' ),
- );
- }
- if ( 'no' === get_option( 'woocommerce_registration_generate_password' ) ) {
- $this->fields['account']['account_password'] = array(
- 'type' => 'password',
- 'label' => __( 'Create account password', 'woocommerce' ),
- 'required' => true,
- 'placeholder' => esc_attr__( 'Password', 'woocommerce' ),
- );
- }
- $this->fields = apply_filters( 'woocommerce_checkout_fields', $this->fields );
- return $fieldset ? $this->fields[ $fieldset ] : $this->fields;
- }
- /**
- * When we process the checkout, lets ensure cart items are rechecked to prevent checkout.
- */
- public function check_cart_items() {
- do_action( 'woocommerce_check_cart_items' );
- }
- /**
- * Output the billing form.
- */
- public function checkout_form_billing() {
- wc_get_template( 'checkout/form-billing.php', array( 'checkout' => $this ) );
- }
- /**
- * Output the shipping form.
- */
- public function checkout_form_shipping() {
- wc_get_template( 'checkout/form-shipping.php', array( 'checkout' => $this ) );
- }
- /**
- * Create an order. Error codes:
- * 520 - Cannot insert order into the database.
- * 521 - Cannot get order after creation.
- * 522 - Cannot update order.
- * 525 - Cannot create line item.
- * 526 - Cannot create fee item.
- * 527 - Cannot create shipping item.
- * 528 - Cannot create tax item.
- * 529 - Cannot create coupon item.
- *
- * @throws Exception When checkout validation fails.
- * @param array $data Posted data.
- * @return int|WP_ERROR
- */
- public function create_order( $data ) {
- // Give plugins the opportunity to create an order themselves.
- $order_id = apply_filters( 'woocommerce_create_order', null, $this );
- if ( $order_id ) {
- return $order_id;
- }
- try {
- $order_id = absint( WC()->session->get( 'order_awaiting_payment' ) );
- $cart_hash = md5( wp_json_encode( wc_clean( WC()->cart->get_cart_for_session() ) ) . WC()->cart->total );
- $available_gateways = WC()->payment_gateways->get_available_payment_gateways();
- $order = $order_id ? wc_get_order( $order_id ) : null;
- /**
- * If there is an order pending payment, we can resume it here so
- * long as it has not changed. If the order has changed, i.e.
- * different items or cost, create a new order. We use a hash to
- * detect changes which is based on cart items + order total.
- */
- if ( $order && $order->has_cart_hash( $cart_hash ) && $order->has_status( array( 'pending', 'failed' ) ) ) {
- // Action for 3rd parties.
- do_action( 'woocommerce_resume_order', $order_id );
- // Remove all items - we will re-add them later.
- $order->remove_order_items();
- } else {
- $order = new WC_Order();
- }
- foreach ( $data as $key => $value ) {
- if ( is_callable( array( $order, "set_{$key}" ) ) ) {
- $order->{"set_{$key}"}( $value );
- // Store custom fields prefixed with wither shipping_ or billing_. This is for backwards compatibility with 2.6.x.
- // TODO: Fix conditional to only include shipping/billing address fields in a smarter way without str(i)pos.
- } elseif ( ( 0 === stripos( $key, 'billing_' ) || 0 === stripos( $key, 'shipping_' ) )
- && ! in_array( $key, array( 'shipping_method', 'shipping_total', 'shipping_tax' ), true ) ) {
- $order->update_meta_data( '_' . $key, $value );
- }
- }
- $order->set_created_via( 'checkout' );
- $order->set_cart_hash( $cart_hash );
- $order->set_customer_id( apply_filters( 'woocommerce_checkout_customer_id', get_current_user_id() ) );
- $order->set_currency( get_woocommerce_currency() );
- $order->set_prices_include_tax( 'yes' === get_option( 'woocommerce_prices_include_tax' ) );
- $order->set_customer_ip_address( WC_Geolocation::get_ip_address() );
- $order->set_customer_user_agent( wc_get_user_agent() );
- $order->set_customer_note( isset( $data['order_comments'] ) ? $data['order_comments'] : '' );
- $order->set_payment_method( isset( $available_gateways[ $data['payment_method'] ] ) ? $available_gateways[ $data['payment_method'] ] : $data['payment_method'] );
- $order->set_shipping_total( WC()->cart->get_shipping_total() );
- $order->set_discount_total( WC()->cart->get_discount_total() );
- $order->set_discount_tax( WC()->cart->get_discount_tax() );
- $order->set_cart_tax( WC()->cart->get_cart_contents_tax() + WC()->cart->get_fee_tax() );
- $order->set_shipping_tax( WC()->cart->get_shipping_tax() );
- $order->set_total( WC()->cart->get_total( 'edit' ) );
- $this->create_order_line_items( $order, WC()->cart );
- $this->create_order_fee_lines( $order, WC()->cart );
- $this->create_order_shipping_lines( $order, WC()->session->get( 'chosen_shipping_methods' ), WC()->shipping->get_packages() );
- $this->create_order_tax_lines( $order, WC()->cart );
- $this->create_order_coupon_lines( $order, WC()->cart );
- /**
- * Action hook to adjust order before save.
- *
- * @since 3.0.0
- */
- do_action( 'woocommerce_checkout_create_order', $order, $data );
- // Save the order.
- $order_id = $order->save();
- do_action( 'woocommerce_checkout_update_order_meta', $order_id, $data );
- return $order_id;
- } catch ( Exception $e ) {
- return new WP_Error( 'checkout-error', $e->getMessage() );
- }
- }
- /**
- * Add line items to the order.
- *
- * @param WC_Order $order Order instance.
- * @param WC_Cart $cart Cart instance.
- */
- public function create_order_line_items( &$order, $cart ) {
- foreach ( $cart->get_cart() as $cart_item_key => $values ) {
- /**
- * Filter hook to get initial item object.
- *
- * @since 3.1.0
- */
- $item = apply_filters( 'woocommerce_checkout_create_order_line_item_object', new WC_Order_Item_Product(), $cart_item_key, $values, $order );
- $product = $values['data'];
- $item->legacy_values = $values; // @deprecated For legacy actions.
- $item->legacy_cart_item_key = $cart_item_key; // @deprecated For legacy actions.
- $item->set_props(
- array(
- 'quantity' => $values['quantity'],
- 'variation' => $values['variation'],
- 'subtotal' => $values['line_subtotal'],
- 'total' => $values['line_total'],
- 'subtotal_tax' => $values['line_subtotal_tax'],
- 'total_tax' => $values['line_tax'],
- 'taxes' => $values['line_tax_data'],
- )
- );
- if ( $product ) {
- $item->set_props(
- array(
- 'name' => $product->get_name(),
- 'tax_class' => $product->get_tax_class(),
- 'product_id' => $product->is_type( 'variation' ) ? $product->get_parent_id() : $product->get_id(),
- 'variation_id' => $product->is_type( 'variation' ) ? $product->get_id() : 0,
- )
- );
- }
- $item->set_backorder_meta();
- /**
- * Action hook to adjust item before save.
- *
- * @since 3.0.0
- */
- do_action( 'woocommerce_checkout_create_order_line_item', $item, $cart_item_key, $values, $order );
- // Add item to order and save.
- $order->add_item( $item );
- }
- }
- /**
- * Add fees to the order.
- *
- * @param WC_Order $order Order instance.
- * @param WC_Cart $cart Cart instance.
- */
- public function create_order_fee_lines( &$order, $cart ) {
- foreach ( $cart->get_fees() as $fee_key => $fee ) {
- $item = new WC_Order_Item_Fee();
- $item->legacy_fee = $fee; // @deprecated For legacy actions.
- $item->legacy_fee_key = $fee_key; // @deprecated For legacy actions.
- $item->set_props(
- array(
- 'name' => $fee->name,
- 'tax_class' => $fee->taxable ? $fee->tax_class : 0,
- 'amount' => $fee->amount,
- 'total' => $fee->total,
- 'total_tax' => $fee->tax,
- 'taxes' => array(
- 'total' => $fee->tax_data,
- ),
- )
- );
- /**
- * Action hook to adjust item before save.
- *
- * @since 3.0.0
- */
- do_action( 'woocommerce_checkout_create_order_fee_item', $item, $fee_key, $fee, $order );
- // Add item to order and save.
- $order->add_item( $item );
- }
- }
- /**
- * Add shipping lines to the order.
- *
- * @param WC_Order $order Order Instance.
- * @param array $chosen_shipping_methods Chosen shipping methods.
- * @param array $packages Packages.
- */
- public function create_order_shipping_lines( &$order, $chosen_shipping_methods, $packages ) {
- foreach ( $packages as $package_key => $package ) {
- if ( isset( $chosen_shipping_methods[ $package_key ], $package['rates'][ $chosen_shipping_methods[ $package_key ] ] ) ) {
- $shipping_rate = $package['rates'][ $chosen_shipping_methods[ $package_key ] ];
- $item = new WC_Order_Item_Shipping();
- $item->legacy_package_key = $package_key; // @deprecated For legacy actions.
- $item->set_props(
- array(
- 'method_title' => $shipping_rate->label,
- 'method_id' => $shipping_rate->method_id,
- 'instance_id' => $shipping_rate->instance_id,
- 'total' => wc_format_decimal( $shipping_rate->cost ),
- 'taxes' => array(
- 'total' => $shipping_rate->taxes,
- ),
- )
- );
- foreach ( $shipping_rate->get_meta_data() as $key => $value ) {
- $item->add_meta_data( $key, $value, true );
- }
- /**
- * Action hook to adjust item before save.
- *
- * @since 3.0.0
- */
- do_action( 'woocommerce_checkout_create_order_shipping_item', $item, $package_key, $package, $order );
- // Add item to order and save.
- $order->add_item( $item );
- }
- }
- }
- /**
- * Add tax lines to the order.
- *
- * @param WC_Order $order Order instance.
- * @param WC_Cart $cart Cart instance.
- */
- public function create_order_tax_lines( &$order, $cart ) {
- foreach ( array_keys( $cart->get_cart_contents_taxes() + $cart->get_shipping_taxes() + $cart->get_fee_taxes() ) as $tax_rate_id ) {
- if ( $tax_rate_id && apply_filters( 'woocommerce_cart_remove_taxes_zero_rate_id', 'zero-rated' ) !== $tax_rate_id ) {
- $item = new WC_Order_Item_Tax();
- $item->set_props(
- array(
- 'rate_id' => $tax_rate_id,
- 'tax_total' => $cart->get_tax_amount( $tax_rate_id ),
- 'shipping_tax_total' => $cart->get_shipping_tax_amount( $tax_rate_id ),
- 'rate_code' => WC_Tax::get_rate_code( $tax_rate_id ),
- 'label' => WC_Tax::get_rate_label( $tax_rate_id ),
- 'compound' => WC_Tax::is_compound( $tax_rate_id ),
- )
- );
- /**
- * Action hook to adjust item before save.
- *
- * @since 3.0.0
- */
- do_action( 'woocommerce_checkout_create_order_tax_item', $item, $tax_rate_id, $order );
- // Add item to order and save.
- $order->add_item( $item );
- }
- }
- }
- /**
- * Add coupon lines to the order.
- *
- * @param WC_Order $order Order instance.
- * @param WC_Cart $cart Cart instance.
- */
- public function create_order_coupon_lines( &$order, $cart ) {
- foreach ( $cart->get_coupons() as $code => $coupon ) {
- $item = new WC_Order_Item_Coupon();
- $item->set_props(
- array(
- 'code' => $code,
- 'discount' => $cart->get_coupon_discount_amount( $code ),
- 'discount_tax' => $cart->get_coupon_discount_tax_amount( $code ),
- )
- );
- // Avoid storing used_by - it's not needed and can get large.
- $coupon_data = $coupon->get_data();
- unset( $coupon_data['used_by'] );
- $item->add_meta_data( 'coupon_data', $coupon_data );
- /**
- * Action hook to adjust item before save.
- *
- * @since 3.0.0
- */
- do_action( 'woocommerce_checkout_create_order_coupon_item', $item, $code, $coupon, $order );
- // Add item to order and save.
- $order->add_item( $item );
- }
- }
- /**
- * See if a fieldset should be skipped.
- *
- * @since 3.0.0
- * @param string $fieldset_key Fieldset key.
- * @param array $data Posted data.
- * @return bool
- */
- protected function maybe_skip_fieldset( $fieldset_key, $data ) {
- if ( 'shipping' === $fieldset_key && ( ! $data['ship_to_different_address'] || ! WC()->cart->needs_shipping_address() ) ) {
- return true;
- }
- if ( 'account' === $fieldset_key && ( is_user_logged_in() || ( ! $this->is_registration_required() && empty( $data['createaccount'] ) ) ) ) {
- return true;
- }
- return false;
- }
- /**
- * Get posted data from the checkout form.
- *
- * @since 3.1.0
- * @return array of data.
- */
- public function get_posted_data() {
- $skipped = array();
- $data = array(
- 'terms' => (int) isset( $_POST['terms'] ), // WPCS: input var ok, CSRF ok.
- 'createaccount' => (int) ! empty( $_POST['createaccount'] ), // WPCS: input var ok, CSRF ok.
- 'payment_method' => isset( $_POST['payment_method'] ) ? wc_clean( wp_unslash( $_POST['payment_method'] ) ) : '', // WPCS: input var ok, CSRF ok.
- 'shipping_method' => isset( $_POST['shipping_method'] ) ? wc_clean( wp_unslash( $_POST['shipping_method'] ) ) : '', // WPCS: input var ok, CSRF ok.
- 'ship_to_different_address' => ! empty( $_POST['ship_to_different_address'] ) && ! wc_ship_to_billing_address_only(), // WPCS: input var ok, CSRF ok.
- 'woocommerce_checkout_update_totals' => isset( $_POST['woocommerce_checkout_update_totals'] ), // WPCS: input var ok, CSRF ok.
- );
- foreach ( $this->get_checkout_fields() as $fieldset_key => $fieldset ) {
- if ( $this->maybe_skip_fieldset( $fieldset_key, $data ) ) {
- $skipped[] = $fieldset_key;
- continue;
- }
- foreach ( $fieldset as $key => $field ) {
- $type = sanitize_title( isset( $field['type'] ) ? $field['type'] : 'text' );
- switch ( $type ) {
- case 'checkbox':
- $value = isset( $_POST[ $key ] ) ? 1 : ''; // WPCS: input var ok, CSRF ok.
- break;
- case 'multiselect':
- $value = isset( $_POST[ $key ] ) ? implode( ', ', wc_clean( wp_unslash( $_POST[ $key ] ) ) ) : ''; // WPCS: input var ok, CSRF ok.
- break;
- case 'textarea':
- $value = isset( $_POST[ $key ] ) ? wc_sanitize_textarea( wp_unslash( $_POST[ $key ] ) ) : ''; // WPCS: input var ok, CSRF ok.
- break;
- default:
- $value = isset( $_POST[ $key ] ) ? wc_clean( wp_unslash( $_POST[ $key ] ) ) : ''; // WPCS: input var ok, CSRF ok.
- break;
- }
- $data[ $key ] = apply_filters( 'woocommerce_process_checkout_' . $type . '_field', apply_filters( 'woocommerce_process_checkout_field_' . $key, $value ) );
- }
- }
- if ( in_array( 'shipping', $skipped, true ) && ( WC()->cart->needs_shipping_address() || wc_ship_to_billing_address_only() ) ) {
- foreach ( $this->get_checkout_fields( 'shipping' ) as $key => $field ) {
- $data[ $key ] = isset( $data[ 'billing_' . substr( $key, 9 ) ] ) ? $data[ 'billing_' . substr( $key, 9 ) ] : '';
- }
- }
- // BW compatibility.
- $this->legacy_posted_data = $data;
- return apply_filters( 'woocommerce_checkout_posted_data', $data );
- }
- /**
- * Validates the posted checkout data based on field properties.
- *
- * @since 3.0.0
- * @param array $data An array of posted data.
- * @param WP_Error $errors Validation error.
- */
- protected function validate_posted_data( &$data, &$errors ) {
- foreach ( $this->get_checkout_fields() as $fieldset_key => $fieldset ) {
- if ( $this->maybe_skip_fieldset( $fieldset_key, $data ) ) {
- continue;
- }
- foreach ( $fieldset as $key => $field ) {
- if ( ! isset( $data[ $key ] ) ) {
- continue;
- }
- $required = ! empty( $field['required'] );
- $format = array_filter( isset( $field['validate'] ) ? (array) $field['validate'] : array() );
- $field_label = isset( $field['label'] ) ? $field['label'] : '';
- switch ( $fieldset_key ) {
- case 'shipping':
- /* translators: %s: field name */
- $field_label = sprintf( __( 'Shipping %s', 'woocommerce' ), $field_label );
- break;
- case 'billing':
- /* translators: %s: field name */
- $field_label = sprintf( __( 'Billing %s', 'woocommerce' ), $field_label );
- break;
- }
- if ( in_array( 'postcode', $format, true ) ) {
- $country = isset( $data[ $fieldset_key . '_country' ] ) ? $data[ $fieldset_key . '_country' ] : WC()->customer->{"get_{$fieldset_key}_country"}();
- $data[ $key ] = wc_format_postcode( $data[ $key ], $country );
- if ( '' !== $data[ $key ] && ! WC_Validation::is_postcode( $data[ $key ], $country ) ) {
- /* translators: %s: field name */
- $errors->add( 'validation', sprintf( __( '%s is not a valid postcode / ZIP.', 'woocommerce' ), '<strong>' . esc_html( $field_label ) . '</strong>' ) );
- }
- }
- if ( in_array( 'phone', $format, true ) ) {
- $data[ $key ] = wc_format_phone_number( $data[ $key ] );
- if ( '' !== $data[ $key ] && ! WC_Validation::is_phone( $data[ $key ] ) ) {
- /* translators: %s: phone number */
- $errors->add( 'validation', sprintf( __( '%s is not a valid phone number.', 'woocommerce' ), '<strong>' . esc_html( $field_label ) . '</strong>' ) );
- }
- }
- if ( in_array( 'email', $format, true ) && '' !== $data[ $key ] ) {
- $data[ $key ] = sanitize_email( $data[ $key ] );
- if ( ! is_email( $data[ $key ] ) ) {
- /* translators: %s: email address */
- $errors->add( 'validation', sprintf( __( '%s is not a valid email address.', 'woocommerce' ), '<strong>' . esc_html( $field_label ) . '</strong>' ) );
- continue;
- }
- }
- if ( '' !== $data[ $key ] && in_array( 'state', $format, true ) ) {
- $country = isset( $data[ $fieldset_key . '_country' ] ) ? $data[ $fieldset_key . '_country' ] : WC()->customer->{"get_{$fieldset_key}_country"}();
- $valid_states = WC()->countries->get_states( $country );
- if ( ! empty( $valid_states ) && is_array( $valid_states ) && count( $valid_states ) > 0 ) {
- $valid_state_values = array_map( 'wc_strtoupper', array_flip( array_map( 'wc_strtoupper', $valid_states ) ) );
- $data[ $key ] = wc_strtoupper( $data[ $key ] );
- if ( isset( $valid_state_values[ $data[ $key ] ] ) ) {
- // With this part we consider state value to be valid as well, convert it to the state key for the valid_states check below.
- $data[ $key ] = $valid_state_values[ $data[ $key ] ];
- }
- if ( ! in_array( $data[ $key ], $valid_state_values, true ) ) {
- /* translators: 1: state field 2: valid states */
- $errors->add( 'validation', sprintf( __( '%1$s is not valid. Please enter one of the following: %2$s', 'woocommerce' ), '<strong>' . esc_html( $field_label ) . '</strong>', implode( ', ', $valid_states ) ) );
- }
- }
- }
- if ( $required && '' === $data[ $key ] ) {
- /* translators: %s: field name */
- $errors->add( 'required-field', apply_filters( 'woocommerce_checkout_required_field_notice', sprintf( __( '%s is a required field.', 'woocommerce' ), '<strong>' . esc_html( $field_label ) . '</strong>' ), $field_label ) );
- }
- }
- }
- }
- /**
- * Validates that the checkout has enough info to proceed.
- *
- * @since 3.0.0
- * @param array $data An array of posted data.
- * @param WP_Error $errors Validation errors.
- */
- protected function validate_checkout( &$data, &$errors ) {
- $this->validate_posted_data( $data, $errors );
- $this->check_cart_items();
- if ( empty( $data['woocommerce_checkout_update_totals'] ) && empty( $data['terms'] ) && ! empty( $_POST['terms-field'] ) ) { // WPCS: input var ok, CSRF ok.
- $errors->add( 'terms', __( 'Please read and accept the terms and conditions to proceed with your order.', 'woocommerce' ) );
- }
- if ( WC()->cart->needs_shipping() ) {
- $shipping_country = WC()->customer->get_shipping_country();
- if ( empty( $shipping_country ) ) {
- $errors->add( 'shipping', __( 'Please enter an address to continue.', 'woocommerce' ) );
- } elseif ( ! in_array( WC()->customer->get_shipping_country(), array_keys( WC()->countries->get_shipping_countries() ), true ) ) {
- /* translators: %s: shipping location */
- $errors->add( 'shipping', sprintf( __( 'Unfortunately <strong>we do not ship %s</strong>. Please enter an alternative shipping address.', 'woocommerce' ), WC()->countries->shipping_to_prefix() . ' ' . WC()->customer->get_shipping_country() ) );
- } else {
- $chosen_shipping_methods = WC()->session->get( 'chosen_shipping_methods' );
- foreach ( WC()->shipping->get_packages() as $i => $package ) {
- if ( ! isset( $chosen_shipping_methods[ $i ], $package['rates'][ $chosen_shipping_methods[ $i ] ] ) ) {
- $errors->add( 'shipping', __( 'No shipping method has been selected. Please double check your address, or contact us if you need any help.', 'woocommerce' ) );
- }
- }
- }
- }
- if ( WC()->cart->needs_payment() ) {
- $available_gateways = WC()->payment_gateways->get_available_payment_gateways();
- if ( ! isset( $available_gateways[ $data['payment_method'] ] ) ) {
- $errors->add( 'payment', __( 'Invalid payment method.', 'woocommerce' ) );
- } else {
- $available_gateways[ $data['payment_method'] ]->validate_fields();
- }
- }
- do_action( 'woocommerce_after_checkout_validation', $data, $errors );
- }
- /**
- * Set address field for customer.
- *
- * @since 3.0.7
- * @param string $field String to update.
- * @param string $key Field key.
- * @param array $data Array of data to get the value from.
- */
- protected function set_customer_address_fields( $field, $key, $data ) {
- if ( isset( $data[ "billing_{$field}" ] ) ) {
- WC()->customer->{"set_billing_{$field}"}( $data[ "billing_{$field}" ] );
- WC()->customer->{"set_shipping_{$field}"}( $data[ "billing_{$field}" ] );
- }
- if ( isset( $data[ "shipping_{$field}" ] ) ) {
- WC()->customer->{"set_shipping_{$field}"}( $data[ "shipping_{$field}" ] );
- }
- }
- /**
- * Update customer and session data from the posted checkout data.
- *
- * @since 3.0.0
- * @param array $data Posted data.
- */
- protected function update_session( $data ) {
- // Update both shipping and billing to the passed billing address first if set.
- $address_fields = array(
- 'address_1',
- 'address_2',
- 'city',
- 'postcode',
- 'state',
- 'country',
- );
- array_walk( $address_fields, array( $this, 'set_customer_address_fields' ), $data );
- WC()->customer->save();
- // Update customer shipping and payment method to posted method.
- $chosen_shipping_methods = WC()->session->get( 'chosen_shipping_methods' );
- if ( is_array( $data['shipping_method'] ) ) {
- foreach ( $data['shipping_method'] as $i => $value ) {
- $chosen_shipping_methods[ $i ] = $value;
- }
- }
- WC()->session->set( 'chosen_shipping_methods', $chosen_shipping_methods );
- WC()->session->set( 'chosen_payment_method', $data['payment_method'] );
- // Update cart totals now we have customer address.
- WC()->cart->calculate_totals();
- }
- /**
- * Process an order that does require payment.
- *
- * @since 3.0.0
- * @param int $order_id Order ID.
- * @param string $payment_method Payment method.
- */
- protected function process_order_payment( $order_id, $payment_method ) {
- $available_gateways = WC()->payment_gateways->get_available_payment_gateways();
- if ( ! isset( $available_gateways[ $payment_method ] ) ) {
- return;
- }
- // Store Order ID in session so it can be re-used after payment failure.
- WC()->session->set( 'order_awaiting_payment', $order_id );
- // Process Payment.
- $result = $available_gateways[ $payment_method ]->process_payment( $order_id );
- // Redirect to success/confirmation/payment page.
- if ( isset( $result['result'] ) && 'success' === $result['result'] ) {
- $result = apply_filters( 'woocommerce_payment_successful_result', $result, $order_id );
- if ( ! is_ajax() ) {
- wp_redirect( $result['redirect'] );
- exit;
- }
- wp_send_json( $result );
- }
- }
- /**
- * Process an order that doesn't require payment.
- *
- * @since 3.0.0
- * @param int $order_id Order ID.
- */
- protected function process_order_without_payment( $order_id ) {
- $order = wc_get_order( $order_id );
- $order->payment_complete();
- wc_empty_cart();
- if ( ! is_ajax() ) {
- wp_safe_redirect(
- apply_filters( 'woocommerce_checkout_no_payment_needed_redirect', $order->get_checkout_order_received_url(), $order )
- );
- exit;
- }
- wp_send_json(
- array(
- 'result' => 'success',
- 'redirect' => apply_filters( 'woocommerce_checkout_no_payment_needed_redirect', $order->get_checkout_order_received_url(), $order ),
- )
- );
- }
- /**
- * Create a new customer account if needed.
- *
- * @throws Exception When not able to create customer.
- * @param array $data Posted data.
- */
- protected function process_customer( $data ) {
- $customer_id = apply_filters( 'woocommerce_checkout_customer_id', get_current_user_id() );
- if ( ! is_user_logged_in() && ( $this->is_registration_required() || ! empty( $data['createaccount'] ) ) ) {
- $username = ! empty( $data['account_username'] ) ? $data['account_username'] : '';
- $password = ! empty( $data['account_password'] ) ? $data['account_password'] : '';
- $customer_id = wc_create_new_customer( $data['billing_email'], $username, $password );
- if ( is_wp_error( $customer_id ) ) {
- throw new Exception( $customer_id->get_error_message() );
- }
- wp_set_current_user( $customer_id );
- wc_set_customer_auth_cookie( $customer_id );
- // As we are now logged in, checkout will need to refresh to show logged in data.
- WC()->session->set( 'reload_checkout', true );
- // Also, recalculate cart totals to reveal any role-based discounts that were unavailable before registering.
- WC()->cart->calculate_totals();
- }
- // On multisite, ensure user exists on current site, if not add them before allowing login.
- if ( $customer_id && is_multisite() && is_user_logged_in() && ! is_user_member_of_blog() ) {
- add_user_to_blog( get_current_blog_id(), $customer_id, 'customer' );
- }
- // Add customer info from other fields.
- if ( $customer_id && apply_filters( 'woocommerce_checkout_update_customer_data', true, $this ) ) {
- $customer = new WC_Customer( $customer_id );
- if ( ! empty( $data['billing_first_name'] ) ) {
- $customer->set_first_name( $data['billing_first_name'] );
- }
- if ( ! empty( $data['billing_last_name'] ) ) {
- $customer->set_last_name( $data['billing_last_name'] );
- }
- // If the display name is an email, update to the user's full name.
- if ( is_email( $customer->get_display_name() ) ) {
- $customer->set_display_name( $data['billing_first_name'] . ' ' . $data['billing_last_name'] );
- }
- foreach ( $data as $key => $value ) {
- // Use setters where available.
- if ( is_callable( array( $customer, "set_{$key}" ) ) ) {
- $customer->{"set_{$key}"}( $value );
- // Store custom fields prefixed with wither shipping_ or billing_.
- } elseif ( 0 === stripos( $key, 'billing_' ) || 0 === stripos( $key, 'shipping_' ) ) {
- $customer->update_meta_data( $key, $value );
- }
- }
- /**
- * Action hook to adjust customer before save.
- *
- * @since 3.0.0
- */
- do_action( 'woocommerce_checkout_update_customer', $customer, $data );
- $customer->save();
- }
- do_action( 'woocommerce_checkout_update_user_meta', $customer_id, $data );
- }
- /**
- * If checkout failed during an AJAX call, send failure response.
- */
- protected function send_ajax_failure_response() {
- if ( is_ajax() ) {
- // Only print notices if not reloading the checkout, otherwise they're lost in the page reload.
- if ( ! isset( WC()->session->reload_checkout ) ) {
- ob_start();
- wc_print_notices();
- $messages = ob_get_clean();
- }
- $response = array(
- 'result' => 'failure',
- 'messages' => isset( $messages ) ? $messages : '',
- 'refresh' => isset( WC()->session->refresh_totals ),
- 'reload' => isset( WC()->session->reload_checkout ),
- );
- unset( WC()->session->refresh_totals, WC()->session->reload_checkout );
- wp_send_json( $response );
- }
- }
- /**
- * Process the checkout after the confirm order button is pressed.
- *
- * @throws Exception When validation fails.
- */
- public function process_checkout() {
- try {
- $nonce_value = wc_get_var( $_REQUEST['woocommerce-process-checkout-nonce'], wc_get_var( $_REQUEST['_wpnonce'], '' ) ); // @codingStandardsIgnoreLine.
- if ( empty( $nonce_value ) || ! wp_verify_nonce( $nonce_value, 'woocommerce-process_checkout' ) ) {
- WC()->session->set( 'refresh_totals', true );
- throw new Exception( __( 'We were unable to process your order, please try again.', 'woocommerce' ) );
- }
- wc_maybe_define_constant( 'WOOCOMMERCE_CHECKOUT', true );
- wc_set_time_limit( 0 );
- do_action( 'woocommerce_before_checkout_process' );
- if ( WC()->cart->is_empty() ) {
- /* translators: %s: shop cart url */
- throw new Exception( sprintf( __( 'Sorry, your session has expired. <a href="%s" class="wc-backward">Return to shop</a>', 'woocommerce' ), esc_url( wc_get_page_permalink( 'shop' ) ) ) );
- }
- do_action( 'woocommerce_checkout_process' );
- $errors = new WP_Error();
- $posted_data = $this->get_posted_data();
- // Update session for customer and totals.
- $this->update_session( $posted_data );
- // Validate posted data and cart items before proceeding.
- $this->validate_checkout( $posted_data, $errors );
- foreach ( $errors->get_error_messages() as $message ) {
- wc_add_notice( $message, 'error' );
- }
- if ( empty( $posted_data['woocommerce_checkout_update_totals'] ) && 0 === wc_notice_count( 'error' ) ) {
- $this->process_customer( $posted_data );
- $order_id = $this->create_order( $posted_data );
- $order = wc_get_order( $order_id );
- if ( is_wp_error( $order_id ) ) {
- throw new Exception( $order_id->get_error_message() );
- }
- if ( ! $order ) {
- throw new Exception( __( 'Unable to create order.', 'woocommerce' ) );
- }
- do_action( 'woocommerce_checkout_order_processed', $order_id, $posted_data, $order );
- if ( WC()->cart->needs_payment() ) {
- $this->process_order_payment( $order_id, $posted_data['payment_method'] );
- } else {
- $this->process_order_without_payment( $order_id );
- }
- }
- } catch ( Exception $e ) {
- wc_add_notice( $e->getMessage(), 'error' );
- }
- $this->send_ajax_failure_response();
- }
- /**
- * Get a posted address field after sanitization and validation.
- *
- * @param string $key Field key.
- * @param string $type Type of address. Available options: 'billing' or 'shipping'.
- * @return string
- */
- public function get_posted_address_data( $key, $type = 'billing' ) {
- if ( 'billing' === $type || false === $this->legacy_posted_data['ship_to_different_address'] ) {
- $return = isset( $this->legacy_posted_data[ 'billing_' . $key ] ) ? $this->legacy_posted_data[ 'billing_' . $key ] : '';
- } else {
- $return = isset( $this->legacy_posted_data[ 'shipping_' . $key ] ) ? $this->legacy_posted_data[ 'shipping_' . $key ] : '';
- }
- return $return;
- }
- /**
- * Gets the value either from the posted data, or from the users meta data.
- *
- * @param string $input Input key.
- * @return string
- */
- public function get_value( $input ) {
- if ( ! empty( $_POST[ $input ] ) ) { // WPCS: input var ok, CSRF OK.
- return wc_clean( wp_unslash( $_POST[ $input ] ) ); // WPCS: input var ok, CSRF OK.
- }
- $value = apply_filters( 'woocommerce_checkout_get_value', null, $input );
- if ( null !== $value ) {
- return $value;
- }
- if ( is_callable( array( WC()->customer, "get_$input" ) ) ) {
- $value = WC()->customer->{"get_$input"}() ? WC()->customer->{"get_$input"}() : null;
- } elseif ( WC()->customer->meta_exists( $input ) ) {
- $value = WC()->customer->get_meta( $input, true );
- }
- return apply_filters( 'default_checkout_' . $input, $value, $input );
- }
- }
|