ate_username( $email, $new_user_args = array(), $suffix = '' ) {
/**
* Make email as username.
*
* Use filter pp_rf_use_email_as_username to override this.
*
* @since 1.5.0
*
* @param bool true|false
*/
if ( apply_filters( 'pp_rf_use_email_as_username', true ) ) {
return $email;
}
$username_parts = array();
if ( isset( $new_user_args['first_name'] ) ) {
$username_parts[] = sanitize_user( $new_user_args['first_name'], true );
}
if ( isset( $new_user_args['last_name'] ) ) {
$username_parts[] = sanitize_user( $new_user_args['last_name'], true );
}
// Remove empty parts.
$username_parts = array_filter( $username_parts );
// If there are no parts, e.g. name had unicode chars, or was not provided, fallback to email.
if ( empty( $username_parts ) ) {
$email_parts = explode( '@', $email );
$email_username = $email_parts[0];
// Exclude common prefixes.
if ( in_array(
$email_username,
array(
'sales',
'hello',
'mail',
'contact',
'info',
),
true
) ) {
// Get the domain part.
$email_username = $email_parts[1];
}
$username_parts[] = sanitize_user( $email_username, true );
}
$username = mb_strtolower( implode( '.', $username_parts ) );
if ( $suffix ) {
$username .= $suffix;
}
/**
* WordPress 4.4 - filters the list of blacklisted usernames.
*
* @param array $usernames Array of blacklisted usernames.
* @
*/
$illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
// Stop illegal logins and generate a new random username.
if ( in_array( strtolower( $username ), array_map( 'strtolower', $illegal_logins ), true ) ) {
$new_args = array();
/**
* Filter generated custom username.
*
* @param string $username Generated username.
* @param string $email New user email address.
* @param array $new_user_args Array of new user args, maybe including first and last names.
* @param string $suffix Append string to username to make it unique.
*/
$new_args['first_name'] = apply_filters(
'pp_rf_generated_username',
'pp_user_' . zeroise( wp_rand( 0, 9999 ), 4 ),
$email,
$new_user_args,
$suffix
);
return $this->create_username( $email, $new_args, $suffix );
}
if ( username_exists( $username ) ) {
// Generate something unique to append to the username in case of a conflict with another user.
$suffix = '-' . zeroise( wp_rand( 0, 9999 ), 4 );
return $this->create_username( $email, $new_user_args, $suffix );
}
/**
* Filter new customer username.
*
* @param string $username Username.
* @param string $email New user email address.
* @param array $new_user_args Array of new user args, maybe including first and last names.
* @param string $suffix Append string to username to make it unique.
*/
return apply_filters( 'pp_rf_new_username', $username, $email, $new_user_args, $suffix );
}
/**
* Set fields.
*
* Build form fields data to have this while replacing
* merge tags in form fields.
*
* @since 1.5.0
* @access private
*
* @param object $settings Module settings.
* @param object $widget Widget object.
* @param string $widget_id Module ID.
* @return void
*/
private function set_fields( $settings, $widget, $widget_id ) {
$form_fields = $settings['form_fields'];
foreach ( $form_fields as $form_field ) {
$field_name = $form_field['field_type'];
$field = array(
'id' => 'field-' . $form_field['_id'],
'type' => $form_field['field_type'],
'name' => $field_name,
'label' => $form_field['field_label'],
'value' => '',
'raw_value' => '',
'required' => 'yes' === $form_field['required'],
);
if ( isset( $this->form_data[ $field_name ] ) ) {
$field['raw_value'] = $this->form_data[ $field_name ];
$value = $field['raw_value'];
if ( is_array( $value ) ) {
$value = implode( ', ', $value );
}
$field['value'] = $this->sanitize_field( $field, $value );
}
$this->form_fields[ $field_name ] = $field;
}
}
/**
* Set meta.
*
* Set meta information of the user who is registering
* via the form.
*
* @since 1.5.0
*
* @param object $settings Module settings.
* @return void
*/
private function set_meta( $settings ) {
$this->form_meta['date'] = array(
'label' => __( 'Date', 'powerpack' ),
'value' => date_i18n( get_option( 'date_format' ) ),
);
$this->form_meta['time'] = array(
'label' => __( 'Time', 'powerpack' ),
'value' => date_i18n( get_option( 'time_format' ) ),
);
$this->form_meta['page_url'] = array(
'label' => __( 'Page URL', 'powerpack' ),
'value' => $this->form_data['referrer'],
);
$this->form_meta['user_agent'] = array(
'label' => __( 'User Agent', 'powerpack' ),
'value' => $_SERVER['HTTP_USER_AGENT'],
);
$this->form_meta['remote_ip'] = array(
'label' => __( 'Remote IP', 'powerpack' ),
'value' => \PowerpackElements\Classes\PP_Helper::get_client_ip(),
);
}
/**
* Send email
*
* Send a notification email to registered user and admin.
*
* @since 1.5.0
* @access private
*
* @param object $settings Module settings.
* @param object $widget Widget object.
* @return $response
*/
private function send_email( $settings, $widget ) {
$response = array(
'code' => '',
'message' => '',
'error' => false,
);
// Get site info.
$site_info = $widget->get_site_info();
// Admin email.
$admin_email = $site_info['admin_email'];
// Site name.
$blogname = $site_info['blogname'];
// From email.
$from_email = ! empty( $settings['email_from'] ) && is_email( $settings['email_from'] ) ? $settings['email_from'] : $admin_email;
// User email fields.
$email_fields = array(
'email_to' => $this->form_data['user_email'],
// translators: %s: New message.
'email_subject' => ! empty( $settings['email_subject'] ) ? $settings['email_subject'] : sprintf( __( 'Registration Successful - %s', 'powerpack' ), $blogname ),
'email_content' => wpautop( $settings['email_content'] ),
'email_from_name' => ! empty( $settings['email_from_name'] ) ? $settings['email_from_name'] : $blogname,
'email_from' => $from_email,
'email_reply_to' => $from_email,
'admin_email_to' => isset( $settings['admin_email_to'] ) && is_email( $settings['admin_email_to'] ) ? $settings['admin_email_to'] : $admin_email,
// translators: %s: New message.
'admin_email_subject' => isset( $settings['admin_email_subject'] ) && ! empty( $settings['admin_email_subject'] ) ? $settings['admin_email_subject'] : __( 'New User Registration', 'powerpack' ),
'admin_email_content' => isset( $settings['admin_email_content'] ) ? wpautop( $settings['admin_email_content'] ) : '',
);
foreach ( $email_fields as $key => $value ) {
$value = trim( $value );
$value = $this->replace_tags( $value, $widget );
if ( ! empty( $value ) ) {
$email_fields[ $key ] = $value;
}
}
// User email content.
$email_fields['email_content'] = $this->replace_content_tags( $email_fields['email_content'] );
// Admin email content.
$email_fields['admin_email_content'] = $this->replace_content_tags( $email_fields['admin_email_content'] );
// Admin email metadata.
$email_meta = '';
$email_metadata = empty( $settings['email_metadata'] ) ? array() : $settings['email_metadata'];
foreach ( $this->form_meta as $id => $field ) {
if ( in_array( $id, $email_metadata, true ) ) {
$email_meta .= $this->field_formatted( $field ) . '
';
}
}
if ( ! empty( $email_meta ) ) {
$email_fields['admin_email_content'] .= '
' . '---' . '
' . '
' . $email_meta;
}
// translators: %s: email_from_name.
$headers = sprintf( 'From: %s <%s>' . "\r\n", $email_fields['email_from_name'], $email_fields['email_from'] );
// translators: %s: email_reply_to.
$headers .= sprintf( 'Reply-To: %s' . "\r\n", $email_fields['email_reply_to'] );
$headers .= 'Content-Type: text/html; charset=UTF-8' . "\r\n";
// Send email to user.
$email_sent = wp_mail( $email_fields['email_to'], $email_fields['email_subject'], $email_fields['email_content'], $headers );
$response['sent_user_email'] = $email_sent;
// Send email to admin.
if ( isset( $settings['enable_admin_email'] ) && 'yes' === $settings['enable_admin_email'] ) {
// translators: %s: site name and admin email.
$admin_headers = sprintf( 'From: %s <%s>' . "\r\n", $blogname, $admin_email );
// translators: %s: admin email.
$admin_headers .= sprintf( 'Reply-To: %s' . "\r\n", $admin_email );
$admin_headers .= 'Content-Type: text/html; charset=UTF-8' . "\r\n";
$admin_email_sent = wp_mail( $email_fields['admin_email_to'], $email_fields['admin_email_subject'], $email_fields['admin_email_content'], $admin_headers );
$response['sent_admin_email'] = $admin_email_sent;
}
/**
* Fires just after the notification email sent.
*
* @since 1.5.0
*
* @param object $settings Module settings.
*/
do_action( 'pp_rf_email_sent', $settings );
if ( ! $email_sent || ( isset( $admin_email_sent ) && ! $admin_email_sent ) ) {
$response['code'] = 'email_failed';
$response['message'] = __( 'An error occurred sending email!', 'powerpack' );
$response['error'] = true;
}
return $response;
}
/**
* Sanitize field.
*
* Sanitizes the field value.
*
* @since 1.5.0
* @access private
*
* @param array $field An array of field data.
* @param string $value Field value.
*
* @return string $value Sanitized field value.
*/
private function sanitize_field( $field, $value ) {
$field_type = $field['type'];
switch ( $field_type ) {
case 'text':
case 'password':
case 'hidden':
case 'search':
case 'checkbox':
case 'radio':
case 'select':
$value = sanitize_text_field( $value );
break;
case 'url':
$value = esc_url_raw( $value );
break;
case 'textarea':
$value = sanitize_textarea_field( $value );
break;
case 'email':
$value = sanitize_email( $value );
break;
default:
$value = apply_filters( "pp_rf_sanitize_{$field_type}", $value, $field );
}
return $value;
}
/**
* Replace tags.
*
* Replaces merge tags in fields with their original value.
*
* @since 1.5.0
* @access private
*
* @param string $field_value Field value.
* @param Object $widget Widget object.
* @return string $value Original field value.
*/
private function replace_tags( $field_value, $widget ) {
$site_info = $widget->get_site_info();
return preg_replace_callback(
'/{{(.*?)}}/i',
function( $matches ) use ( $site_info ) {
$value = $matches[0];
if ( isset( $this->form_fields[ $matches[1] ] ) ) {
$value = $this->form_fields[ $matches[1] ]['value'];
} elseif ( isset( $site_info[ $matches[1] ] ) ) {
$value = $site_info[ $matches[1] ];
}
return $value;
},
$field_value
);
}
/**
* Replace content tags.
*
* Replaces merge tags in email content field with their value.
*
* @since 1.5.0
* @access private
*
* @param string $email_content Email content.
*
* @return string $email_content Email content with actual value.
*/
private function replace_content_tags( $email_content ) {
$email_content = do_shortcode( $email_content );
$all_fields_tag = '{{all-fields}}';
if ( false !== strpos( $email_content, $all_fields_tag ) ) {
$text = '
';
foreach ( $this->form_fields as $field ) {
$text .= $this->field_formatted( $field ) . '
';
}
$email_content = str_replace( $all_fields_tag, $text, $email_content );
}
return $email_content;
}
/**
* Field formatted.
*
* Returns field value with it's label.
*
* @since 1.5.0
* @access private
*
* @param array $field An array of field data.
*
* @return string $formatted Field label with value.
*/
private function field_formatted( $field ) {
$formatted = '';
if ( ! empty( $field['label'] ) ) {
// translators: %s: Field Label.
$formatted = sprintf( '%s: %s', $field['label'], $field['value'] );
} elseif ( ! empty( $field['value'] ) ) {
// translators: %s: Value.
$formatted = sprintf( '%s', $field['value'] );
}
return $formatted;
}
/**
* Get Widget Setting data.
*
* @since 1.5.0
* @access public
* @param array $elements Element array.
* @param string $form_id Element ID.
* @return Boolean True/False.
*/
public function find_element_recursive( $elements, $form_id ) {
foreach ( $elements as $element ) {
if ( $form_id === $element['id'] ) {
return $element;
}
if ( ! empty( $element['elements'] ) ) {
$element = $this->find_element_recursive( $element['elements'], $form_id );
if ( $element ) {
return $element;
}
}
}
return false;
}
}