| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Core User Role & Capabilities API 4 * 5 * @package WordPress 6 * @subpackage Users 7 */ 8 9 /** 10 * Maps a capability to the primitive capabilities required of the given user to 11 * satisfy the capability being checked. 12 * 13 * This function also accepts an ID of an object to map against if the capability is a meta capability. Meta 14 * capabilities such as `edit_post` and `edit_user` are capabilities used by this function to map to primitive 15 * capabilities that a user or role requires, such as `edit_posts` and `edit_others_posts`. 16 * 17 * Example usage: 18 * 19 * map_meta_cap( 'edit_posts', $user->ID ); 20 * map_meta_cap( 'edit_post', $user->ID, $post->ID ); 21 * map_meta_cap( 'edit_post_meta', $user->ID, $post->ID, $meta_key ); 22 * 23 * This function does not check whether the user has the required capabilities, 24 * it just returns what the required capabilities are. 25 * 26 * @since 2.0.0 27 * @since 4.9.6 Added the `export_others_personal_data`, `erase_others_personal_data`, 28 * and `manage_privacy_options` capabilities. 29 * @since 5.1.0 Added the `update_php` capability. 30 * @since 5.2.0 Added the `resume_plugin` and `resume_theme` capabilities. 31 * @since 5.3.0 Formalized the existing and already documented `...$args` parameter 32 * by adding it to the function signature. 33 * @since 5.7.0 Added the `create_app_password`, `list_app_passwords`, `read_app_password`, 34 * `edit_app_password`, `delete_app_passwords`, `delete_app_password`, 35 * and `update_https` capabilities. 36 * 37 * @global array $post_type_meta_caps Used to get post type meta capabilities. 38 * 39 * @param string $cap Capability being checked. 40 * @param int $user_id User ID. 41 * @param mixed ...$args Optional further parameters, typically starting with an object ID. 42 * @return string[] Primitive capabilities required of the user. 43 */ 44 function map_meta_cap( $cap, $user_id, ...$args ) { 45 $caps = array(); 46 47 switch ( $cap ) { 48 case 'remove_user': 49 // In multisite the user must be a super admin to remove themselves. 50 if ( isset( $args[0] ) && $user_id == $args[0] && ! is_super_admin( $user_id ) ) { 51 $caps[] = 'do_not_allow'; 52 } else { 53 $caps[] = 'remove_users'; 54 } 55 break; 56 case 'promote_user': 57 case 'add_users': 58 $caps[] = 'promote_users'; 59 break; 60 case 'edit_user': 61 case 'edit_users': 62 // Allow user to edit themselves. 63 if ( 'edit_user' === $cap && isset( $args[0] ) && $user_id == $args[0] ) { 64 break; 65 } 66 67 // In multisite the user must have manage_network_users caps. If editing a super admin, the user must be a super admin. 68 if ( is_multisite() && ( ( ! is_super_admin( $user_id ) && 'edit_user' === $cap && is_super_admin( $args[0] ) ) || ! user_can( $user_id, 'manage_network_users' ) ) ) { 69 $caps[] = 'do_not_allow'; 70 } else { 71 $caps[] = 'edit_users'; // edit_user maps to edit_users. 72 } 73 break; 74 case 'delete_post': 75 case 'delete_page': 76 if ( ! isset( $args[0] ) ) { 77 if ( 'delete_post' === $cap ) { 78 /* translators: %s: Capability name. */ 79 $message = __( 'When checking for the %s capability, you must always check it against a specific post.' ); 80 } else { 81 /* translators: %s: Capability name. */ 82 $message = __( 'When checking for the %s capability, you must always check it against a specific page.' ); 83 } 84 85 _doing_it_wrong( 86 __FUNCTION__, 87 sprintf( $message, '<code>' . $cap . '</code>' ), 88 '6.1.0' 89 ); 90 91 $caps[] = 'do_not_allow'; 92 break; 93 } 94 95 $post = get_post( $args[0] ); 96 if ( ! $post ) { 97 $caps[] = 'do_not_allow'; 98 break; 99 } 100 101 if ( 'revision' === $post->post_type ) { 102 $caps[] = 'do_not_allow'; 103 break; 104 } 105 106 if ( ( get_option( 'page_for_posts' ) == $post->ID ) || ( get_option( 'page_on_front' ) == $post->ID ) ) { 107 $caps[] = 'manage_options'; 108 break; 109 } 110 111 $post_type = get_post_type_object( $post->post_type ); 112 if ( ! $post_type ) { 113 /* translators: 1: Post type, 2: Capability name. */ 114 $message = __( 'The post type %1$s is not registered, so it may not be reliable to check the capability %2$s against a post of that type.' ); 115 116 _doing_it_wrong( 117 __FUNCTION__, 118 sprintf( 119 $message, 120 '<code>' . $post->post_type . '</code>', 121 '<code>' . $cap . '</code>' 122 ), 123 '4.4.0' 124 ); 125 126 $caps[] = 'edit_others_posts'; 127 break; 128 } 129 130 if ( ! $post_type->map_meta_cap ) { 131 $caps[] = $post_type->cap->$cap; 132 // Prior to 3.1 we would re-call map_meta_cap here. 133 if ( 'delete_post' === $cap ) { 134 $cap = $post_type->cap->$cap; 135 } 136 break; 137 } 138 139 // If the post author is set and the user is the author... 140 if ( $post->post_author && $user_id == $post->post_author ) { 141 // If the post is published or scheduled... 142 if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) { 143 $caps[] = $post_type->cap->delete_published_posts; 144 } elseif ( 'trash' === $post->post_status ) { 145 $status = get_post_meta( $post->ID, '_wp_trash_meta_status', true ); 146 if ( in_array( $status, array( 'publish', 'future' ), true ) ) { 147 $caps[] = $post_type->cap->delete_published_posts; 148 } else { 149 $caps[] = $post_type->cap->delete_posts; 150 } 151 } else { 152 // If the post is draft... 153 $caps[] = $post_type->cap->delete_posts; 154 } 155 } else { 156 // The user is trying to edit someone else's post. 157 $caps[] = $post_type->cap->delete_others_posts; 158 // The post is published or scheduled, extra cap required. 159 if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) { 160 $caps[] = $post_type->cap->delete_published_posts; 161 } elseif ( 'private' === $post->post_status ) { 162 $caps[] = $post_type->cap->delete_private_posts; 163 } 164 } 165 166 /* 167 * Setting the privacy policy page requires `manage_privacy_options`, 168 * so deleting it should require that too. 169 */ 170 if ( (int) get_option( 'wp_page_for_privacy_policy' ) === $post->ID ) { 171 $caps = array_merge( $caps, map_meta_cap( 'manage_privacy_options', $user_id ) ); 172 } 173 174 break; 175 /* 176 * edit_post breaks down to edit_posts, edit_published_posts, or 177 * edit_others_posts. 178 */ 179 case 'edit_post': 180 case 'edit_page': 181 if ( ! isset( $args[0] ) ) { 182 if ( 'edit_post' === $cap ) { 183 /* translators: %s: Capability name. */ 184 $message = __( 'When checking for the %s capability, you must always check it against a specific post.' ); 185 } else { 186 /* translators: %s: Capability name. */ 187 $message = __( 'When checking for the %s capability, you must always check it against a specific page.' ); 188 } 189 190 _doing_it_wrong( 191 __FUNCTION__, 192 sprintf( $message, '<code>' . $cap . '</code>' ), 193 '6.1.0' 194 ); 195 196 $caps[] = 'do_not_allow'; 197 break; 198 } 199 200 $post = get_post( $args[0] ); 201 if ( ! $post ) { 202 $caps[] = 'do_not_allow'; 203 break; 204 } 205 206 if ( 'revision' === $post->post_type ) { 207 $post = get_post( $post->post_parent ); 208 if ( ! $post ) { 209 $caps[] = 'do_not_allow'; 210 break; 211 } 212 } 213 214 $post_type = get_post_type_object( $post->post_type ); 215 if ( ! $post_type ) { 216 /* translators: 1: Post type, 2: Capability name. */ 217 $message = __( 'The post type %1$s is not registered, so it may not be reliable to check the capability %2$s against a post of that type.' ); 218 219 _doing_it_wrong( 220 __FUNCTION__, 221 sprintf( 222 $message, 223 '<code>' . $post->post_type . '</code>', 224 '<code>' . $cap . '</code>' 225 ), 226 '4.4.0' 227 ); 228 229 $caps[] = 'edit_others_posts'; 230 break; 231 } 232 233 if ( ! $post_type->map_meta_cap ) { 234 $caps[] = $post_type->cap->$cap; 235 // Prior to 3.1 we would re-call map_meta_cap here. 236 if ( 'edit_post' === $cap ) { 237 $cap = $post_type->cap->$cap; 238 } 239 break; 240 } 241 242 // If the post author is set and the user is the author... 243 if ( $post->post_author && $user_id == $post->post_author ) { 244 // If the post is published or scheduled... 245 if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) { 246 $caps[] = $post_type->cap->edit_published_posts; 247 } elseif ( 'trash' === $post->post_status ) { 248 $status = get_post_meta( $post->ID, '_wp_trash_meta_status', true ); 249 if ( in_array( $status, array( 'publish', 'future' ), true ) ) { 250 $caps[] = $post_type->cap->edit_published_posts; 251 } else { 252 $caps[] = $post_type->cap->edit_posts; 253 } 254 } else { 255 // If the post is draft... 256 $caps[] = $post_type->cap->edit_posts; 257 } 258 } else { 259 // The user is trying to edit someone else's post. 260 $caps[] = $post_type->cap->edit_others_posts; 261 // The post is published or scheduled, extra cap required. 262 if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) { 263 $caps[] = $post_type->cap->edit_published_posts; 264 } elseif ( 'private' === $post->post_status ) { 265 $caps[] = $post_type->cap->edit_private_posts; 266 } 267 } 268 269 /* 270 * Setting the privacy policy page requires `manage_privacy_options`, 271 * so editing it should require that too. 272 */ 273 if ( (int) get_option( 'wp_page_for_privacy_policy' ) === $post->ID ) { 274 $caps = array_merge( $caps, map_meta_cap( 'manage_privacy_options', $user_id ) ); 275 } 276 277 break; 278 case 'read_post': 279 case 'read_page': 280 if ( ! isset( $args[0] ) ) { 281 if ( 'read_post' === $cap ) { 282 /* translators: %s: Capability name. */ 283 $message = __( 'When checking for the %s capability, you must always check it against a specific post.' ); 284 } else { 285 /* translators: %s: Capability name. */ 286 $message = __( 'When checking for the %s capability, you must always check it against a specific page.' ); 287 } 288 289 _doing_it_wrong( 290 __FUNCTION__, 291 sprintf( $message, '<code>' . $cap . '</code>' ), 292 '6.1.0' 293 ); 294 295 $caps[] = 'do_not_allow'; 296 break; 297 } 298 299 $post = get_post( $args[0] ); 300 if ( ! $post ) { 301 $caps[] = 'do_not_allow'; 302 break; 303 } 304 305 if ( 'revision' === $post->post_type ) { 306 $post = get_post( $post->post_parent ); 307 if ( ! $post ) { 308 $caps[] = 'do_not_allow'; 309 break; 310 } 311 } 312 313 $post_type = get_post_type_object( $post->post_type ); 314 if ( ! $post_type ) { 315 /* translators: 1: Post type, 2: Capability name. */ 316 $message = __( 'The post type %1$s is not registered, so it may not be reliable to check the capability %2$s against a post of that type.' ); 317 318 _doing_it_wrong( 319 __FUNCTION__, 320 sprintf( 321 $message, 322 '<code>' . $post->post_type . '</code>', 323 '<code>' . $cap . '</code>' 324 ), 325 '4.4.0' 326 ); 327 328 $caps[] = 'edit_others_posts'; 329 break; 330 } 331 332 if ( ! $post_type->map_meta_cap ) { 333 $caps[] = $post_type->cap->$cap; 334 // Prior to 3.1 we would re-call map_meta_cap here. 335 if ( 'read_post' === $cap ) { 336 $cap = $post_type->cap->$cap; 337 } 338 break; 339 } 340 341 $status_obj = get_post_status_object( get_post_status( $post ) ); 342 if ( ! $status_obj ) { 343 /* translators: 1: Post status, 2: Capability name. */ 344 $message = __( 'The post status %1$s is not registered, so it may not be reliable to check the capability %2$s against a post with that status.' ); 345 346 _doing_it_wrong( 347 __FUNCTION__, 348 sprintf( 349 $message, 350 '<code>' . get_post_status( $post ) . '</code>', 351 '<code>' . $cap . '</code>' 352 ), 353 '5.4.0' 354 ); 355 356 $caps[] = 'edit_others_posts'; 357 break; 358 } 359 360 if ( $status_obj->public ) { 361 $caps[] = $post_type->cap->read; 362 break; 363 } 364 365 if ( $post->post_author && $user_id == $post->post_author ) { 366 $caps[] = $post_type->cap->read; 367 } elseif ( $status_obj->private ) { 368 $caps[] = $post_type->cap->read_private_posts; 369 } else { 370 $caps = map_meta_cap( 'edit_post', $user_id, $post->ID ); 371 } 372 break; 373 case 'publish_post': 374 if ( ! isset( $args[0] ) ) { 375 /* translators: %s: Capability name. */ 376 $message = __( 'When checking for the %s capability, you must always check it against a specific post.' ); 377 378 _doing_it_wrong( 379 __FUNCTION__, 380 sprintf( $message, '<code>' . $cap . '</code>' ), 381 '6.1.0' 382 ); 383 384 $caps[] = 'do_not_allow'; 385 break; 386 } 387 388 $post = get_post( $args[0] ); 389 if ( ! $post ) { 390 $caps[] = 'do_not_allow'; 391 break; 392 } 393 394 $post_type = get_post_type_object( $post->post_type ); 395 if ( ! $post_type ) { 396 /* translators: 1: Post type, 2: Capability name. */ 397 $message = __( 'The post type %1$s is not registered, so it may not be reliable to check the capability %2$s against a post of that type.' ); 398 399 _doing_it_wrong( 400 __FUNCTION__, 401 sprintf( 402 $message, 403 '<code>' . $post->post_type . '</code>', 404 '<code>' . $cap . '</code>' 405 ), 406 '4.4.0' 407 ); 408 409 $caps[] = 'edit_others_posts'; 410 break; 411 } 412 413 $caps[] = $post_type->cap->publish_posts; 414 break; 415 case 'edit_post_meta': 416 case 'delete_post_meta': 417 case 'add_post_meta': 418 case 'edit_comment_meta': 419 case 'delete_comment_meta': 420 case 'add_comment_meta': 421 case 'edit_term_meta': 422 case 'delete_term_meta': 423 case 'add_term_meta': 424 case 'edit_user_meta': 425 case 'delete_user_meta': 426 case 'add_user_meta': 427 $object_type = explode( '_', $cap )[1]; 428 429 if ( ! isset( $args[0] ) ) { 430 if ( 'post' === $object_type ) { 431 /* translators: %s: Capability name. */ 432 $message = __( 'When checking for the %s capability, you must always check it against a specific post.' ); 433 } elseif ( 'comment' === $object_type ) { 434 /* translators: %s: Capability name. */ 435 $message = __( 'When checking for the %s capability, you must always check it against a specific comment.' ); 436 } elseif ( 'term' === $object_type ) { 437 /* translators: %s: Capability name. */ 438 $message = __( 'When checking for the %s capability, you must always check it against a specific term.' ); 439 } else { 440 /* translators: %s: Capability name. */ 441 $message = __( 'When checking for the %s capability, you must always check it against a specific user.' ); 442 } 443 444 _doing_it_wrong( 445 __FUNCTION__, 446 sprintf( $message, '<code>' . $cap . '</code>' ), 447 '6.1.0' 448 ); 449 450 $caps[] = 'do_not_allow'; 451 break; 452 } 453 454 $object_id = (int) $args[0]; 455 456 $object_subtype = get_object_subtype( $object_type, $object_id ); 457 458 if ( empty( $object_subtype ) ) { 459 $caps[] = 'do_not_allow'; 460 break; 461 } 462 463 $caps = map_meta_cap( "edit_{$object_type}", $user_id, $object_id ); 464 465 $meta_key = isset( $args[1] ) ? $args[1] : false; 466 467 if ( $meta_key ) { 468 $allowed = ! is_protected_meta( $meta_key, $object_type ); 469 470 if ( ! empty( $object_subtype ) && has_filter( "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}" ) ) { 471 472 /** 473 * Filters whether the user is allowed to edit a specific meta key of a specific object type and subtype. 474 * 475 * The dynamic portions of the hook name, `$object_type`, `$meta_key`, 476 * and `$object_subtype`, refer to the metadata object type (comment, post, term or user), 477 * the meta key value, and the object subtype respectively. 478 * 479 * @since 4.9.8 480 * 481 * @param bool $allowed Whether the user can add the object meta. Default false. 482 * @param string $meta_key The meta key. 483 * @param int $object_id Object ID. 484 * @param int $user_id User ID. 485 * @param string $cap Capability name. 486 * @param string[] $caps Array of the user's capabilities. 487 */ 488 $allowed = apply_filters( "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $allowed, $meta_key, $object_id, $user_id, $cap, $caps ); 489 } else { 490 491 /** 492 * Filters whether the user is allowed to edit a specific meta key of a specific object type. 493 * 494 * Return true to have the mapped meta caps from `edit_{$object_type}` apply. 495 * 496 * The dynamic portion of the hook name, `$object_type` refers to the object type being filtered. 497 * The dynamic portion of the hook name, `$meta_key`, refers to the meta key passed to map_meta_cap(). 498 * 499 * @since 3.3.0 As `auth_post_meta_{$meta_key}`. 500 * @since 4.6.0 501 * 502 * @param bool $allowed Whether the user can add the object meta. Default false. 503 * @param string $meta_key The meta key. 504 * @param int $object_id Object ID. 505 * @param int $user_id User ID. 506 * @param string $cap Capability name. 507 * @param string[] $caps Array of the user's capabilities. 508 */ 509 $allowed = apply_filters( "auth_{$object_type}_meta_{$meta_key}", $allowed, $meta_key, $object_id, $user_id, $cap, $caps ); 510 } 511 512 if ( ! empty( $object_subtype ) ) { 513 514 /** 515 * Filters whether the user is allowed to edit meta for specific object types/subtypes. 516 * 517 * Return true to have the mapped meta caps from `edit_{$object_type}` apply. 518 * 519 * The dynamic portion of the hook name, `$object_type` refers to the object type being filtered. 520 * The dynamic portion of the hook name, `$object_subtype` refers to the object subtype being filtered. 521 * The dynamic portion of the hook name, `$meta_key`, refers to the meta key passed to map_meta_cap(). 522 * 523 * @since 4.6.0 As `auth_post_{$post_type}_meta_{$meta_key}`. 524 * @since 4.7.0 Renamed from `auth_post_{$post_type}_meta_{$meta_key}` to 525 * `auth_{$object_type}_{$object_subtype}_meta_{$meta_key}`. 526 * @deprecated 4.9.8 Use {@see 'auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}'} instead. 527 * 528 * @param bool $allowed Whether the user can add the object meta. Default false. 529 * @param string $meta_key The meta key. 530 * @param int $object_id Object ID. 531 * @param int $user_id User ID. 532 * @param string $cap Capability name. 533 * @param string[] $caps Array of the user's capabilities. 534 */ 535 $allowed = apply_filters_deprecated( 536 "auth_{$object_type}_{$object_subtype}_meta_{$meta_key}", 537 array( $allowed, $meta_key, $object_id, $user_id, $cap, $caps ), 538 '4.9.8', 539 "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}" 540 ); 541 } 542 543 if ( ! $allowed ) { 544 $caps[] = $cap; 545 } 546 } 547 break; 548 case 'edit_comment': 549 if ( ! isset( $args[0] ) ) { 550 /* translators: %s: Capability name. */ 551 $message = __( 'When checking for the %s capability, you must always check it against a specific comment.' ); 552 553 _doing_it_wrong( 554 __FUNCTION__, 555 sprintf( $message, '<code>' . $cap . '</code>' ), 556 '6.1.0' 557 ); 558 559 $caps[] = 'do_not_allow'; 560 break; 561 } 562 563 $comment = get_comment( $args[0] ); 564 if ( ! $comment ) { 565 $caps[] = 'do_not_allow'; 566 break; 567 } 568 569 $post = get_post( $comment->comment_post_ID ); 570 571 /* 572 * If the post doesn't exist, we have an orphaned comment. 573 * Fall back to the edit_posts capability, instead. 574 */ 575 if ( $post ) { 576 $caps = map_meta_cap( 'edit_post', $user_id, $post->ID ); 577 } else { 578 $caps = map_meta_cap( 'edit_posts', $user_id ); 579 } 580 break; 581 case 'unfiltered_upload': 582 if ( defined( 'ALLOW_UNFILTERED_UPLOADS' ) && ALLOW_UNFILTERED_UPLOADS && ( ! is_multisite() || is_super_admin( $user_id ) ) ) { 583 $caps[] = $cap; 584 } else { 585 $caps[] = 'do_not_allow'; 586 } 587 break; 588 case 'edit_css': 589 case 'unfiltered_html': 590 // Disallow unfiltered_html for all users, even admins and super admins. 591 if ( defined( 'DISALLOW_UNFILTERED_HTML' ) && DISALLOW_UNFILTERED_HTML ) { 592 $caps[] = 'do_not_allow'; 593 } elseif ( is_multisite() && ! is_super_admin( $user_id ) ) { 594 $caps[] = 'do_not_allow'; 595 } else { 596 $caps[] = 'unfiltered_html'; 597 } 598 break; 599 case 'edit_files': 600 case 'edit_plugins': 601 case 'edit_themes': 602 // Disallow the file editors. 603 if ( defined( 'DISALLOW_FILE_EDIT' ) && DISALLOW_FILE_EDIT ) { 604 $caps[] = 'do_not_allow'; 605 } elseif ( ! wp_is_file_mod_allowed( 'capability_edit_themes' ) ) { 606 $caps[] = 'do_not_allow'; 607 } elseif ( is_multisite() && ! is_super_admin( $user_id ) ) { 608 $caps[] = 'do_not_allow'; 609 } else { 610 $caps[] = $cap; 611 } 612 break; 613 case 'update_plugins': 614 case 'delete_plugins': 615 case 'install_plugins': 616 case 'upload_plugins': 617 case 'update_themes': 618 case 'delete_themes': 619 case 'install_themes': 620 case 'upload_themes': 621 case 'update_core': 622 /* 623 * Disallow anything that creates, deletes, or updates core, plugin, or theme files. 624 * Files in uploads are excepted. 625 */ 626 if ( ! wp_is_file_mod_allowed( 'capability_update_core' ) ) { 627 $caps[] = 'do_not_allow'; 628 } elseif ( is_multisite() && ! is_super_admin( $user_id ) ) { 629 $caps[] = 'do_not_allow'; 630 } elseif ( 'upload_themes' === $cap ) { 631 $caps[] = 'install_themes'; 632 } elseif ( 'upload_plugins' === $cap ) { 633 $caps[] = 'install_plugins'; 634 } else { 635 $caps[] = $cap; 636 } 637 break; 638 case 'install_languages': 639 case 'update_languages': 640 if ( ! wp_is_file_mod_allowed( 'can_install_language_pack' ) ) { 641 $caps[] = 'do_not_allow'; 642 } elseif ( is_multisite() && ! is_super_admin( $user_id ) ) { 643 $caps[] = 'do_not_allow'; 644 } else { 645 $caps[] = 'install_languages'; 646 } 647 break; 648 case 'activate_plugins': 649 case 'deactivate_plugins': 650 case 'activate_plugin': 651 case 'deactivate_plugin': 652 $caps[] = 'activate_plugins'; 653 if ( is_multisite() ) { 654 // update_, install_, and delete_ are handled above with is_super_admin(). 655 $menu_perms = get_site_option( 'menu_items', array() ); 656 if ( empty( $menu_perms['plugins'] ) ) { 657 $caps[] = 'manage_network_plugins'; 658 } 659 } 660 break; 661 case 'resume_plugin': 662 $caps[] = 'resume_plugins'; 663 break; 664 case 'resume_theme': 665 $caps[] = 'resume_themes'; 666 break; 667 case 'delete_user': 668 case 'delete_users': 669 // If multisite only super admins can delete users. 670 if ( is_multisite() && ! is_super_admin( $user_id ) ) { 671 $caps[] = 'do_not_allow'; 672 } else { 673 $caps[] = 'delete_users'; // delete_user maps to delete_users. 674 } 675 break; 676 case 'create_users': 677 if ( ! is_multisite() ) { 678 $caps[] = $cap; 679 } elseif ( is_super_admin( $user_id ) || get_site_option( 'add_new_users' ) ) { 680 $caps[] = $cap; 681 } else { 682 $caps[] = 'do_not_allow'; 683 } 684 break; 685 case 'manage_links': 686 if ( get_option( 'link_manager_enabled' ) ) { 687 $caps[] = $cap; 688 } else { 689 $caps[] = 'do_not_allow'; 690 } 691 break; 692 case 'customize': 693 $caps[] = 'edit_theme_options'; 694 break; 695 case 'delete_site': 696 if ( is_multisite() ) { 697 $caps[] = 'manage_options'; 698 } else { 699 $caps[] = 'do_not_allow'; 700 } 701 break; 702 case 'edit_term': 703 case 'delete_term': 704 case 'assign_term': 705 if ( ! isset( $args[0] ) ) { 706 /* translators: %s: Capability name. */ 707 $message = __( 'When checking for the %s capability, you must always check it against a specific term.' ); 708 709 _doing_it_wrong( 710 __FUNCTION__, 711 sprintf( $message, '<code>' . $cap . '</code>' ), 712 '6.1.0' 713 ); 714 715 $caps[] = 'do_not_allow'; 716 break; 717 } 718 719 $term_id = (int) $args[0]; 720 $term = get_term( $term_id ); 721 if ( ! $term || is_wp_error( $term ) ) { 722 $caps[] = 'do_not_allow'; 723 break; 724 } 725 726 $tax = get_taxonomy( $term->taxonomy ); 727 if ( ! $tax ) { 728 $caps[] = 'do_not_allow'; 729 break; 730 } 731 732 if ( 'delete_term' === $cap 733 && ( get_option( 'default_' . $term->taxonomy ) == $term->term_id 734 || get_option( 'default_term_' . $term->taxonomy ) == $term->term_id ) 735 ) { 736 $caps[] = 'do_not_allow'; 737 break; 738 } 739 740 $taxo_cap = $cap . 's'; 741 742 $caps = map_meta_cap( $tax->cap->$taxo_cap, $user_id, $term_id ); 743 744 break; 745 case 'manage_post_tags': 746 case 'edit_categories': 747 case 'edit_post_tags': 748 case 'delete_categories': 749 case 'delete_post_tags': 750 $caps[] = 'manage_categories'; 751 break; 752 case 'assign_categories': 753 case 'assign_post_tags': 754 $caps[] = 'edit_posts'; 755 break; 756 case 'create_sites': 757 case 'delete_sites': 758 case 'manage_network': 759 case 'manage_sites': 760 case 'manage_network_users': 761 case 'manage_network_plugins': 762 case 'manage_network_themes': 763 case 'manage_network_options': 764 case 'upgrade_network': 765 $caps[] = $cap; 766 break; 767 case 'setup_network': 768 if ( is_multisite() ) { 769 $caps[] = 'manage_network_options'; 770 } else { 771 $caps[] = 'manage_options'; 772 } 773 break; 774 case 'update_php': 775 if ( is_multisite() && ! is_super_admin( $user_id ) ) { 776 $caps[] = 'do_not_allow'; 777 } else { 778 $caps[] = 'update_core'; 779 } 780 break; 781 case 'update_https': 782 if ( is_multisite() && ! is_super_admin( $user_id ) ) { 783 $caps[] = 'do_not_allow'; 784 } else { 785 $caps[] = 'manage_options'; 786 $caps[] = 'update_core'; 787 } 788 break; 789 case 'export_others_personal_data': 790 case 'erase_others_personal_data': 791 case 'manage_privacy_options': 792 $caps[] = is_multisite() ? 'manage_network' : 'manage_options'; 793 break; 794 case 'create_app_password': 795 case 'list_app_passwords': 796 case 'read_app_password': 797 case 'edit_app_password': 798 case 'delete_app_passwords': 799 case 'delete_app_password': 800 $caps = map_meta_cap( 'edit_user', $user_id, $args[0] ); 801 break; 802 default: 803 // Handle meta capabilities for custom post types. 804 global $post_type_meta_caps; 805 if ( isset( $post_type_meta_caps[ $cap ] ) ) { 806 return map_meta_cap( $post_type_meta_caps[ $cap ], $user_id, ...$args ); 807 } 808 809 // Block capabilities map to their post equivalent. 810 $block_caps = array( 811 'edit_blocks', 812 'edit_others_blocks', 813 'publish_blocks', 814 'read_private_blocks', 815 'delete_blocks', 816 'delete_private_blocks', 817 'delete_published_blocks', 818 'delete_others_blocks', 819 'edit_private_blocks', 820 'edit_published_blocks', 821 ); 822 if ( in_array( $cap, $block_caps, true ) ) { 823 $cap = str_replace( '_blocks', '_posts', $cap ); 824 } 825 826 // If no meta caps match, return the original cap. 827 $caps[] = $cap; 828 } 829 830 /** 831 * Filters the primitive capabilities required of the given user to satisfy the 832 * capability being checked. 833 * 834 * @since 2.8.0 835 * 836 * @param string[] $caps Primitive capabilities required of the user. 837 * @param string $cap Capability being checked. 838 * @param int $user_id The user ID. 839 * @param array $args Adds context to the capability check, typically 840 * starting with an object ID. 841 */ 842 return apply_filters( 'map_meta_cap', $caps, $cap, $user_id, $args ); 843 } 844 845 /** 846 * Returns whether the current user has the specified capability. 847 * 848 * This function also accepts an ID of an object to check against if the capability is a meta capability. Meta 849 * capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to 850 * map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`. 851 * 852 * Example usage: 853 * 854 * current_user_can( 'edit_posts' ); 855 * current_user_can( 'edit_post', $post->ID ); 856 * current_user_can( 'edit_post_meta', $post->ID, $meta_key ); 857 * 858 * While checking against particular roles in place of a capability is supported 859 * in part, this practice is discouraged as it may produce unreliable results. 860 * 861 * Note: Will always return true if the current user is a super admin, unless specifically denied. 862 * 863 * @since 2.0.0 864 * @since 5.3.0 Formalized the existing and already documented `...$args` parameter 865 * by adding it to the function signature. 866 * @since 5.8.0 Converted to wrapper for the user_can() function. 867 * 868 * @see WP_User::has_cap() 869 * @see map_meta_cap() 870 * 871 * @param string $capability Capability name. 872 * @param mixed ...$args Optional further parameters, typically starting with an object ID. 873 * @return bool Whether the current user has the given capability. If `$capability` is a meta cap and `$object_id` is 874 * passed, whether the current user has the given meta capability for the given object. 875 */ 876 function current_user_can( $capability, ...$args ) { 877 return user_can( wp_get_current_user(), $capability, ...$args ); 878 } 879 880 /** 881 * Returns whether the current user has the specified capability for a given site. 882 * 883 * This function also accepts an ID of an object to check against if the capability is a meta capability. Meta 884 * capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to 885 * map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`. 886 * 887 * Example usage: 888 * 889 * current_user_can_for_blog( $blog_id, 'edit_posts' ); 890 * current_user_can_for_blog( $blog_id, 'edit_post', $post->ID ); 891 * current_user_can_for_blog( $blog_id, 'edit_post_meta', $post->ID, $meta_key ); 892 * 893 * @since 3.0.0 894 * @since 5.3.0 Formalized the existing and already documented `...$args` parameter 895 * by adding it to the function signature. 896 * @since 5.8.0 Wraps current_user_can() after switching to blog. 897 * 898 * @param int $blog_id Site ID. 899 * @param string $capability Capability name. 900 * @param mixed ...$args Optional further parameters, typically starting with an object ID. 901 * @return bool Whether the user has the given capability. 902 */ 903 function current_user_can_for_blog( $blog_id, $capability, ...$args ) { 904 $switched = is_multisite() ? switch_to_blog( $blog_id ) : false; 905 906 $can = current_user_can( $capability, ...$args ); 907 908 if ( $switched ) { 909 restore_current_blog(); 910 } 911 912 return $can; 913 } 914 915 /** 916 * Returns whether the author of the supplied post has the specified capability. 917 * 918 * This function also accepts an ID of an object to check against if the capability is a meta capability. Meta 919 * capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to 920 * map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`. 921 * 922 * Example usage: 923 * 924 * author_can( $post, 'edit_posts' ); 925 * author_can( $post, 'edit_post', $post->ID ); 926 * author_can( $post, 'edit_post_meta', $post->ID, $meta_key ); 927 * 928 * @since 2.9.0 929 * @since 5.3.0 Formalized the existing and already documented `...$args` parameter 930 * by adding it to the function signature. 931 * 932 * @param int|WP_Post $post Post ID or post object. 933 * @param string $capability Capability name. 934 * @param mixed ...$args Optional further parameters, typically starting with an object ID. 935 * @return bool Whether the post author has the given capability. 936 */ 937 function author_can( $post, $capability, ...$args ) { 938 $post = get_post( $post ); 939 if ( ! $post ) { 940 return false; 941 } 942 943 $author = get_userdata( $post->post_author ); 944 945 if ( ! $author ) { 946 return false; 947 } 948 949 return $author->has_cap( $capability, ...$args ); 950 } 951 952 /** 953 * Returns whether a particular user has the specified capability. 954 * 955 * This function also accepts an ID of an object to check against if the capability is a meta capability. Meta 956 * capabilities such as `edit_post` and `edit_user` are capabilities used by the `map_meta_cap()` function to 957 * map to primitive capabilities that a user or role has, such as `edit_posts` and `edit_others_posts`. 958 * 959 * Example usage: 960 * 961 * user_can( $user->ID, 'edit_posts' ); 962 * user_can( $user->ID, 'edit_post', $post->ID ); 963 * user_can( $user->ID, 'edit_post_meta', $post->ID, $meta_key ); 964 * 965 * @since 3.1.0 966 * @since 5.3.0 Formalized the existing and already documented `...$args` parameter 967 * by adding it to the function signature. 968 * 969 * @param int|WP_User $user User ID or object. 970 * @param string $capability Capability name. 971 * @param mixed ...$args Optional further parameters, typically starting with an object ID. 972 * @return bool Whether the user has the given capability. 973 */ 974 function user_can( $user, $capability, ...$args ) { 975 if ( ! is_object( $user ) ) { 976 $user = get_userdata( $user ); 977 } 978 979 if ( empty( $user ) ) { 980 // User is logged out, create anonymous user object. 981 $user = new WP_User( 0 ); 982 $user->init( new stdClass() ); 983 } 984 985 return $user->has_cap( $capability, ...$args ); 986 } 987 988 /** 989 * Retrieves the global WP_Roles instance and instantiates it if necessary. 990 * 991 * @since 4.3.0 992 * 993 * @global WP_Roles $wp_roles WordPress role management object. 994 * 995 * @return WP_Roles WP_Roles global instance if not already instantiated. 996 */ 997 function wp_roles() { 998 global $wp_roles; 999 1000 if ( ! isset( $wp_roles ) ) { 1001 $wp_roles = new WP_Roles(); 1002 } 1003 return $wp_roles; 1004 } 1005 1006 /** 1007 * Retrieves role object. 1008 * 1009 * @since 2.0.0 1010 * 1011 * @param string $role Role name. 1012 * @return WP_Role|null WP_Role object if found, null if the role does not exist. 1013 */ 1014 function get_role( $role ) { 1015 return wp_roles()->get_role( $role ); 1016 } 1017 1018 /** 1019 * Adds a role, if it does not exist. 1020 * 1021 * @since 2.0.0 1022 * 1023 * @param string $role Role name. 1024 * @param string $display_name Display name for role. 1025 * @param bool[] $capabilities List of capabilities keyed by the capability name, 1026 * e.g. array( 'edit_posts' => true, 'delete_posts' => false ). 1027 * @return WP_Role|void WP_Role object, if the role is added. 1028 */ 1029 function add_role( $role, $display_name, $capabilities = array() ) { 1030 if ( empty( $role ) ) { 1031 return; 1032 } 1033 1034 return wp_roles()->add_role( $role, $display_name, $capabilities ); 1035 } 1036 1037 /** 1038 * Removes a role, if it exists. 1039 * 1040 * @since 2.0.0 1041 * 1042 * @param string $role Role name. 1043 */ 1044 function remove_role( $role ) { 1045 wp_roles()->remove_role( $role ); 1046 } 1047 1048 /** 1049 * Retrieves a list of super admins. 1050 * 1051 * @since 3.0.0 1052 * 1053 * @global array $super_admins 1054 * 1055 * @return string[] List of super admin logins. 1056 */ 1057 function get_super_admins() { 1058 global $super_admins; 1059 1060 if ( isset( $super_admins ) ) { 1061 return $super_admins; 1062 } else { 1063 return get_site_option( 'site_admins', array( 'admin' ) ); 1064 } 1065 } 1066 1067 /** 1068 * Determines whether user is a site admin. 1069 * 1070 * @since 3.0.0 1071 * 1072 * @param int|false $user_id Optional. The ID of a user. Defaults to false, to check the current user. 1073 * @return bool Whether the user is a site admin. 1074 */ 1075 function is_super_admin( $user_id = false ) { 1076 if ( ! $user_id ) { 1077 $user = wp_get_current_user(); 1078 } else { 1079 $user = get_userdata( $user_id ); 1080 } 1081 1082 if ( ! $user || ! $user->exists() ) { 1083 return false; 1084 } 1085 1086 if ( is_multisite() ) { 1087 $super_admins = get_super_admins(); 1088 if ( is_array( $super_admins ) && in_array( $user->user_login, $super_admins, true ) ) { 1089 return true; 1090 } 1091 } else { 1092 if ( $user->has_cap( 'delete_users' ) ) { 1093 return true; 1094 } 1095 } 1096 1097 return false; 1098 } 1099 1100 /** 1101 * Grants Super Admin privileges. 1102 * 1103 * @since 3.0.0 1104 * 1105 * @global array $super_admins 1106 * 1107 * @param int $user_id ID of the user to be granted Super Admin privileges. 1108 * @return bool True on success, false on failure. This can fail when the user is 1109 * already a super admin or when the `$super_admins` global is defined. 1110 */ 1111 function grant_super_admin( $user_id ) { 1112 // If global super_admins override is defined, there is nothing to do here. 1113 if ( isset( $GLOBALS['super_admins'] ) || ! is_multisite() ) { 1114 return false; 1115 } 1116 1117 /** 1118 * Fires before the user is granted Super Admin privileges. 1119 * 1120 * @since 3.0.0 1121 * 1122 * @param int $user_id ID of the user that is about to be granted Super Admin privileges. 1123 */ 1124 do_action( 'grant_super_admin', $user_id ); 1125 1126 // Directly fetch site_admins instead of using get_super_admins(). 1127 $super_admins = get_site_option( 'site_admins', array( 'admin' ) ); 1128 1129 $user = get_userdata( $user_id ); 1130 if ( $user && ! in_array( $user->user_login, $super_admins, true ) ) { 1131 $super_admins[] = $user->user_login; 1132 update_site_option( 'site_admins', $super_admins ); 1133 1134 /** 1135 * Fires after the user is granted Super Admin privileges. 1136 * 1137 * @since 3.0.0 1138 * 1139 * @param int $user_id ID of the user that was granted Super Admin privileges. 1140 */ 1141 do_action( 'granted_super_admin', $user_id ); 1142 return true; 1143 } 1144 return false; 1145 } 1146 1147 /** 1148 * Revokes Super Admin privileges. 1149 * 1150 * @since 3.0.0 1151 * 1152 * @global array $super_admins 1153 * 1154 * @param int $user_id ID of the user Super Admin privileges to be revoked from. 1155 * @return bool True on success, false on failure. This can fail when the user's email 1156 * is the network admin email or when the `$super_admins` global is defined. 1157 */ 1158 function revoke_super_admin( $user_id ) { 1159 // If global super_admins override is defined, there is nothing to do here. 1160 if ( isset( $GLOBALS['super_admins'] ) || ! is_multisite() ) { 1161 return false; 1162 } 1163 1164 /** 1165 * Fires before the user's Super Admin privileges are revoked. 1166 * 1167 * @since 3.0.0 1168 * 1169 * @param int $user_id ID of the user Super Admin privileges are being revoked from. 1170 */ 1171 do_action( 'revoke_super_admin', $user_id ); 1172 1173 // Directly fetch site_admins instead of using get_super_admins(). 1174 $super_admins = get_site_option( 'site_admins', array( 'admin' ) ); 1175 1176 $user = get_userdata( $user_id ); 1177 if ( $user && 0 !== strcasecmp( $user->user_email, get_site_option( 'admin_email' ) ) ) { 1178 $key = array_search( $user->user_login, $super_admins, true ); 1179 if ( false !== $key ) { 1180 unset( $super_admins[ $key ] ); 1181 update_site_option( 'site_admins', $super_admins ); 1182 1183 /** 1184 * Fires after the user's Super Admin privileges are revoked. 1185 * 1186 * @since 3.0.0 1187 * 1188 * @param int $user_id ID of the user Super Admin privileges were revoked from. 1189 */ 1190 do_action( 'revoked_super_admin', $user_id ); 1191 return true; 1192 } 1193 } 1194 return false; 1195 } 1196 1197 /** 1198 * Filters the user capabilities to grant the 'install_languages' capability as necessary. 1199 * 1200 * A user must have at least one out of the 'update_core', 'install_plugins', and 1201 * 'install_themes' capabilities to qualify for 'install_languages'. 1202 * 1203 * @since 4.9.0 1204 * 1205 * @param bool[] $allcaps An array of all the user's capabilities. 1206 * @return bool[] Filtered array of the user's capabilities. 1207 */ 1208 function wp_maybe_grant_install_languages_cap( $allcaps ) { 1209 if ( ! empty( $allcaps['update_core'] ) || ! empty( $allcaps['install_plugins'] ) || ! empty( $allcaps['install_themes'] ) ) { 1210 $allcaps['install_languages'] = true; 1211 } 1212 1213 return $allcaps; 1214 } 1215 1216 /** 1217 * Filters the user capabilities to grant the 'resume_plugins' and 'resume_themes' capabilities as necessary. 1218 * 1219 * @since 5.2.0 1220 * 1221 * @param bool[] $allcaps An array of all the user's capabilities. 1222 * @return bool[] Filtered array of the user's capabilities. 1223 */ 1224 function wp_maybe_grant_resume_extensions_caps( $allcaps ) { 1225 // Even in a multisite, regular administrators should be able to resume plugins. 1226 if ( ! empty( $allcaps['activate_plugins'] ) ) { 1227 $allcaps['resume_plugins'] = true; 1228 } 1229 1230 // Even in a multisite, regular administrators should be able to resume themes. 1231 if ( ! empty( $allcaps['switch_themes'] ) ) { 1232 $allcaps['resume_themes'] = true; 1233 } 1234 1235 return $allcaps; 1236 } 1237 1238 /** 1239 * Filters the user capabilities to grant the 'view_site_health_checks' capabilities as necessary. 1240 * 1241 * @since 5.2.2 1242 * 1243 * @param bool[] $allcaps An array of all the user's capabilities. 1244 * @param string[] $caps Required primitive capabilities for the requested capability. 1245 * @param array $args { 1246 * Arguments that accompany the requested capability check. 1247 * 1248 * @type string $0 Requested capability. 1249 * @type int $1 Concerned user ID. 1250 * @type mixed ...$2 Optional second and further parameters, typically object ID. 1251 * } 1252 * @param WP_User $user The user object. 1253 * @return bool[] Filtered array of the user's capabilities. 1254 */ 1255 function wp_maybe_grant_site_health_caps( $allcaps, $caps, $args, $user ) { 1256 if ( ! empty( $allcaps['install_plugins'] ) && ( ! is_multisite() || is_super_admin( $user->ID ) ) ) { 1257 $allcaps['view_site_health_checks'] = true; 1258 } 1259 1260 return $allcaps; 1261 } 1262 1263 return; 1264 1265 // Dummy gettext calls to get strings in the catalog. 1266 /* translators: User role for administrators. */ 1267 _x( 'Administrator', 'User role' ); 1268 /* translators: User role for editors. */ 1269 _x( 'Editor', 'User role' ); 1270 /* translators: User role for authors. */ 1271 _x( 'Author', 'User role' ); 1272 /* translators: User role for contributors. */ 1273 _x( 'Contributor', 'User role' ); 1274 /* translators: User role for subscribers. */ 1275 _x( 'Subscriber', 'User role' );
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Thu Apr 25 08:20:02 2024 | Cross-referenced by PHPXref |