wppaste
WordPress

apply_filters( 'can_add_user_to_blog', true|WP_Error $retval, int $user_id, string $role, int $blog_id )

Since
4.9.0
Filters whether a user should be added to a site.

Compatibility

WordPress
since 4.9.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$retvaltrue|WP_Error
True if the user should be added to the site, error object otherwise.
$user_idint
User ID.
$rolestring
User role.
$blog_idint
Site ID.

Where this hook fires · 1

  • wp-includes/ms-functions.php:173add_user_to_blog()

Source code

	 * @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.	 */	$can_add_user = apply_filters( 'can_add_user_to_blog', true, $user_id, $role, $blog_id ); 	if ( true !== $can_add_user ) {		restore_current_blog(); 		if ( is_wp_error( $can_add_user ) ) {			return $can_add_user;

Changelog

Introduced in 4.9.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.7.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.