pre_get_blogs_of_user WordPress Filter Hook
The pre_get_blogs_of_user hook is called before the WordPress Get Blogs Of User API call. It allows for modification of the query that is used to fetch the blogs of a user.
apply_filters( 'pre_get_blogs_of_user', null|object[] $sites , int $user_id , bool $all ) #
Filters the list of a user’s sites before it is populated.
Description
Returning a non-null value from the filter will effectively short circuit get_blogs_of_user(), returning that value instead.
Parameters
- $sites
(null|object[])An array of site objects of which the user is a member.
- $user_id
(int)User ID.
- $all
(bool)Whether the returned array should contain all sites, including those marked 'deleted', 'archived', or 'spam'. Default false.
Source
File: wp-includes/user.php
Changelog
| Version | Description |
|---|---|
| 4.6.0 | Introduced. |