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

16/01
Tue
weather - icon
Rain
6°C
17/01
Wed
weather - icon
Rain
5°C
18/01
Thu
weather - icon
Clear
3°C
19/01
Fri
weather - icon
Clouds
7°C
20/01
Sat
weather - icon
Rain
7°C
21/01
Sun
weather - icon
Clear
6°C
22/01
Mon
weather - icon
Snow
4°C

Powered by OpenWeatherMap | by Phee

RSS Laracasts

  • Continuous Integration 15/01/2018
    Let's set up a continuous integration server with Travis CI. This way, we can automate the process of building and testing our project each time a new commit is made, or a PR is presented.
    Jeffrey Way
  • Merging and Tweaking a Large PR 12/01/2018
    Not all PRs amount to simple formatting and bug fixes. Often, you'll receive significant feature additions that affect dozens of files. In these cases, it's important to fully review, test, and even tweak the code before merging it into your codebase. Let's work through that process together.
    Jeffrey Way
  • Test Clarity 11/01/2018
    We all recognize that clarity is vital for any project, but often this clarity is set aside when preparing our tests. Be careful. When you return to that confusing test six month from now, you'll kick yourself for having to spend so much time re-learning how it works. In this episode, we'll discuss a few […]
    Jeffrey Way
  • Licensing and Code of Conducts 10/01/2018
    Yeah, yeah, this one will be a little on the mundane side. Nonetheless, it needs to be addressed. Most successful open source projects will include, within the root of the project, the following three documents; LICENSE, CODE_OF_CONDUCT, and CONTRIBUTING. Let's do a quick overview in this episode.
    Jeffrey Way
  • Feature: Reducing Reputation 10/01/2018
    At the moment, any user can "game the system" by rapidly creating and deleting threads or replies. We must ensure that, if a user's thread or reply is deleted, we reduce their reputation to match.
    Jeffrey Way

Recent Posts

Contact