WP_Roles::for_site() WordPress Method

The WP_Roles::for_site() method is a static member function of the WP_Roles class. It returns an array of roles and their capabilities for the current site.

WP_Roles::for_site( int $site_id = null ) #

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


Parameters

$site_id

(int)(Optional)Site ID to initialize roles for. Default is the current site.

Default value: null


Top ↑

Source

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

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

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

		$this->role_key = $wpdb->get_blog_prefix( $this->site_id ) . 'user_roles';

		if ( ! empty( $this->roles ) && ! $this->use_db ) {
			return;
		}

		$this->roles = $this->get_roles_data();

		$this->init_roles();
	}


Top ↑

Changelog

Changelog
VersionDescription
4.9.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.