ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / beestk / sdx / wp-includes

<?php
/**
 * User API: WP_Roles class
 *
 * @package WordPress
 * @subpackage Users
 * @since 4.4.0
 */

/**
 * Core class used to implement a user roles API.
 *
 * The role option is simple, the structure is organized by role name that store
 * the name in value of the 'name' key. The capabilities are stored as an array
 * in the value of the 'capability' key.
 *
 *     array (
 *    		'rolename' => array (
 *    			'name' => 'rolename',
 *    			'capabilities' => array()
 *    		)
 *     )
 *
 * @since 2.0.0
 */
class WP_Roles {
	/**
	 * List of roles and capabilities.
	 *
	 * @since 2.0.0
	 * @var array
	 */
	public $roles;

/**
	 * List of the role objects.
	 *
	 * @since 2.0.0
	 * @var array
	 */
	public $role_objects = array();

/**
	 * List of role names.
	 *
	 * @since 2.0.0
	 * @var array
	 */
	public $role_names = array();

/**
	 * Option name for storing role list.
	 *
	 * @since 2.0.0
	 * @var string
	 */
	public $role_key;

/**
	 * Whether to use the database for retrieval and storage.
	 *
	 * @since 2.1.0
	 * @var bool
	 */
	public $use_db = true;

/**
	 * The site ID the roles are initialized for.
	 *
	 * @since 4.9.0
	 * @var int
	 */
	protected $site_id = 0;

/**
	 * Constructor
	 *
	 * @since 2.0.0
	 * @since 4.9.0 The $site_id argument was added.
	 *
	 * @global array $wp_user_roles Used to set the 'roles' property value.
	 *
	 * @param int $site_id Site ID to initialize roles for. Default is the current site.
	 */
	public function __construct( $site_id = null ) {
		global $wp_user_roles;

$this->use_db = empty( $wp_user_roles );

$this->for_site( $site_id );
	}

/**
	 * Make private/protected methods readable for backward compatibility.
	 *
	 * @since 4.0.0
	 *
	 * @param callable $name      Method to call.
	 * @param array    $arguments Arguments to pass when calling.
	 * @return mixed|false Return value of the callback, false otherwise.
	 */
	public function __call( $name, $arguments ) {
		if ( '_init' === $name ) {
			return call_user_func_array( array( $this, $name ), $arguments );
		}
		return false;
	}

/**
	 * Set up the object properties.
	 *
	 * The role key is set to the current prefix for the $wpdb object with
	 * 'user_roles' appended. If the $wp_user_roles global is set, then it will
	 * be used and the role option will not be updated or used.
	 *
	 * @since 2.1.0
	 * @deprecated 4.9.0 Use WP_Roles::for_site()
	 */
	protected function _init() {
		_deprecated_function( __METHOD__, '4.9.0', 'WP_Roles::for_site()' );

$this->for_site();
	}

/**
	 * Reinitialize the object
	 *
	 * Recreates the role objects. This is typically called only by switch_to_blog()
	 * after switching wpdb to a new site ID.
	 *
	 * @since 3.5.0
	 * @deprecated 4.7.0 Use WP_Roles::for_site()
	 */
	public function reinit() {
		_deprecated_function( __METHOD__, '4.7.0', 'WP_Roles::for_site()' );

$this->for_site();
	}

/**
	 * Add role name with capabilities to list.
	 *
	 * Updates the list of roles, if the role doesn't already exist.
	 *
	 * The capabilities are defined in the following format `array( 'read' => true );`
	 * To explicitly deny a role a capability you set the value for that capability to false.
	 *
	 * @since 2.0.0
	 *
	 * @param string $role Role name.
	 * @param string $display_name Role display name.
	 * @param array $capabilities List of role capabilities in the above format.
	 * @return WP_Role|void WP_Role object, if role is added.
	 */
	public function add_role( $role, $display_name, $capabilities = array() ) {
		if ( empty( $role ) || isset( $this->roles[ $role ] ) ) {
			return;
		}

$this->roles[$role] = array(
			'name' => $display_name,
			'capabilities' => $capabilities
			);
		if ( $this->use_db )
			update_option( $this->role_key, $this->roles );
		$this->role_objects[$role] = new WP_Role( $role, $capabilities );
		$this->role_names[$role] = $display_name;
		return $this->role_objects[$role];
	}

/**
	 * Remove role by name.
	 *
	 * @since 2.0.0
	 *
	 * @param string $role Role name.
	 */
	public function remove_role( $role ) {
		if ( ! isset( $this->role_objects[$role] ) )
			return;

unset( $this->role_objects[$role] );
		unset( $this->role_names[$role] );
		unset( $this->roles[$role] );

if ( $this->use_db )
			update_option( $this->role_key, $this->roles );

if ( get_option( 'default_role' ) == $role )
			update_option( 'default_role', 'subscriber' );
	}

/**
	 * Add capability to role.
	 *
	 * @since 2.0.0
	 *
	 * @param string $role Role name.
	 * @param string $cap Capability name.
	 * @param bool $grant Optional, default is true. Whether role is capable of performing capability.
	 */
	public function add_cap( $role, $cap, $grant = true ) {
		if ( ! isset( $this->roles[$role] ) )
			return;

$this->roles[$role]['capabilities'][$cap] = $grant;
		if ( $this->use_db )
			update_option( $this->role_key, $this->roles );
	}

/**
	 * Remove capability from role.
	 *
	 * @since 2.0.0
	 *
	 * @param string $role Role name.
	 * @param string $cap Capability name.
	 */
	public function remove_cap( $role, $cap ) {
		if ( ! isset( $this->roles[$role] ) )
			return;

unset( $this->roles[$role]['capabilities'][$cap] );
		if ( $this->use_db )
			update_option( $this->role_key, $this->roles );
	}

/**
	 * Retrieve role object by name.
	 *
	 * @since 2.0.0
	 *
	 * @param string $role Role name.
	 * @return WP_Role|null WP_Role object if found, null if the role does not exist.
	 */
	public function get_role( $role ) {
		if ( isset( $this->role_objects[$role] ) )
			return $this->role_objects[$role];
		else
			return null;
	}

/**
	 * Retrieve list of role names.
	 *
	 * @since 2.0.0
	 *
	 * @return array List of role names.
	 */
	public function get_names() {
		return $this->role_names;
	}

/**
	 * Whether role name is currently in the list of available roles.
	 *
	 * @since 2.0.0
	 *
	 * @param string $role Role name to look up.
	 * @return bool
	 */
	public function is_role( $role ) {
		return isset( $this->role_names[$role] );
	}

/**
	 * Initializes all of the available roles.
	 *
	 * @since 4.9.0
	 */
	public function init_roles() {
		if ( empty( $this->roles ) ) {
			return;
		}

$this->role_objects = array();
		$this->role_names =  array();
		foreach ( array_keys( $this->roles ) as $role ) {
			$this->role_objects[ $role ] = new WP_Role( $role, $this->roles[ $role ]['capabilities'] );
			$this->role_names[ $role ] = $this->roles[ $role ]['name'];
		}

/**
		 * After the roles have been initialized, allow plugins to add their own roles.
		 *
		 * @since 4.7.0
		 *
		 * @param WP_Roles $this A reference to the WP_Roles object.
		 */
		do_action( 'wp_roles_init', $this );
	}

/**
	 * Sets the site to operate on. Defaults to the current site.
	 *
	 * @since 4.9.0
	 *
	 * @global wpdb $wpdb WordPress database abstraction object.
	 *
	 * @param int $site_id Site ID to initialize roles for. Default is the current site.
	 */
	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();
	}

