Use email only for login/registration

[KipchirchirIan]

I need to use just the email for login/registration. What are the steps to configure or setup this?

[kenjis]

I've not tried, but how about this?

1. remove username in the config.
   

   shield/src/Config/Auth.php

   Lines 216 to 223 in 44901bc

   	* Valid login fields
   	* --------------------------------------------------------------------
   	* Fields that are available to be used as credentials for login.
   	*/
   	public array $validFields = [
   	'email',
   	'username',
   	];

2. remove username in the HTML form in src/Views/register.php.
3. remove username validation rule in RegisterController.
4. customize the login form.

[KipchirchirIan]

Although I marked this as the answer, but the steps above is just half of it and won't work. In addition to what @lonnieezell has written below, what I had to do for it to completely work is:

1. After copying the RegisterController.php, update the routes by passing the except option:

service('auth')->routes($routes, ['except' => ['register']]);

2. Add routes for your customized controller

$routes->post('register', '\App\Controllers\Auth\RegisterController::registerAction');

I've only focused on the important parts based on the question.

[MGatner]

Your way of routing will work fine but also just to note: you could just set the new controller in your AuthRoutes.php Config file! That's what it's there for.

[lonnieezell]

Yes, the steps that @kenjis provided will work for you. You should probably copy the views and controller to your application, though.

[genio]

This all seems like quite the amount of work to shunt onto the user. Requiring the user to copy-paste the RegisterController and force the username to be null seems overkill.
Could that could be more easily done by removing it from the getRegistrationRules() if the Auth config contains $registrationType = 'emailOnly'; or some such other simple thing?

[datamweb]

This all seems like quite the amount of work to shunt onto the user. Requiring the user to copy-paste the RegisterController and force the username to be null seems overkill.

There is no need for this. Proceed as follows.

Copy vendor\codeigniter4\shield\src\Views\register.php to app\Views\register.php

Delete this code:

                    <!-- Username -->
                    <div class="form-floating mb-4">
                        <input type="text" class="form-control" id="floatingUsernameInput" name="username" inputmode="text" autocomplete="username" placeholder="<?= lang('Auth.username') ?>" value="<?= old('username') ?>" required>
                        <label for="floatingUsernameInput"><?= lang('Auth.username') ?></label>
                    </div>

Edit app\Config\Auth.php

    public array $views = [
        'register'                    => '\App\Views\register',

    ];

Add app/Config/Validation.php

    public $registration = [

        'email' => [
            'label' => 'Auth.email',
            'rules' => [
                'required',
                'max_length[254]',
                'valid_email',
                'is_unique[auth_identities.secret]',
            ],
        ],
        'password' => [
            'label' => 'Auth.password',
            'rules' => 'required|max_byte[72]|strong_password[]',
            'errors' => [
                'max_byte' => 'Auth.errorPasswordTooLongBytes'
            ]
        ],
        'password_confirm' => [
            'label' => 'Auth.passwordConfirm',
            'rules' => 'required|matches[password]',
        ],
    ];

Could that could be more easily done by removing it from the getRegistrationRules() if the Auth config contains $registrationType = 'emailOnly'; or some such other simple thing?

I think ordering is simple enough and we don't need to add a new option.

[genio]

Thank you! That reply was very helpful. I was unaware of the ability to completely override the validation rules in the Validation config file.