WP_User::for_site( int $site_id = '' )

Sets the site to operate on. Defaults to the current site.

Parameters

$site_id

(Optional) Site ID to initialize user capabilities for. Default is the current site.

Default value: ''

Source

File: wp-includes/class-wp-user.php 

	public function for_site( $site_id = '' ) {
		global $wpdb;

		if ( ! empty( $site_id ) ) {
			$this->site_id = absint( $site_id );
		} else {
			$this->site_id = get_current_blog_id();
		}

		$this->cap_key = $wpdb->get_blog_prefix( $this->site_id ) . 'capabilities';

		$this->caps = $this->get_caps_data();

		$this->get_role_caps();
	}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/class-wp-user.php: WP_User::get_caps_data()

Gets the available user capabilities data.
wp-includes/class-wp-user.php: WP_User::get_role_caps()

Retrieves all of the capabilities of the user’s roles, and merges them with individual user capabilities.
wp-includes/class-wpdb.php: wpdb::get_blog_prefix()

Gets blog prefix.
wp-includes/load.php: get_current_blog_id()

Retrieve the current site ID.
wp-includes/functions.php: absint()

Converts a value to non-negative integer.

Used By

Used By
Used By Description
wp-includes/class-wp-user.php: WP_User::init()

Sets up object properties, including capabilities.
wp-includes/class-wp-user.php: WP_User::for_blog()

Sets the site to operate on. Defaults to the current site.

Changelog

Changelog
Version Description
4.9.0 Introduced.