How to use login_body_class filter in WordPress

login_body_class filter

Filters the login page body classes.

To use the login_body_class filter, first, you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_login_body_class_defaults which takes 2 parameters and we registered using add_filter. The first parameter login_body_class is the name of the hook, The second parameter weplugins_modify_login_body_class_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove the login_body_class filter.

Parameters

Below are the 2 parameters required to use this hook.

• $classes : (string[]) An array of body classes.
• $action : (string) The action that brought the visitor to the login page.

Live Example 1: Adding a Custom Class to the Login Body

Below is an example of how you can use this hook to add a custom class to the login body.

	add_filter( 'login_body_class', 'weplugins_login_classes' );
	function weplugins_login_classes( $classes ) {
	    $classes[] = 'my-login-class';
	    return $classes;
	}
	

Live Example 2: Modifying Default Login Body Classes

Below is an example of how you can modify the default login body classes.

	function weplugins_modify_login_body_class_defaults($classes, $action) { 
	    // Update the $classes variable according to your website requirements and return this variable. You can modify the $classes variable conditionally too if you want.

	    return $classes; 
	}
	// add the filter
	add_filter( "login_body_class", "weplugins_modify_login_body_class_defaults", 10, 2 );
	

Live Example 3: Removing a Hook Callback

To remove a hook callback, use the example below. Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

	remove_filter( "login_body_class", "weplugins_modify_login_body_class_defaults", 10, 2 );
	

Contact Us

If you’re having any trouble using this hook or need customization, please contact us and we’d be happy to assist you.