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

29/05
Mon
weather - icon
Clear
26°C
30/05
Tue
weather - icon
Clear
25°C
31/05
Wed
weather - icon
Clear
27°C
01/06
Thu
weather - icon
Rain
27°C
02/06
Fri
weather - icon
Rain
24°C
03/06
Sat
weather - icon
Rain
27°C
04/06
Sun
weather - icon
Rain
25°C

Powered by OpenWeatherMap | by Phee

RSS Laracasts

  • Notification Fakes in a Nutshell 25/05/2017
    If you check our ThreadTest class, you'll notice that we don't yet have a test that asserts that, each time a reply is added to a thread, a notification should be prepared for all thread subscribers. Let's use a notification fake to test this functionality. Review the source code for this episode on GitHub.
    Jeffrey Way
  • Refactoring for the Better or Worse? 25/05/2017
    Let's perform a round of refactoring in this episode. But there's a twist! At the conclusion of the refactor, we'll take a very important step. That step is to ask ourselves, "Is the code better as a result of this refactor? Or did we make it more confusing?"
    Jeffrey Way
  • Thread Subscriptions: Part 5 24/05/2017
    We can finally switch over to the client-side, and begin constructing a user-notifications Vue component that will be responsible for fetching all relevant notifications and rendering them within a "bell" dropdown panel. View the source code for this episode on GitHub.
    Jeffrey Way
  • Test Refactoring 24/05/2017
    Let's take a few moments to refactor the tests in our NotificationsTest class. A handful of tweaks should make this file far more simple to read and understand six months from now.
    Jeffrey Way
  • Thread Subscriptions: Part 4 23/05/2017
    Now that a thread exposes the behavior that it can be subscribed to, we can move on to preparing all relevant user notifications each time the thread receives a new reply. To allow for this, we'll leverage Laravel's native notification functionality.
    Jeffrey Way

Contact