Skip To Main Content

onLogin Server Action

The onLogin is function that performs a server action to login a user. It is part of the @faustwp/experimental-app-router package.


Here is an example action to login the user by providing credentials to login to the WordPress backend:

'use client'
import { onLogin } from '@faustwp/experimental-app-router';

<form action={onLogin}>
    <label htmlFor="usernameEmail">Username or Email</label>
    <input type="name" name="usernameEmail" />

    <label htmlFor="password">Password</label>
    <input type="password" name="password" />

  <button type="submit">Login</button>
Code language: JavaScript (javascript)

Technical Reference

onLogin(formData: FormData)

The onLogin server action accepts an instance of HTML FormData class that is automatically provided when you use a <form> action field.

If the form submission is successful, the server will populate the session with a cookie that is used to maintain the authentication status on. Users will logout by submitting an onLogout action or when their authentication token expires.

Additional Context