函数文档

current_user_can_for_site()

💡 云策文档标注

概述

current_user_can_for_site() 函数用于检查当前用户是否在指定站点上拥有特定权限。它支持元权限(如 edit_post)的映射检查,并取代了已弃用的 current_user_can_for_blog() 函数。

关键要点

  • 函数接受站点ID、权限名称和可选参数(如对象ID)作为输入,返回布尔值表示用户是否拥有该权限。
  • 在Multisite环境中,函数会临时切换站点(使用 switch_to_blog() 和 restore_current_blog())以执行权限检查。
  • 适用于需要跨站点权限验证的场景,例如在编辑文章或用户时检查特定站点的权限。

代码示例

current_user_can_for_site( $site_id, 'edit_posts' );
current_user_can_for_site( $site_id, 'edit_post', $post->ID );
current_user_can_for_site( $site_id, 'edit_post_meta', $post->ID, $meta_key );

📄 原文内容

Returns whether the current user has the specified capability for a given site.

Description

This function also accepts an ID of an object to check against if the capability is a meta capability. Meta capabilities such as edit_post and edit_user are capabilities used by the map_meta_cap() function to map to primitive capabilities that a user or role has, such as edit_posts and edit_others_posts.

This function replaces the current_user_can_for_blog() function.

Example usage:

current_user_can_for_site( $site_id, 'edit_posts' );
current_user_can_for_site( $site_id, 'edit_post', $post->ID );
current_user_can_for_site( $site_id, 'edit_post_meta', $post->ID, $meta_key );

Parameters

$site_idintrequired
Site ID.
$capabilitystringrequired
Capability name.
$argsmixedoptional
Optional further parameters, typically starting with an object ID.

Return

bool Whether the user has the given capability.

Source

function current_user_can_for_site( $site_id, $capability, ...$args ) {
	$switched = is_multisite() ? switch_to_blog( $site_id ) : false;

	$can = current_user_can( $capability, ...$args );

	if ( $switched ) {
		restore_current_blog();
	}

	return $can;
}

Changelog

Version Description
6.7.0 Introduced.