Email and orphans

inc/checkout/class-checkout.php

@@ -1717,18 +1717,19 @@ public function validation_rules() {
 		 * First, let's set upm the general rules:
 		 */
 		$rules = [
-			'email_address'    => 'required_without:user_id|email|unique:\WP_User,email',
-			'username'         => 'required_without:user_id|alpha_dash|min:4|lowercase|unique:\WP_User,login',
-			'password'         => 'required_without:user_id|min:6',
-			'password_conf'    => 'same:password',
-			'template_id'      => 'integer|site_template',
-			'products'         => 'products',
-			'gateway'          => '',
-			'valid_password'   => 'accepted',
-			'billing_country'  => 'country|required_with:billing_country',
-			'billing_zip_code' => 'required_with:billing_zip_code',
-			'billing_state'    => 'state',
-			'billing_city'     => 'city',
+			'email_address'              => 'required_without:user_id|email|unique:\WP_User,email',
+			'email_address_confirmation' => 'same:email_address',
+			'username'                   => 'required_without:user_id|alpha_dash|min:4|lowercase|unique:\WP_User,login',
+			'password'                   => 'required_without:user_id|min:6',
+			'password_conf'              => 'same:password',
+			'template_id'                => 'integer|site_template',
+			'products'                   => 'products',
+			'gateway'                    => '',
+			'valid_password'             => 'accepted',
+			'billing_country'            => 'country|required_with:billing_country',
+			'billing_zip_code'           => 'required_with:billing_zip_code',
+			'billing_state'              => 'state',
+			'billing_city'               => 'city',
 		];
 
 		/*
@@ -1859,11 +1860,12 @@ public function validate($rules = null) {
 		// Add some hidden or compound fields ids
 		$validation_aliases = array_merge(
 			[
-				'password_conf'  => __('Password confirmation', 'multisite-ultimate'),
-				'template_id'    => __('Template ID', 'multisite-ultimate'),
-				'valid_password' => __('Valid password', 'multisite-ultimate'),
-				'products'       => __('Products', 'multisite-ultimate'),
-				'gateway'        => __('Payment Gateway', 'multisite-ultimate'),
+				'password_conf'              => __('Password confirmation', 'multisite-ultimate'),
+				'email_address_confirmation' => __('Email confirmation', 'multisite-ultimate'),
+				'template_id'                => __('Template ID', 'multisite-ultimate'),
+				'valid_password'             => __('Valid password', 'multisite-ultimate'),
+				'products'                   => __('Products', 'multisite-ultimate'),
+				'gateway'                    => __('Payment Gateway', 'multisite-ultimate'),
 			],
 			$base_aliases
 		);

inc/checkout/signup-fields/class-signup-field-email-confirmation.php

@@ -0,0 +1,332 @@
+<?php
+/**
+ * Email confirmation field for checkout forms.
+ *
+ * @package WP_Ultimo
+ * @subpackage Checkout\Signup_Fields
+ * @since 2.0.0
+ */
+
+namespace WP_Ultimo\Checkout\Signup_Fields;
+
+use WP_Ultimo\Checkout\Signup_Fields\Base_Signup_Field;
+
+// Exit if accessed directly
+defined('ABSPATH') || exit;
+
+/**
+ * Email confirmation field that asks customers to enter their email twice to confirm it matches.
+ *
+ * @package WP_Ultimo
+ * @subpackage Checkout\Signup_Fields
+ * @since 2.0.0
+ */
+class Signup_Field_Email_Confirmation extends Base_Signup_Field {
+
+	/**
+	 * Returns the type of the field.
+	 *
+	 * @since 2.0.0
+	 * @return string
+	 */
+	public function get_type(): string {
+
+		return 'email_confirmation';
+	}
+
+	/**
+	 * Returns if this field should be present on the checkout flow or not.
+	 *
+	 * @since 2.0.0
+	 * @return bool
+	 */
+	public function is_required(): bool {
+
+		return true;
+	}
+
+	/**
+	 * Is this a user-related field?
+	 *
+	 * If this is set to true, this field will be hidden
+	 * when the user is already logged in.
+	 *
+	 * @since 2.0.0
+	 * @return bool
+	 */
+	public function is_user_field(): bool {
+
+		return true;
+	}
+
+	/**
+	 * Requires the title of the field/element type.
+	 *
+	 * This is used on the Field/Element selection screen.
+	 *
+	 * @since 2.0.0
+	 * @return string
+	 */
+	public function get_title() {
+
+		return __('Email Confirmation', 'multisite-ultimate');
+	}
+
+	/**
+	 * Returns the description of the field/element.
+	 *
+	 * This is used as the title attribute of the selector.
+	 *
+	 * @since 2.0.0
+	 * @return string
+	 */
+	public function get_description() {
+
+		return __('Adds an email address field with confirmation field. Customers must enter their email address twice to ensure accuracy.', 'multisite-ultimate');
+	}
+
+	/**
+	 * Returns the tooltip of the field/element.
+	 *
+	 * This is used as the tooltip attribute of the selector.
+	 *
+	 * @since 2.0.0
+	 * @return string
+	 */
+	public function get_tooltip() {
+
+		return __('Adds an email address field with confirmation field. Customers must enter their email address twice to ensure accuracy.', 'multisite-ultimate');
+	}
+
+	/**
+	 * Returns the icon to be used on the selector.
+	 *
+	 * Can be either a dashicon class or a wu-dashicon class.
+	 *
+	 * @since 2.0.0
+	 * @return string
+	 */
+	public function get_icon(): string {
+
+		return 'dashicons-wu-at-sign';
+	}
+
+	/**
+	 * Returns the default values for the field-elements.
+	 *
+	 * This is passed through a wp_parse_args before we send the values
+	 * to the method that returns the actual fields for the checkout form.
+	 *
+	 * @since 2.0.0
+	 * @return array
+	 */
+	public function defaults() {
+
+		return [
+			'display_notices'     => true,
+			'confirmation_label'  => __('Confirm Email Address', 'multisite-ultimate'),
+			'confirmation_placeholder' => __('Re-enter your email address', 'multisite-ultimate'),
+		];
+	}
+
+	/**
+	 * List of keys of the default fields we want to display on the builder.
+	 *
+	 * @since 2.0.0
+	 * @return array
+	 */
+	public function default_fields() {
+
+		return [
+			'name',
+			'placeholder',
+			'tooltip',
+		];
+	}
+
+	/**
+	 * If you want to force a particular attribute to a value, declare it here.
+	 *
+	 * @since 2.0.0
+	 * @return array
+	 */
+	public function force_attributes() {
+
+		return [
+			'id'       => 'email_address',
+			'required' => true,
+		];
+	}
+
+	/**
+	 * Returns the list of additional fields specific to this type.
+	 *
+	 * @since 2.0.0
+	 * @return array
+	 */
+	public function get_fields() {
+
+		return [
+			'display_notices' => [
+				'type'      => 'toggle',
+				'title'     => __('Display Notices', 'multisite-ultimate'),
+				'desc'      => __('When the customer is already logged in, a box with the customer\'s username and a link to logout is displayed instead of the email fields. Disable this option if you do not want that box to show up.', 'multisite-ultimate'),
+				'tooltip'   => '',
+				'value'     => 1,
+				'html_attr' => [
+					'v-model' => 'display_notices',
+				],
+			],
+			'confirmation_label' => [
+				'type'        => 'text',
+				'title'       => __('Confirmation Field Label', 'multisite-ultimate'),
+				'placeholder' => __('e.g. Confirm Email Address', 'multisite-ultimate'),
+				'desc'        => __('This is the label for the email confirmation field.', 'multisite-ultimate'),
+				'tooltip'     => '',
+				'value'       => __('Confirm Email Address', 'multisite-ultimate'),
+				'html_attr'   => [
+					'v-model' => 'confirmation_label',
+				],
+			],
+			'confirmation_placeholder' => [
+				'type'        => 'text',
+				'title'       => __('Confirmation Field Placeholder', 'multisite-ultimate'),
+				'placeholder' => __('e.g. Re-enter your email address', 'multisite-ultimate'),
+				'desc'        => __('This value appears inside the confirmation field as placeholder text.', 'multisite-ultimate'),
+				'tooltip'     => '',
+				'value'       => __('Re-enter your email address', 'multisite-ultimate'),
+				'html_attr'   => [
+					'v-model' => 'confirmation_placeholder',
+				],
+			],
+		];
+	}
+
+	/**
+	 * Returns the field/element actual field array to be used on the checkout form.
+	 *
+	 * @since 2.0.0
+	 *
+	 * @param array $attributes Attributes saved on the editor form.
+	 * @return array An array of fields, not the field itself.
+	 */
+	public function to_fields_array($attributes) {
+
+		$checkout_fields = [];
+
+		if (is_user_logged_in()) {
+			if ($attributes['display_notices']) {
+				$checkout_fields['login_note'] = [
+					'type'              => 'note',
+					'title'             => __('Not you?', 'multisite-ultimate'),
+					'desc'              => [$this, 'render_not_you_customer_message'],
+					'wrapper_classes'   => wu_get_isset($attributes, 'wrapper_element_classes', ''),
+					'wrapper_html_attr' => [
+						'style' => $this->calculate_style_attr(),
+					],
+				];
+			}
+		} else {
+			if ($attributes['display_notices']) {
+				$checkout_fields['login_note'] = [
+					'type'              => 'note',
+					'title'             => __('Existing customer?', 'multisite-ultimate'),
+					'desc'              => [$this, 'render_existing_customer_message'],
+					'wrapper_classes'   => wu_get_isset($attributes, 'wrapper_element_classes', ''),
+					'wrapper_html_attr' => [
+						'style' => $this->calculate_style_attr(),
+					],
+				];
+			}
+
+			$checkout_fields['email_address'] = [
+				'type'              => 'email',
+				'id'                => 'email_address',
+				'name'              => $attributes['name'],
+				'placeholder'       => $attributes['placeholder'],
+				'tooltip'           => $attributes['tooltip'],
+				'value'             => $this->get_value(),
+				'required'          => true,
+				'wrapper_classes'   => wu_get_isset($attributes, 'wrapper_element_classes', ''),
+				'classes'           => wu_get_isset($attributes, 'element_classes', ''),
+				'wrapper_html_attr' => [
+					'style' => $this->calculate_style_attr(),
+				],
+			];
+
+			$checkout_fields['email_address_confirmation'] = [
+				'type'              => 'email',
+				'id'                => 'email_address_confirmation',
+				'name'              => wu_get_isset($attributes, 'confirmation_label', __('Confirm Email Address', 'multisite-ultimate')),
+				'placeholder'       => wu_get_isset($attributes, 'confirmation_placeholder', __('Re-enter your email address', 'multisite-ultimate')),
+				'tooltip'           => __('Please re-enter your email address to confirm it matches.', 'multisite-ultimate'),
+				'value'             => '',
+				'required'          => true,
+				'wrapper_classes'   => wu_get_isset($attributes, 'wrapper_element_classes', ''),
+				'classes'           => wu_get_isset($attributes, 'element_classes', ''),
+				'wrapper_html_attr' => [
+					'style' => $this->calculate_style_attr(),
+				],
+				'html_attr' => [
+					'data-confirm-email' => 'email_address',
+				],
+			];
+		}
+
+		return $checkout_fields;
+	}
+
+	/**
+	 * Renders the login message for users that are not logged in.
+	 *
+	 * @since 2.0.0
+	 * @return string
+	 */
+	public function render_existing_customer_message() {
+
+		$login_url = wp_login_url(add_query_arg('logged', '1'));
+
+		ob_start(); ?>
+
+		<div class="wu-p-4 wu-bg-yellow-200">
+
+			<?php
+			// translators: %s is the login URL.
+			printf(wp_kses_post(__('<a href="%s">Log in</a> to renew or change an existing membership.', 'multisite-ultimate')), esc_attr($login_url));
+
+			?>
+
+		</div>
+
+		<?php
+		return ob_get_clean();
+	}
+
+	/**
+	 * Renders the login message for users that are logged in.
+	 *
+	 * @since 2.0.0
+	 * @return string
+	 */
+	public function render_not_you_customer_message() {
+
+		$login_url = wp_login_url(add_query_arg('logged', '1'), true);
+
+		ob_start();
+
+		?>
+
+		<p class="wu-p-4 wu-bg-yellow-200">
+		<?php
+
+		// translators: 1$s is the display name of the user currently logged in.
+		printf(wp_kses_post(__('Not %1$s? <a href="%2$s">Log in</a> using your account.', 'multisite-ultimate')), esc_html(wp_get_current_user()->display_name), esc_attr($login_url));
+
+		?>
+		</p>
+
+		<?php
+
+		return ob_get_clean();
+	}
+}