WordPress Hooks Explorer 🪝

Filter hook 'can_add_user_to_blog'

in WP Core File wp-includes/ms-functions.php at line 173

Description

Filters whether a user should be added to a site.

Occurrences

Filename Line Number
wp-includes/ms-functions.php 173

Parameters

Type Name Description
true|WP_Error $retval True if the user should be added to the site, error object otherwise.
int $user_id User ID.
string $role User role.
int $blog_id Site ID.

PHP Doc

/**
	 * Filters whether a user should be added to a site.
	 *
	 * @since 4.9.0
	 *
	 * @param true|WP_Error $retval  True if the user should be added to the site, error
	 *                               object otherwise.
	 * @param int           $user_id User ID.
	 * @param string        $role    User role.
	 * @param int           $blog_id Site ID.
	 */