Codex

Function Reference/remove user from blog

This page is marked as incomplete. You can help Codex by expanding it.

Contents

Description

Removes a user from a blog.

Accepts an optional $reassign parameter, if you want to reassign the user's blog posts to another user upon removal.

Usage

<?php remove_user_from_blog($user_id, $blog_id, $reassign = ); ?>

Parameters

$user_id
(integer) (required) ID of user to remove
Default: None
$blog_id
(integer) (required) ID of blog to remove user from
Default: None
$reassign
(string) (optional) a user to whom to reassign the removed user's posts
Default: empty string

Return Value

(WP_Error object|boolean) 
WP_Error object on failure, True on success

Examples 



  Notes 


Use the 'remove_user_from_blog' action to fire an event when users are removed from a blog.



  Change Log 


Since: MU



  Source File 


remove_user_from_blog() is located in wp-includes/ms-functions.php



  Related 


 



See also index of Function Reference and index of Template Tags.





Retrieved from "http://codex.wordpress.org/Function_Reference/remove_user_from_blog"

							
		

		

			
						
			

			
Codex Resources