Skip to content

docs: improve instructions for Customizing Login Identifier #895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 11, 2023
Merged

docs: improve instructions for Customizing Login Identifier #895

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 43 additions & 17 deletions docs/customization/login_identifier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,61 @@
# Customizing Login Identifier

If your application has a need to use something other than `email` or `username`, you may specify any valid column within the `users` table that you may have added. This allows you to easily use phone numbers, employee or school IDs, etc as the user identifier. You must implement the following steps to set this up:
If your application has a need to use something other than `email` or `username`, you may specify any valid column within the `users` table that you may have added. This allows you to easily use phone numbers, employee or school IDs, etc. as the user identifier. You must implement the following steps to set this up:

This only works with the Session authenticator.

1. Create a [migration](http://codeigniter.com/user_guide/dbmgmt/migration.html) that adds a new column to the `users` table.
2. Edit `app/Config/Auth.php` so that the new column you just created is within the `$validFields` array.
## Create Migration File

```php
public array $validFields = [
'employee_id'
];
```
Create a [migration](http://codeigniter.com/user_guide/dbmgmt/migration.html) that
adds a new column to the `users` table.

## Change $validFields

Edit `app/Config/Auth.php` so that the new column you just created is within the
`$validFields` array.

```php
public array $validFields = [
'employee_id'
];
```

If you have multiple login forms on your site that use different credentials, you
must have all of the valid identifying fields in the array.

If you have multiple login forms on your site that use different credentials, you must have all of the valid identifying fields in the array.
```php
public array $validFields = [
'email',
'employee_id'
];
```

## Update Validation Rules

!!! warning

This is very important for security.

You must write new **Validation Rules** and then set them using the
[Customizing Validation Rules](./validation_rules.md#login) description.

## Customize Login View

1. Change the `login` view file in the `app/Config/Auth.php` file.

```php
public array $validFields = [
'email',
'employee_id'
public array $views = [
'login' => '\App\Views\Shield\login',
// ...
];
```
!!! warning

It is very important for security that if you add a new column for identifier, you must write a new **Validation Rules** and then set it using the [Customizing Validation Rules](./validation_rules.md) description.

3. Edit the login form to change the name of the default `email` input to the new field name.
2. Copy file `vendor\codeigniter4\shield\src\Views\login.php` to `app\Views\Shield\login.php`.
3. Customize the login form to change the name of the default `email` input to the new field name.

```php
<!-- Email -->
<div class="mb-2">
<input type="text" class="form-control" name="employee_id" autocomplete="new-employee-id" placeholder="12345" value="<?= old('employee_id') ?>" required />
<input type="text" class="form-control" name="employee_id" autocomplete="new-employee-id" placeholder="12345" value="<?= old('employee_id') ?>" required>
</div>
```