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

22/09
Sat
weather - icon
Rain
29°C
23/09
Sun
weather - icon
Clear
21°C
24/09
Mon
weather - icon
Rain
18°C
25/09
Tue
weather - icon
Clear
14°C
26/09
Wed
weather - icon
Rain
15°C
27/09
Thu
weather - icon
Clear
16°C
28/09
Fri
weather - icon
Rain
19°C

Powered by OpenWeatherMap | by Phee

RSS Laracasts

  • Mentionable Usernames with TDD 22/09/2018
    For the next version of the Laracasts forum, we offer a small feature that provides @username autocompletion when writing a new reply. To populate this list of usernames, we reference the conversation owner, every person who has left a reply, and all usernames who have been mentioned within those replies. Let me show you how […]
    Jeffrey Way
  • Many to Many Polymorphic Relations 19/09/2018
    We've finally made it to the most intimidating of Eloquent relationships: many to many polymorphic. Don't worry; it's far simpler to understand than you might initially think. In this lesson, we'll construct a standard many-to-many relationship: a user can "like" a post. Then, we'll throw a wrench into the mix. What if a user can […]
    Jeffrey Way
  • Smaller Additions 18/09/2018
    Let's review a few smaller - yet still important - updates to Laravel 5.7. You'll learn about a new base directory for your JavaScript and CSS assets, callable action url generation, and guest authorizations.
    Jeffrey Way
  • Improved Artisan Command Testing 14/09/2018
    Laravel 5.7 ships with improved support for testing your Artisan commands. You can now leverage the helpful expectsQuestion() and expectsOutput() methods to ensure that your commands function exactly as expected.
    Jeffrey Way
  • Count Up 13/09/2018
    Let's review another real-life example. We need to construct a Vue component that counts from 0 to a given number very quickly. However, this counting should not begin until the element is within the user's viewport. View the source code for this episode on GitHub.
    Jeffrey Way

Contact