auth_redirect_scheme

Filter Hook

Description

Filters the authentication redirect scheme.

Hook Information

File Location	`wp-includes/pluggable.php` View on GitHub
Hook Type	Filter
Line Number	`1225`

Hook Parameters

Type	Name	Description
`string`	`$scheme`	Authentication redirect scheme. Default empty.

Usage Examples

Basic Usage

<?php
// Hook into auth_redirect_scheme
add_filter('auth_redirect_scheme', 'my_custom_filter', 10, 1);

function my_custom_filter($scheme) {
    // Your custom filtering logic here
    return $scheme;
}

Source Code Context

wp-includes/pluggable.php:1225 - How this hook is used in WordPress core

<?php
1220  		 *
1221  		 * @since 2.9.0
1222  		 *
1223  		 * @param string $scheme Authentication redirect scheme. Default empty.
1224  		 */
1225  		$scheme = apply_filters( 'auth_redirect_scheme', '' );
1226  
1227  		$user_id = wp_validate_auth_cookie( '', $scheme );
1228  		if ( $user_id ) {
1229  			/**
1230  			 * Fires before the authentication redirect.

PHP Documentation

<?php
/**
		 * Filters the authentication redirect scheme.
		 *
		 * @since 2.9.0
		 *
		 * @param string $scheme Authentication redirect scheme. Default empty.
		 */

Quick Info

Hook Type: Filter
Parameters: 1
File: wp-includes/pluggable.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.