| Current File : /home/kelaby89/jrncommunityhousing.charity/wp-content/plugins/give/includes/class-give-roles.php |
<?php
/**
* Roles and Capabilities
*
* @package Give
* @subpackage Classes/Give_Roles
* @copyright Copyright (c) 2016, GiveWP
* @license https://opensource.org/licenses/gpl-license GNU Public License
* @since 1.0
*/
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Give_Roles Class
*
* This class handles the role creation and assignment of capabilities for those roles.
*
* These roles let us have Give Accountants, Give Workers, etc, each of whom can do
* certain things within the plugin.
*
* @since 1.0
*/
class Give_Roles {
/**
* Class Constructor
*
* Set up the Give Roles Class.
*
* @since 1.0
* @access public
*/
public function __construct() {
add_filter( 'give_map_meta_cap', array( $this, 'meta_caps' ), 10, 4 );
add_filter( 'woocommerce_disable_admin_bar', array( $this, 'manage_admin_dashboard' ), 10, 1 );
add_filter( 'woocommerce_prevent_admin_access', array( $this, 'manage_admin_dashboard' ), 10 );
}
/**
* Add Roles
*
* Add new shop roles with default WordPress capabilities.
*
* @since 1.0
* @access public
*
* @return void
*/
public function add_roles() {
add_role(
'give_manager',
__( 'GiveWP Manager', 'give' ),
array(
'read' => true,
'edit_posts' => true,
'delete_posts' => true,
'unfiltered_html' => true,
'upload_files' => true,
'export' => false,
'import' => false,
'delete_others_pages' => false,
'delete_others_posts' => false,
'delete_pages' => true,
'delete_private_pages' => true,
'delete_private_posts' => true,
'delete_published_pages' => true,
'delete_published_posts' => true,
'edit_others_pages' => false,
'edit_others_posts' => false,
'edit_pages' => true,
'edit_private_pages' => true,
'edit_private_posts' => true,
'edit_published_pages' => true,
'edit_published_posts' => true,
'manage_categories' => false,
'manage_links' => true,
'moderate_comments' => true,
'publish_pages' => true,
'publish_posts' => true,
'read_private_pages' => true,
'read_private_posts' => true,
)
);
add_role(
'give_accountant',
__( 'GiveWP Accountant', 'give' ),
array(
'read' => true,
'edit_posts' => false,
'delete_posts' => false,
)
);
add_role(
'give_worker',
__( 'GiveWP Worker', 'give' ),
array(
'read' => true,
'edit_posts' => true,
'edit_pages' => true,
'upload_files' => true,
'delete_posts' => false,
)
);
add_role(
'give_donor',
__( 'GiveWP Donor', 'give' ),
array(
'read' => true,
)
);
}
/**
* Add Capabilities
*
* Add new shop-specific capabilities.
*
* @since 1.0
* @access public
*
* @global WP_Roles $wp_roles
*
* @return void
*/
public function add_caps() {
global $wp_roles;
if ( class_exists( 'WP_Roles' ) ) {
if ( ! isset( $wp_roles ) ) {
$wp_roles = new WP_Roles();
}
}
if ( is_object( $wp_roles ) ) {
$wp_roles->add_cap( 'give_manager', 'view_give_reports' );
$wp_roles->add_cap( 'give_manager', 'view_give_sensitive_data' );
$wp_roles->add_cap( 'give_manager', 'export_give_reports' );
$wp_roles->add_cap( 'give_manager', 'manage_give_settings' );
$wp_roles->add_cap( 'give_manager', 'view_give_payments' );
$wp_roles->add_cap( 'administrator', 'view_give_reports' );
$wp_roles->add_cap( 'administrator', 'view_give_sensitive_data' );
$wp_roles->add_cap( 'administrator', 'export_give_reports' );
$wp_roles->add_cap( 'administrator', 'manage_give_settings' );
$wp_roles->add_cap( 'administrator', 'view_give_payments' );
// Add the main post type capabilities.
$capabilities = $this->get_core_caps();
foreach ( $capabilities as $cap_group ) {
foreach ( $cap_group as $cap ) {
$wp_roles->add_cap( 'administrator', $cap );
$wp_roles->add_cap( 'give_manager', $cap );
}
}
// Add Capabilities to Give Workers User Role.
$wp_roles->add_cap( 'give_worker', 'edit_give_payments' );
$wp_roles->add_cap( 'give_worker', 'delete_give_forms' );
$wp_roles->add_cap( 'give_worker', 'delete_others_give_forms' );
$wp_roles->add_cap( 'give_worker', 'delete_private_give_forms' );
$wp_roles->add_cap( 'give_worker', 'delete_published_give_forms' );
$wp_roles->add_cap( 'give_worker', 'edit_give_forms' );
$wp_roles->add_cap( 'give_worker', 'edit_others_give_forms' );
$wp_roles->add_cap( 'give_worker', 'edit_private_give_forms' );
$wp_roles->add_cap( 'give_worker', 'edit_published_give_forms' );
$wp_roles->add_cap( 'give_worker', 'publish_give_forms' );
$wp_roles->add_cap( 'give_worker', 'read_private_give_forms' );
// Add Capabilities to Give Accountant User Role.
$wp_roles->add_cap( 'give_accountant', 'edit_give_forms' );
$wp_roles->add_cap( 'give_accountant', 'read_private_give_forms' );
$wp_roles->add_cap( 'give_accountant', 'view_give_reports' );
$wp_roles->add_cap( 'give_accountant', 'export_give_reports' );
$wp_roles->add_cap( 'give_accountant', 'edit_give_payments' );
$wp_roles->add_cap( 'give_accountant', 'view_give_payments' );
}
}
/**
* Get Core Capabilities
*
* Retrieve core post type capabilities.
*
* @since 1.0
* @access public
*
* @return array $capabilities Core post type capabilities.
*/
public function get_core_caps() {
$capabilities = array();
$capability_types = array( 'give_form', 'give_payment' );
foreach ( $capability_types as $capability_type ) {
$capabilities[ $capability_type ] = array(
// Post type.
"edit_{$capability_type}s",
"edit_others_{$capability_type}s",
"publish_{$capability_type}s",
"read_private_{$capability_type}s",
"delete_{$capability_type}s",
"delete_private_{$capability_type}s",
"delete_published_{$capability_type}s",
"delete_others_{$capability_type}s",
"edit_private_{$capability_type}s",
"edit_published_{$capability_type}s",
// Terms / taxonomies.
"manage_{$capability_type}_terms",
"edit_{$capability_type}_terms",
"delete_{$capability_type}_terms",
"assign_{$capability_type}_terms",
// Custom capabilities.
"view_{$capability_type}_stats",
"import_{$capability_type}s",
);
}
return $capabilities;
}
/**
* Meta Capabilities
*
* Map meta capabilities to primitive capabilities.
*
* @since 1.0
* @access public
*
* @param array $caps Returns the user's actual capabilities.
* @param string $cap Capability name.
* @param int $user_id The user ID.
* @param array $args Adds the context to the cap. Typically the object ID.
*
* @return array $caps Meta capabilities.
*/
public function meta_caps( $caps, $cap, $user_id, $args ) {
switch ( $cap ) {
case 'view_give_form_stats':
if ( empty( $args[0] ) ) {
break;
}
$form = get_post( $args[0] );
if ( empty( $form ) ) {
break;
}
if ( user_can( $user_id, 'view_give_reports' ) || $user_id == $form->post_author ) {
$caps = array();
}
break;
}
return $caps;
}
/**
* Remove Capabilities
*
* Remove core post type capabilities (called on uninstall).
*
* @since 1.0
* @access public
*
* @global WP_Roles $wp_roles
*
* @return void
*/
public function remove_caps() {
global $wp_roles;
if ( class_exists( 'WP_Roles' ) ) {
if ( ! isset( $wp_roles ) ) {
$wp_roles = new WP_Roles();
}
}
if ( is_object( $wp_roles ) ) {
// Give Manager Capabilities.
$wp_roles->remove_cap( 'give_manager', 'view_give_reports' );
$wp_roles->remove_cap( 'give_manager', 'view_give_sensitive_data' );
$wp_roles->remove_cap( 'give_manager', 'export_give_reports' );
$wp_roles->remove_cap( 'give_manager', 'manage_give_settings' );
// Site Administrator Capabilities.
$wp_roles->remove_cap( 'administrator', 'view_give_reports' );
$wp_roles->remove_cap( 'administrator', 'view_give_sensitive_data' );
$wp_roles->remove_cap( 'administrator', 'export_give_reports' );
$wp_roles->remove_cap( 'administrator', 'manage_give_settings' );
$wp_roles->remove_cap( 'administrator', 'view_give_payments' );
// Remove the Main Post Type Capabilities.
$capabilities = $this->get_core_caps();
foreach ( $capabilities as $cap_group ) {
foreach ( $cap_group as $cap ) {
$wp_roles->remove_cap( 'give_manager', $cap );
$wp_roles->remove_cap( 'administrator', $cap );
}
}
// Remove capabilities from the Give Worker role.
$wp_roles->remove_cap( 'give_worker', 'edit_give_payments' );
$wp_roles->remove_cap( 'give_worker', 'delete_give_forms' );
$wp_roles->remove_cap( 'give_worker', 'delete_others_give_forms' );
$wp_roles->remove_cap( 'give_worker', 'delete_private_give_forms' );
$wp_roles->remove_cap( 'give_worker', 'delete_published_give_forms' );
$wp_roles->remove_cap( 'give_worker', 'edit_give_forms' );
$wp_roles->remove_cap( 'give_worker', 'edit_others_give_forms' );
$wp_roles->remove_cap( 'give_worker', 'edit_private_give_forms' );
$wp_roles->remove_cap( 'give_worker', 'edit_published_give_forms' );
$wp_roles->remove_cap( 'give_worker', 'publish_give_forms' );
$wp_roles->remove_cap( 'give_worker', 'read_private_give_forms' );
// Remove Capabilities from Give Accountant User Role.
$wp_roles->remove_cap( 'give_accountant', 'edit_give_forms' );
$wp_roles->remove_cap( 'give_accountant', 'read_private_give_forms' );
$wp_roles->remove_cap( 'give_accountant', 'view_give_reports' );
$wp_roles->remove_cap( 'give_accountant', 'export_give_reports' );
$wp_roles->remove_cap( 'give_accountant', 'edit_give_payments' );
$wp_roles->remove_cap( 'give_accountant', 'view_give_payments' );
}
}
/**
* Allow admin dashboard to User with Give Accountant Role.
*
* Note: WooCommerce doesn't allow the user to access the WP dashboard who holds "Give Accountant" role.
*
* @since 1.8.14
* @updated 1.8.18 - Fixed Give conflicting by not returning $show_admin_bar https://github.com/impress-org/give/issues/2539
*
* @param bool
*
* @return bool
*/
public function manage_admin_dashboard( $show_admin_bar ) {
// Get the current logged user.
$current_user = wp_get_current_user();
// If user with "Give Accountant" user role is logged-in .
if ( 0 !== $current_user->ID && in_array( 'give_accountant', (array) $current_user->roles, true ) ) {
// Return false, means no prevention.
return false;
}
return $show_admin_bar;
}
}