New setting "Also show dashboard to"

Author: ajaydsouza

includes/admin/class-dashboard.php

@@ -11,6 +11,8 @@
 
 namespace WebberZone\Top_Ten\Admin;
 
+use WebberZone\Top_Ten\Admin\Settings\Settings_API;
+
 if ( ! defined( 'WPINC' ) ) {
 	die;
 }
@@ -176,10 +178,12 @@ public function render_page() {
 	 * @since 3.0.0
 	 */
 	public function admin_menu() {
+		$roles = wp_parse_list( \tptn_get_option( 'show_dashboard_to_roles' ) );
+
 		$this->parent_id = add_menu_page(
 			esc_html__( 'Top 10 Dashboard', 'top-10' ),
 			esc_html__( 'Top 10', 'top-10' ),
-			'manage_options',
+			Settings_API::get_capability_for_menu( $roles ),
 			'tptn_dashboard',
 			array( $this, 'render_page' ),
 			'dashicons-editor-ol'
@@ -189,7 +193,7 @@ public function admin_menu() {
 			'tptn_dashboard',
 			esc_html__( 'Top 10 Dashboard', 'top-10' ),
 			esc_html__( 'Dashboard', 'top-10' ),
-			'manage_options',
+			Settings_API::get_capability_for_menu( $roles ),
 			'tptn_dashboard',
 			array( $this, 'render_page' )
 		);
@@ -234,7 +238,9 @@ public function admin_enqueue_scripts( $hook ) {
 	public function get_chart_data() {
 		global $wpdb;
 
-		if ( ! current_user_can( 'manage_options' ) ) {
+		$roles = wp_parse_list( \tptn_get_option( 'show_dashboard_to_roles' ) );
+
+		if ( ! current_user_can( Settings_API::get_capability_for_menu( $roles ) ) ) {
 			wp_die();
 		}
 		check_ajax_referer( 'tptn-dashboard', 'security' );

includes/admin/settings/class-settings-api.php

@@ -31,7 +31,7 @@ class Settings_API {
 	 *
 	 * @var   string
 	 */
-	const VERSION = '2.5.1';
+	const VERSION = '2.5.2';
 
 	/**
 	 * Settings Key.
@@ -333,7 +333,7 @@ public function add_custom_menu_page( $menu ) {
 			'parent_slug' => 'options-general.php',
 			'page_title'  => '',
 			'menu_title'  => '',
-			'capability'  => 'manage_options',
+			'capability'  => $this->get_capability_for_menu(),
 			'menu_slug'   => '',
 			'function'    => array( $this, 'plugin_settings' ),
 
@@ -416,6 +416,42 @@ public function admin_menu() {
 		add_action( 'load-' . $this->settings_page, array( $this, 'settings_help' ) );
 	}
 
+	/**
+	 * Get the appropriate capability for the menu based on the user's roles and settings.
+	 *
+	 * @param array    $roles Array of roles to check.
+	 * @param string   $base_capability The default capability.
+	 * @param \WP_User $current_user The current user object.
+	 * @param array    $role_capabilities Array of role capabilities.
+	 * @return string The capability to use for the menu.
+	 */
+	public static function get_capability_for_menu( $roles = array(), $base_capability = 'manage_options', $current_user = null, $role_capabilities = array() ) {
+		if ( ! $current_user ) {
+			$current_user = wp_get_current_user();
+		}
+
+		if ( empty( $roles ) || in_array( 'administrator', $current_user->roles, true ) ) {
+			return $base_capability;
+		}
+
+		if ( empty( $role_capabilities ) ) {
+			$role_capabilities = array(
+				'editor'      => 'edit_others_posts',
+				'author'      => 'publish_posts',
+				'contributor' => 'edit_posts',
+				'subscriber'  => 'read',
+			);
+		}
+
+		foreach ( $current_user->roles as $role ) {
+			if ( in_array( $role, $roles, true ) && isset( $role_capabilities[ $role ] ) ) {
+				return $role_capabilities[ $role ];
+			}
+		}
+
+		return $base_capability;
+	}
+
 	/**
 	 * Enqueue scripts and styles.
 	 *

includes/admin/settings/class-settings.php

@@ -281,7 +281,7 @@ public static function settings_general() {
 			),
 			'show_metabox_admins'     => array(
 				'id'      => 'show_metabox_admins',
-				'name'    => esc_html__( 'Limit meta box to Admins only', 'top-10' ),
+				'name'    => esc_html__( 'Limit meta box to Admins', 'top-10' ),
 				'desc'    => esc_html__( 'If selected, the meta box will be hidden from anyone who is not an Admin. By default, Contributors and above will be able to see the meta box. Applies only if the above option is selected.', 'top-10' ),
 				'type'    => 'checkbox',
 				'options' => false,
@@ -308,6 +308,15 @@ public static function settings_general() {
 				'type'    => 'checkbox',
 				'options' => true,
 			),
+			'show_dashboard_to_roles' => array(
+				'id'      => 'show_dashboard_to_roles',
+				'name'    => esc_html__( 'Also show dashboard to', 'top-10' ),
+				'desc'    => esc_html__( 'Choose the user roles that should have access to the Top 10 dashboard, which showcases popular posts over time. These roles are linked to specific capabilities, and selecting a lower role will automatically grant access to higher roles.', 'top-10' ),
+				'type'    => 'multicheck',
+				'default' => 'administrator',
+				'options' => self::get_user_roles( array( 'administrator' ) ),
+				'pro'     => true,
+			),
 		);
 
 		/**
@@ -342,10 +351,7 @@ public static function settings_counter() {
 				/* translators: 1: Code. */
 				'desc'    => sprintf( esc_html__( 'If you choose to disable this, please add the following code to your template file where you want it displayed: %1$s', 'top-10' ), "<code>&lt;?php if ( function_exists( 'echo_tptn_post_count' ) ) { echo_tptn_post_count(); } ?&gt;</code>" ),
 				'type'    => 'multicheck',
-				'default' => array(
-					'single' => 'single',
-					'page'   => 'page',
-				),
+				'default' => 'single,page',
 				'options' => array(
 					'single'            => esc_html__( 'Posts', 'top-10' ),
 					'page'              => esc_html__( 'Pages', 'top-10' ),
@@ -434,12 +440,9 @@ public static function settings_counter() {
 				'id'      => 'trackers',
 				'name'    => esc_html__( 'Enable trackers', 'top-10' ),
 				/* translators: 1: Code. */
-				'desc'    => '',
+				'desc'    => esc_html__( 'Top 10 tracks hits in two tables in the database. The overall table only tracks the total hits per post. The daily table tracks hits per post on an hourly basis.', 'top-10' ),
 				'type'    => 'multicheck',
-				'default' => array(
-					'overall' => 'overall',
-					'daily'   => 'daily',
-				),
+				'default' => 'overall,daily',
 				'options' => array(
 					'overall' => esc_html__( 'Overall', 'top-10' ),
 					'daily'   => esc_html__( 'Daily range', 'top-10' ),
@@ -465,11 +468,7 @@ public static function settings_counter() {
 				'name'    => esc_html__( 'Track user groups', 'top-10' ) . ':',
 				'desc'    => esc_html__( 'Uncheck above to disable tracking if the current user falls into any one of these groups.', 'top-10' ),
 				'type'    => 'multicheck',
-				'default' => array(
-					'authors' => 'authors',
-					'editors' => 'editors',
-					'admins'  => 'admins',
-				),
+				'default' => 'authors,editors,admins',
 				'options' => array(
 					'authors' => esc_html__( 'Authors', 'top-10' ),
 					'editors' => esc_html__( 'Editors', 'top-10' ),
@@ -1095,6 +1094,31 @@ public static function get_styles() {
 		return apply_filters( self::$prefix . '_get_styles', $styles );
 	}
 
+	/**
+	 * Get User Roles.
+	 *
+	 * @since 3.4.0
+	 *
+	 * @param array $remove_roles Roles to remove.
+	 * @return array User roles in the format 'role' => 'name'.
+	 */
+	public static function get_user_roles( $remove_roles = array() ) {
+		global $wp_roles;
+
+		// Initialize the array to store roles in the desired format.
+		$roles_array = array();
+
+		// Loop through all roles and store them in 'role' => 'name' format.
+		foreach ( $wp_roles->roles as $role_key => $role_details ) {
+			if ( in_array( $role_key, $remove_roles, true ) ) {
+				continue;
+			}
+			$roles_array[ $role_key ] = esc_html( $role_details['name'] );
+		}
+
+		return $roles_array;
+	}
+
 	/**
 	 * Adding WordPress plugin action links.
 	 *