WP_User::for_site( int $site_id = 0 )

Parameters

$site_idintoptional

Site ID to initialize user capabilities for. Default is the current site.Default: 0

Uses · 4

• absint()Converts a value to non-negative integer.
• get_current_blog_id()Retrieves the current site ID.
• WP_User::get_caps_data()Gets the available user capabilities data.
• WP_User::get_role_caps()Retrieves all of the capabilities of the user's roles, and merges them with individual user capabilities.

Used by · 2

• WP_User::for_blog()Sets the site to operate on. Defaults to the current site.
• WP_User::init()Sets up object properties, including capabilities.

Source

View on Trac ↗View on GitHub ↗

873	public function for_site( $site_id = 0 ) {874		global $wpdb;875 876		if ( ! empty( $site_id ) ) {877			$this->site_id = absint( $site_id );878		} else {879			$this->site_id = get_current_blog_id();880		}881 882		$this->cap_key = $wpdb->get_blog_prefix( $this->site_id ) . 'capabilities';883 884		$this->caps = $this->get_caps_data();885 886		$this->get_role_caps();887	}

History

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 7.1.0 tag, from src/wp-includes/class-wp-user.php, 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.