/**
	 * Gets the ID of the site for which roles are currently initialized.
	 *
	 * @since 4.9.0
	 *
	 * @return int Site ID.
	 */
	public function get_site_id() {
		return $this->site_id;
	}

/**
	 * Gets the available roles data.
	 *
	 * @since 4.9.0
	 *
	 * @global array $wp_user_roles Used to set the 'roles' property value.
	 *
	 * @return array Roles array.
	 */
	protected function get_roles_data() {
		global $wp_user_roles;

if ( ! empty( $wp_user_roles ) ) {
			return $wp_user_roles;
		}

if ( is_multisite() && $this->site_id != get_current_blog_id() ) {
			remove_action( 'switch_blog', 'wp_switch_roles_and_user', 1 );

$roles = get_blog_option( $this->site_id, $this->role_key, array() );

add_action( 'switch_blog', 'wp_switch_roles_and_user', 1, 2 );

return $roles;
		}

return get_option( $this->role_key, array() );
	}
}

[+] ..
[-] rss.php [open]
[-] shortcodes.php [open]
[-] class-wp-session-tokens.php [open]
[-] user.php [open]
[-] kses.php [open]
[-] default-constants.php [open]
[-] class-wp-widget.php [open]
[-] class-wp-oembed-controller.php [open]
[-] post-template.php [open]
[-] class-wp-metadata-lazyloader.php [open]
[-] feed-rss.php [open]
[-] class-wp-http-encoding.php [open]
[-] locale.php [open]
[-] class-wp-xmlrpc-server.php [open]
[-] template-loader.php [open]
[-] pluggable.php [open]
[+] SimplePie
[-] cache.php [open]
[-] spl-autoload-compat.php [open]
[-] cron.php [open]
[-] class-wp-feed-cache-transient.php [open]
[-] ms-load.php [open]
[-] ms-functions.php [open]
[-] class-simplepie.php [open]
[-] class-wp-term.php [open]
[-] class-IXR.php [open]
[-] meta.php [open]
[+] images
[-] default-filters.php [open]
[-] bookmark-template.php [open]
[-] class-wp-site.php [open]
[-] class-oembed.php [open]
[-] class-wp-customize-section.php [open]
[+] css
[-] embed.php [open]
[-] class-wp-http-streams.php [open]
[-] class-walker-page.php [open]
[-] functions.wp-scripts.php [open]
[-] default-widgets.php [open]
[-] class-wp-locale-switcher.php [open]
[-] date.php [open]
[-] class-wp-widget-factory.php [open]
[-] functions.php [open]
[-] class-walker-category.php [open]
[-] class-wp-dependency.php [open]
[+] ID3
[-] version.php [open]
[-] class-smtp.php [open]
[-] class-wp-network.php [open]
[-] rest-api.php [open]
[-] class-wp-http-response.php [open]
[-] class-wp-user-query.php [open]
[-] class-snoopy.php [open]
[-] update.php [open]
[-] nav-menu.php [open]
[+] widgets
[-] class-wp-simplepie-sanitize-kses.php [open]
[-] class-wp-role.php [open]
[+] pomo
[-] theme.php [open]
[-] class-wp-ajax-response.php [open]
[-] class-wp-admin-bar.php [open]
[-] class-wp-http-ixr-client.php [open]
[-] class-wp-post.php [open]
[-] query.php [open]
[-] functions.wp-styles.php [open]
[+] certificates
[-] admin-bar.php [open]
[-] atomlib.php [open]
[-] general-template.php [open]
[-] class-wp-image-editor-gd.php [open]
[-] feed-atom-comments.php [open]
[-] class-wp-text-diff-renderer-inline.php [open]
[-] nav-menu-template.php [open]
[-] class.wp-scripts.php [open]
[-] class-pop3.php [open]
[-] post-thumbnail-template.php [open]
[-] widgets.php [open]
[-] session.php [open]
[-] class-walker-page-dropdown.php [open]
[-] class-wp-http-curl.php [open]
[-] class-wp-network-query.php [open]
[-] deprecated.php [open]
[-] registration-functions.php [open]
[-] ms-settings.php [open]
[-] wp-diff.php [open]
[-] category-template.php [open]
[-] class-json.php [open]
[+] fonts
[-] class-wp-theme.php [open]
[-] media-template.php [open]
[-] class-wp-roles.php [open]
[-] class-wp-http-requests-response.php [open]
[-] script-loader.php [open]
[-] class-wp-user.php [open]
[-] class-wp-comment-query.php [open]
[-] class-wp-http-proxy.php [open]
[-] class-wp-locale.php [open]
[-] class-wp-user-meta-session-tokens.php [open]
[-] ms-deprecated.php [open]
[-] bookmark.php [open]
[-] class-walker-category-dropdown.php [open]
[-] class-wp-site-query.php [open]
[-] class-wp-customize-control.php [open]
[-] class-wp-query.php [open]
[-] rss-functions.php [open]
[-] canonical.php [open]
[+] js
[-] ms-default-filters.php [open]
[-] class-wp-customize-widgets.php [open]
[-] pluggable-deprecated.php [open]
[-] vars.php [open]
[-] l10n.php [open]
[-] load.php [open]
[-] ms-files.php [open]
[-] class-wp-customize-panel.php [open]
[-] class-wp-taxonomy.php [open]
[-] embed-template.php [open]
[-] ms-default-constants.php [open]
[-] post-formats.php [open]
[-] ms-blogs.php [open]
[-] feed-rss2-comments.php [open]
[-] link-template.php [open]
[-] class-phpmailer.php [open]
[-] class.wp-dependencies.php [open]
[-] revision.php [open]
[-] category.php [open]
[-] class-wp-image-editor-imagick.php [open]
[-] author-template.php [open]
[-] http.php [open]
[-] class-wp-walker.php [open]
[-] class-wp-simplepie-file.php [open]
[-] class-wp-post-type.php [open]
[-] plugin.php [open]
[+] random_compat
[-] class-wp-matchesmapregex.php [open]
[-] wp-db.php [open]
[-] registration.php [open]
[-] class-wp.php [open]
[-] class-http.php [open]
[-] rewrite.php [open]
[+] Text
[-] class-walker-nav-menu.php [open]
[-] class-wp-feed-cache.php [open]
[-] formatting.php [open]
[+] customize
[-] class-wp-list-util.php [open]
[-] feed-atom.php [open]
[-] class-wp-term-query.php [open]
[-] option.php [open]
[-] comment.php [open]
[-] comment-template.php [open]
[-] class-wp-http-cookie.php [open]
[-] class-wp-editor.php [open]
[-] class-wp-meta-query.php [open]
[-] class-wp-image-editor.php [open]
[-] post.php [open]
[-] taxonomy.php [open]
[+] IXR
[-] class-wp-embed.php [open]
[+] theme-compat
[-] class-wp-rewrite.php [open]
[-] class-wp-customize-nav-menus.php [open]
[-] class-wp-error.php [open]
[-] class-requests.php [open]
[-] wlwmanifest.xml [open]
[-] template.php [open]
[-] class-wp-text-diff-renderer-table.php [open]
[-] capabilities.php [open]
[-] class-wp-customize-setting.php [open]
[-] class.wp-styles.php [open]
[-] compat.php [open]
[-] feed.php [open]
[-] class-wp-http-requests-hooks.php [open]
[-] class-wp-hook.php [open]
[+] Requests
[-] class-wp-tax-query.php [open]
[-] class-walker-comment.php [open]
[-] feed-rdf.php [open]
[-] class-wp-comment.php [open]
[-] class-wp-customize-manager.php [open]
[+] rest-api
[-] class-feed.php [open]
[-] media.php [open]
[-] class-phpass.php [open]
[-] feed-rss2.php [open]