Skip to content

Multisite: Introduce action hooks for user blog membership changes. #11616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SainathPoojary wants to merge 1 commit into
base: trunk
Choose a base branch
from
+35 −0
Open

Multisite: Introduce action hooks for user blog membership changes. #11616

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions src/wp-includes/ms-functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ function get_blog_post( $blog_id, $post_id ) {
* Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.
*
* @since MU (3.0.0)
* @since 7.0.0 The {@see 'added_user_to_blog'} action hook was added.
*
* @param int $blog_id ID of the blog the user is being added to.
* @param int $user_id ID of the user being added.
Expand Down Expand Up @@ -214,6 +215,17 @@ function add_user_to_blog( $blog_id, $user_id, $role ) {
clean_user_cache( $user_id );
wp_cache_delete( $blog_id . '_user_count', 'blog-details' );

/**
* Fires immediately after a user is added to a site, and after the user cache has been cleaned.
*
* @since 7.0.0
*
* @param int $user_id User ID.
* @param string $role User role.
* @param int $blog_id Blog ID.
*/
do_action( 'added_user_to_blog', $user_id, $role, $blog_id );

restore_current_blog();

return true;
Expand All @@ -229,6 +241,7 @@ function add_user_to_blog( $blog_id, $user_id, $role ) {
* reassign the user's blog posts to another user upon removal.
*
* @since MU (3.0.0)
* @since 7.0.0 The {@see 'removed_user_from_blog'} action hook was added.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
Expand Down Expand Up @@ -310,6 +323,17 @@ function remove_user_from_blog( $user_id, $blog_id = 0, $reassign = 0 ) {
}

clean_user_cache( $user_id );

/**
* Fires after a user is removed from a site.
*
* @since 7.0.0
*
* @param int $user_id ID of the user being removed.
* @param int $blog_id ID of the blog the user was removed from.
*/
do_action( 'removed_user_from_blog', $user_id, $blog_id );

restore_current_blog();

return true;
Expand Down Expand Up @@ -2301,6 +2325,7 @@ function add_existing_user_to_blog( $details = false ) {
* is specifically hooked into the {@see 'wpmu_activate_user'} action.
*
* @since MU (3.0.0)
* @since 7.0.0 The {@see 'added_new_user'} action hook was added.
*
* @see add_user_to_blog()
*
Expand All @@ -2323,6 +2348,16 @@ function add_new_user_to_blog(

if ( ! is_wp_error( $result ) ) {
update_user_meta( $user_id, 'primary_blog', $blog_id );

/**
* Fires immediately after a new user is added to a site.
*
* @since 7.0.0
*
* @param int $user_id User ID.
* @param int $blog_id Blog ID.
*/
do_action( 'added_new_user', $user_id, $blog_id );
}
}
}
Expand Down
Loading