Laravel 5 – login with username

  14/08/2015

With fresh Laravel 5 installation, you have authentication/register system out of the box ready for you (link).

By the default, login uses registered e-mail and password credentials. If you want to use username instead of e-mail, it’s no big deal. This modification works only for provided implemented Auth, and not for custom authentication.

After you install Laravel 5, you will find existing migration for users table in folder /migrations. To add username column, we need to modify it to look something like this, and that column needs to be unique same like email is. If you need more columns you can add them according to your needs. If there is no users table migration, you can easily create one with artisan: php artisan make:migration –create users create_users_table

Schema::create('users', function(Blueprint $table)
{
	$table->increments('id');
	$table->string('username')->unique();
	$table->string('email')->unique();
	$table->string('password', 60);
	$table->rememberToken();
	$table->timestamps();
});

Now you can run artisan and load migration file with php artisan migrate.

 

Next, we need to add username field in registration form, stored in /resources/views/auth/register.blade.php. If you use the default template, new input field should look something like:



 

Now let’s modify fillable protected variable in User model stored under /App/User.php, so it can be passed in array to the model itself (mass assignment). If you have more custom register fields, don’t forget to add them all here:

protected $fillable = ['username', 'email', 'password'];

 

User registration now goes through Registrar validator before creating new user. So, we have to change it to look like this (again, if you use more custom fields dont forget to add them here if they’re mandatory for registration and want them saved in database). File is located in /App/Services/Registrar.php.

namespace App\Services;

use App\User;
use Validator;
use Illuminate\Contracts\Auth\Registrar as RegistrarContract;

class Registrar implements RegistrarContract {

	/**
	 * Get a validator for an incoming registration request.
	 *
	 * @param  array  $data
	 * @return \Illuminate\Contracts\Validation\Validator
	 */
	public function validator(array $data)
	{
		return Validator::make($data, [
			'username' => 'required|max:255|unique:users',
			'email' => 'required|email|max:255|unique:users',
			'password' => 'required|confirmed|min:6',
		]);
	}

	/**
	 * Create a new user instance after a valid registration.
	 *
	 * @param  array  $data
	 * @return User
	 */
	public function create(array $data)
	{
		return User::create([
			'username' => $data['username'],
			'email' => $data['email'],
			'password' => bcrypt($data['password']),
		]);
	}

}

 

Now we have almost everything prepared. Login form has to be changed, so it asks for username instead of e-mail. In login blade file stored under /resources/views/auth/login.blade.php, modify it to look like this:

Before



After



 

One more thing and we’re done! Now, when we submit the form it sends the data to the Auth controller which uses implemented method postLogin(). We need to override it by adding the same method in /App/Http/Controllers/Auth/AuthController.php. We’re overriding the credentials check not to look for email, but username for validation. Just add this method, or modify it more if you need. I left the comment where you can put session flash_message commonly used in Laravel 5.


	/**
	 * Overriding postLogin() from Auth/AuthenticatesAndRegistersUsers
	 */
	public function postLogin(Request $request)
	{
		$this->validate($request, [
			'username' => 'required', 'password' => 'required',
		]);

		$credentials = $request->only('username', 'password');

		if ($this->auth->attempt($credentials, $request->has('remember')))
		{
			// You can add session flash_message here if you need
			return redirect()->intended($this->redirectPath());
		}

		return redirect($this->loginPath())
			->withInput($request->only('username', 'remember'))
			->withErrors([
				'username' => $this->getFailedLoginMessage(),
			]);
	}

 

Try it out. I hope this article was of help to someone 🙂


Weather Forecast – Belgrade

20/05
Mon
weather - icon
Clear
22°C
21/05
Tue
weather - icon
Rain
21°C
22/05
Wed
weather - icon
Rain
21°C
23/05
Thu
weather - icon
Rain
20°C
24/05
Fri
weather - icon
Rain
17°C
25/05
Sat
weather - icon
Clear
20°C
26/05
Sun
weather - icon
Clouds
22°C

Powered by OpenWeatherMap | by Phee

RSS Laracasts

  • Storing Jobs in the Database 17/05/2019
    If you don't have much control over the environment your application runs in, you might consider using the database queue connection. With this approach, rather than using Redis or Memcached, your jobs will instead be stored and fetched from the database.
    Jeffrey Way
  • Multiple Queues and Workers 14/05/2019
    In this episode, we'll review how to create multiple queue stacks and workers, as well as when and why you might do so.
    Jeffrey Way
  • A UI For Your Redis-Backed Queues 13/05/2019
    When working with queues, it can often prove difficult to see what's happening. For example, how many jobs ran in the last hour? Did any of them fail? How many workers are running? And what about only the jobs that match a particular tag? Let's solve this by installing Laravel Horizon, a dashboard for your […]
    Jeffrey Way
  • Failed Jobs 10/05/2019
    So far, we've reviewed the "happy path" for a job, but what if an error or exception is thrown along the way? If you don't specify a maximum number of tries for your queue worker, the job will retry over and over again. In this episode, we'll learn how to fix this by creating a […]
    Jeffrey Way
  • Dispatchable 09/05/2019
    We've learned how to use the global dispatch() function, but there's an alternative option you should consider as well. By default, each Job class includes a Dispatchable trait.
    Jeffrey Way

Contact