false, 'mode' => 'register', 'email_field' => '', 'username_field' => '', 'password_field' => '', 'first_name_field' => '', 'last_name_field' => '', 'display_name' => '', 'role' => get_option( 'default_role', 'subscriber' ), 'meta' => array(), 'auto_login' => true, 'notification' => 'both', 'skip_logged_in' => true, 'msg_email_exists' => __( 'An account with this email already exists. Please log in.', 'fieldwren' ), 'msg_user_exists' => __( 'This username is taken. Please choose another one.', 'fieldwren' ), 'msg_login' => __( 'Please log in to update your profile.', 'fieldwren' ), ), (array) ( $d['user_registration'] ?? array() ) ); return $d; } /** @return array|null Settings when on. */ private static function settings( $form_id ) { $u = Form::settings( $form_id )['user_registration']; return ! empty( $u['enabled'] ) ? $u : null; } /** The current request is a submission. */ public static function mark_live() { self::$live = true; } /* ------------------------------------------------------------------ * * Values * ------------------------------------------------------------------ */ /** @return string Scalar value of a mapped field; Name fields give $part. */ private static function val( array $values, $key, $part = 'first' ) { if ( ! $key || ! isset( $values[ $key ] ) ) { return ''; } $v = $values[ $key ]; if ( is_array( $v ) ) { if ( 'first' === $part && isset( $v['full'] ) && ! isset( $v['first'] ) ) { $parts = preg_split( '/\s+/', trim( (string) $v['full'] ), 2 ); return (string) $parts[0]; } if ( 'last' === $part && isset( $v['full'] ) && ! isset( $v['last'] ) ) { $parts = preg_split( '/\s+/', trim( (string) $v['full'] ), 2 ); return (string) ( $parts[1] ?? '' ); } return isset( $v[ $part ] ) && is_scalar( $v[ $part ] ) ? (string) $v[ $part ] : ''; } return is_scalar( $v ) ? trim( (string) $v ) : ''; } /** @return bool Meta keys a form must never write. */ private static function forbidden_meta( $key ) { global $wpdb; $k = strtolower( $key ); return in_array( $k, array( 'session_tokens', 'user_pass', 'user_login', 'user_email', 'user_level', 'capabilities' ), true ) || false !== strpos( $k, 'capabilities' ) || false !== strpos( $k, 'user_level' ) || 0 === strpos( $k, strtolower( $wpdb->prefix ) ) || 0 === strpos( $k, strtolower( $wpdb->base_prefix ) ); } /* ------------------------------------------------------------------ * * Validation * ------------------------------------------------------------------ */ /** Email / username availability, login for updates. */ public static function validate( $errors, $values, $form_id, $schema ) { $u = self::settings( $form_id ); if ( ! $u ) { return $errors; } $email_key = $u['email_field'] ? $u['email_field'] : Helpers::first_email_field( $form_id ); $fallback = $email_key ? $email_key : (string) ( $schema['order'][0] ?? '_form' ); if ( 'update' === $u['mode'] ) { if ( ! is_user_logged_in() ) { $errors[ $fallback ] = $u['msg_login']; return $errors; } $email = self::val( (array) $values, $email_key ); if ( $email && ! isset( $errors[ $email_key ] ) ) { $owner = email_exists( $email ); if ( $owner && (int) $owner !== get_current_user_id() ) { $errors[ $email_key ] = $u['msg_email_exists']; } } return $errors; } if ( is_user_logged_in() && ! empty( $u['skip_logged_in'] ) ) { return $errors; } $email = sanitize_email( self::val( (array) $values, $email_key ) ); if ( ! isset( $errors[ $email_key ] ) ) { if ( ! $email || ! is_email( $email ) ) { $errors[ $email_key ? $email_key : $fallback ] = __( 'Please enter a valid email address.', 'fieldwren' ); } elseif ( email_exists( $email ) ) { $errors[ $email_key ] = $u['msg_email_exists']; } } if ( $u['username_field'] && ! isset( $errors[ $u['username_field'] ] ) ) { $login = self::val( (array) $values, $u['username_field'] ); if ( '' !== $login ) { if ( ! validate_username( $login ) || sanitize_user( $login, true ) !== $login ) { $errors[ $u['username_field'] ] = __( 'Usernames may only contain letters, numbers, spaces and . - _ @', 'fieldwren' ); } elseif ( username_exists( $login ) || in_array( strtolower( $login ), array_map( 'strtolower', (array) apply_filters( 'illegal_user_logins', array() ) ), true ) ) { // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound -- Core filter, same check as register_new_user(). $errors[ $u['username_field'] ] = $u['msg_user_exists']; } } } if ( $u['password_field'] && ! isset( $errors[ $u['password_field'] ] ) ) { $pass = (string) ( $values[ $u['password_field'] ] ?? '' ); if ( '' !== $pass && strlen( $pass ) < 6 ) { $errors[ $u['password_field'] ] = __( 'Please use a password of at least 6 characters.', 'fieldwren' ); } } return $errors; } /* ------------------------------------------------------------------ * * Run * ------------------------------------------------------------------ */ /** Register or update. */ public static function run( $entry, $values, $form_id ) { $u = self::settings( (int) $form_id ); if ( ! $u ) { return; } $entry = (array) $entry; $values = (array) $values; $res = 'update' === $u['mode'] ? self::update( $u, $entry, $values, (int) $form_id ) : self::register( $u, $entry, $values, (int) $form_id ); if ( null === $res ) { return; } $ok = ! is_wp_error( $res ); /* translators: %d user id */ Logs::add( $form_id, (int) ( $entry['id'] ?? 0 ), 'user', $ok ? 'success' : 'failed', 'update' === $u['mode'] ? __( 'Profile update', 'fieldwren' ) : __( 'User registration', 'fieldwren' ), $ok ? sprintf( __( 'User #%d', 'fieldwren' ), (int) $res ) : $res->get_error_message() ); } /** @return int|\WP_Error|null */ private static function register( array $u, array $entry, array $values, $form_id ) { if ( ! empty( $u['skip_logged_in'] ) && ! empty( $entry['user_id'] ) ) { return null; } $email_key = $u['email_field'] ? $u['email_field'] : Helpers::first_email_field( $form_id ); $email = sanitize_email( self::val( $values, $email_key ) ); if ( ! $email || ! is_email( $email ) ) { return new \WP_Error( 'fwren_user_email', __( 'No valid email.', 'fieldwren' ) ); } if ( email_exists( $email ) ) { return new \WP_Error( 'fwren_user_exists', __( 'The email is already registered.', 'fieldwren' ) ); } $login = $u['username_field'] ? sanitize_user( self::val( $values, $u['username_field'] ), true ) : ''; if ( '' === $login || username_exists( $login ) ) { $base = sanitize_user( strstr( $email, '@', true ), true ); $base = '' !== $base ? $base : 'user'; $login = $base; $n = 1; while ( username_exists( $login ) ) { $login = $base . ( ++$n ); } } $pass = $u['password_field'] ? (string) ( $values[ $u['password_field'] ] ?? '' ) : ''; $generated = '' === $pass; if ( $generated ) { $pass = wp_generate_password( 20, true, true ); } $roles = Helpers::roles( ! apply_filters( 'fwren/user_registration/allow_admin_roles', false, $form_id ) ); $role = isset( $roles[ $u['role'] ] ) ? $u['role'] : get_option( 'default_role', 'subscriber' ); $ctx = array( 'form_id' => $form_id, 'schema' => Schema::get( $form_id ), 'values' => $values, 'entry' => $entry ); $data = array( 'user_login' => $login, 'user_email' => $email, 'user_pass' => $pass, 'first_name' => sanitize_text_field( self::val( $values, $u['first_name_field'], 'first' ) ), 'last_name' => sanitize_text_field( self::val( $values, $u['last_name_field'], 'last' ) ), 'role' => $role, ); $display = '' !== trim( (string) $u['display_name'] ) ? sanitize_text_field( Smartcodes::parse( (string) $u['display_name'], $ctx, 'text' ) ) : trim( $data['first_name'] . ' ' . $data['last_name'] ); if ( '' !== $display ) { $data['display_name'] = $display; } $data = apply_filters( 'fwren/user_registration/userdata', $data, $entry, $values, $form_id ); $uid = wp_insert_user( $data ); if ( is_wp_error( $uid ) ) { return $uid; } $uid = (int) $uid; self::meta( $uid, $u, $ctx, $values ); update_user_meta( $uid, '_fwren_registered_by', array( 'form' => (int) $form_id, 'entry' => (int) ( $entry['id'] ?? 0 ) ) ); if ( ! empty( $entry['id'] ) ) { Entries::update( (int) $entry['id'], array( 'user_id' => $uid ) ); Entries::add_meta( (int) $entry['id'], '_user_id', $uid, $form_id ); } $notify = in_array( $u['notification'], array( 'both', 'user', 'admin', 'none' ), true ) ? $u['notification'] : 'both'; if ( $generated && 'none' === $notify ) { $notify = 'user'; } elseif ( $generated && 'admin' === $notify ) { $notify = 'both'; } if ( 'none' !== $notify ) { wp_new_user_notification( $uid, null, $notify ); } if ( ! empty( $u['auto_login'] ) && self::$live && 0 === get_current_user_id() && ! wp_doing_cron() ) { wp_set_current_user( $uid ); wp_set_auth_cookie( $uid, true, is_ssl() ); $user = get_userdata( $uid ); do_action( 'wp_login', $user->user_login, $user ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals -- Core hook. } do_action( 'fwren/user_registration/registered', $uid, $entry, $values, $form_id ); return $uid; } /** @return int|\WP_Error|null */ private static function update( array $u, array $entry, array $values, $form_id ) { $uid = (int) ( $entry['user_id'] ?? 0 ); if ( ! $uid || ! get_userdata( $uid ) ) { return new \WP_Error( 'fwren_user_none', __( 'The entry has no logged-in user.', 'fieldwren' ) ); } $ctx = array( 'form_id' => $form_id, 'schema' => Schema::get( $form_id ), 'values' => $values, 'entry' => $entry ); $data = array( 'ID' => $uid ); $email_key = $u['email_field']; $email = $email_key ? sanitize_email( self::val( $values, $email_key ) ) : ''; if ( $email && is_email( $email ) ) { $owner = email_exists( $email ); if ( ! $owner || (int) $owner === $uid ) { $data['user_email'] = $email; } } if ( $u['first_name_field'] && '' !== self::val( $values, $u['first_name_field'], 'first' ) ) { $data['first_name'] = sanitize_text_field( self::val( $values, $u['first_name_field'], 'first' ) ); } if ( $u['last_name_field'] && '' !== self::val( $values, $u['last_name_field'], 'last' ) ) { $data['last_name'] = sanitize_text_field( self::val( $values, $u['last_name_field'], 'last' ) ); } if ( '' !== trim( (string) $u['display_name'] ) ) { $dn = sanitize_text_field( Smartcodes::parse( (string) $u['display_name'], $ctx, 'text' ) ); if ( '' !== $dn ) { $data['display_name'] = $dn; } } if ( $u['password_field'] && '' !== (string) ( $values[ $u['password_field'] ] ?? '' ) ) { $data['user_pass'] = (string) $values[ $u['password_field'] ]; } $data = apply_filters( 'fwren/user_registration/update_userdata', $data, $entry, $values, $form_id ); $res = wp_update_user( $data ); if ( is_wp_error( $res ) ) { return $res; } self::meta( $uid, $u, $ctx, $values ); do_action( 'fwren/user_registration/updated', $uid, $entry, $values, $form_id ); return $uid; } /** User meta map. */ private static function meta( $uid, array $u, array $ctx, array $values ) { foreach ( (array) $u['meta'] as $m ) { $key = sanitize_key( (string) ( $m['key'] ?? '' ) ); if ( '' === $key || self::forbidden_meta( $key ) ) { continue; } $tpl = trim( (string) ( $m['value'] ?? '' ) ); if ( preg_match( '/^\{inputs\.([a-z0-9_]+)\}$/i', $tpl, $mm ) && isset( $values[ $mm[1] ] ) && is_array( $values[ $mm[1] ] ) ) { $value = $values[ $mm[1] ]; } else { $value = sanitize_text_field( Smartcodes::parse( $tpl, $ctx, 'text' ) ); } update_user_meta( $uid, $key, wp_slash( $value ) ); } } /* ------------------------------------------------------------------ * * Admin * ------------------------------------------------------------------ */ /** Per-form tab. */ public static function tab( $tabs, $form_id = 0 ) { $tabs['user_registration'] = __( 'User registration', 'fieldwren' ); return $tabs; } /** Tab content. */ public static function render_tab( $form_id, $settings ) { $u = $settings['user_registration']; $n = 'fwren[user_registration]'; $texts = Helpers::types( array( 'text', 'name', 'hidden' ) ); echo ''; Helpers::row_toggle( $n . '[enabled]', ! empty( $u['enabled'] ), __( 'Enable', 'fieldwren' ) ); Helpers::row_select( $n . '[mode]', $u['mode'], __( 'Action', 'fieldwren' ), array( 'register' => __( 'Register a new user', 'fieldwren' ), 'update' => __( 'Update the logged-in user’s profile', 'fieldwren' ) ) ); Helpers::row_field( $n . '[email_field]', $form_id, $u['email_field'], __( 'Email', 'fieldwren' ), Helpers::types( array( 'email' ) ), __( 'Empty: the first email field.', 'fieldwren' ) ); Helpers::row_field( $n . '[username_field]', $form_id, $u['username_field'], __( 'Username', 'fieldwren' ), $texts, __( 'Empty: made from the email address. Not changed in update mode.', 'fieldwren' ) ); Helpers::row_field( $n . '[password_field]', $form_id, $u['password_field'], __( 'Password', 'fieldwren' ), Helpers::types( array( 'password' ) ), __( 'Empty: a password is generated and the user gets a “set your password” email.', 'fieldwren' ) ); Helpers::row_field( $n . '[first_name_field]', $form_id, $u['first_name_field'], __( 'First name', 'fieldwren' ), $texts, __( 'A Name field gives its first part.', 'fieldwren' ) ); Helpers::row_field( $n . '[last_name_field]', $form_id, $u['last_name_field'], __( 'Last name', 'fieldwren' ), $texts, __( 'A Name field gives its last part.', 'fieldwren' ) ); Helpers::row_text( $n . '[display_name]', $u['display_name'], __( 'Display name', 'fieldwren' ), __( 'Smartcodes, e.g. {inputs.names}. Empty: first + last name.', 'fieldwren' ) ); Helpers::row_select( $n . '[role]', $u['role'], __( 'Role (register)', 'fieldwren' ), Helpers::roles() ); Helpers::row_select( $n . '[notification]', $u['notification'], __( 'New user email', 'fieldwren' ), array( 'both' => __( 'To the user and the admin', 'fieldwren' ), 'user' => __( 'To the user', 'fieldwren' ), 'admin' => __( 'To the admin', 'fieldwren' ), 'none' => __( 'None', 'fieldwren' ), ) ); Helpers::row_toggle( $n . '[auto_login]', ! empty( $u['auto_login'] ), __( 'Log the user in after registering', 'fieldwren' ), __( 'Only when no opt-in / approval / payment gate delays the registration.', 'fieldwren' ) ); Helpers::row_toggle( $n . '[skip_logged_in]', ! empty( $u['skip_logged_in'] ), __( 'Skip registration for logged-in visitors', 'fieldwren' ) ); Helpers::row_text( $n . '[msg_email_exists]', $u['msg_email_exists'], __( 'Email taken message', 'fieldwren' ) ); Helpers::row_text( $n . '[msg_user_exists]', $u['msg_user_exists'], __( 'Username taken message', 'fieldwren' ) ); Helpers::row_text( $n . '[msg_login]', $u['msg_login'], __( 'Login required message (update)', 'fieldwren' ) ); echo ''; } /** Clean meta rows. */ public static function save_tab( $form_id, $post ) { if ( ! current_user_can( 'fwren_manage_forms' ) ) { return; } $in = Helpers::posted( (array) $post, 'user_registration' ); $cur = Form::settings( $form_id )['user_registration']; $out = $cur; foreach ( array( 'mode', 'email_field', 'username_field', 'password_field', 'first_name_field', 'last_name_field', 'role', 'notification' ) as $k ) { if ( isset( $in[ $k ] ) ) { $out[ $k ] = sanitize_key( (string) $in[ $k ] ); } } foreach ( array( 'display_name', 'msg_email_exists', 'msg_user_exists', 'msg_login' ) as $k ) { if ( isset( $in[ $k ] ) ) { $out[ $k ] = Helpers::text( $in[ $k ] ); } } foreach ( array( 'enabled', 'auto_login', 'skip_logged_in' ) as $k ) { $out[ $k ] = Helpers::on( $in[ $k ] ?? '' ); } $out['mode'] = 'update' === $out['mode'] ? 'update' : 'register'; $out['meta'] = array(); foreach ( (array) ( $in['meta'] ?? array() ) as $m ) { if ( is_array( $m ) && '' !== trim( (string) ( $m['key'] ?? '' ) ) && ! self::forbidden_meta( sanitize_key( $m['key'] ) ) ) { $out['meta'][] = array( 'key' => sanitize_key( $m['key'] ), 'value' => Helpers::text( $m['value'] ?? '' ) ); } } Helpers::save_setting( $form_id, 'user_registration', $out ); } /** Registered user in the entry sidebar. */ public static function entry_sidebar( $entry ) { if ( empty( $entry['id'] ) ) { return; } $uid = (int) Entries::get_meta( (int) $entry['id'], '_user_id' ); $user = $uid ? get_userdata( $uid ) : null; if ( ! $user ) { return; } echo '

' . esc_html__( 'Registered user', 'fieldwren' ) . '

'; echo current_user_can( 'edit_user', $uid ) ? '' . esc_html( $user->display_name ) . '' : esc_html( $user->display_name ); echo ' (' . esc_html( $user->user_login ) . ')

'; } }