MC4WP_Admin_Tools ()

Source file: admin/class-admin-tools.php

View source


Methods


Source

class MC4WP_Admin_Tools {

     /**
     * @return string
     */
    public function get_plugin_page() {
        if( empty( $_GET['page'] ) ) {
            return '';
        }

        $prefix = 'mailchimp-for-wp';
        $page = ltrim( substr( $_GET['page'], strlen( $prefix ) ), '-' );
        return $page;
    }

    /**
     * @param string $page
     *
     * @return bool
     */
    public function on_plugin_page( $page = null ) {
        // any settings page
        if( is_null( $page ) ) {
            return isset( $_GET['page'] ) && strpos( $_GET['page'], 'mailchimp-for-wp' ) === 0;
        }

        // specific page
        return $this->get_plugin_page() === $page;
    }

    /**
     * Does the logged-in user have the required capability?
     *
     * @return bool
     */
    public function is_user_authorized() {
        return current_user_can( $this->get_required_capability() );
    }

    /**
     * Get required capability to access settings page and view dashboard widgets.
     *
     * @return string
     */
    public function get_required_capability() {

        $capability = 'manage_options';

        /**
         * Filters the required user capability to access the settings pages & dashboard widgets.
         *
         * @ignore
         * @deprecated 3.0
         */
        $capability = apply_filters( 'mc4wp_settings_cap', $capability );

        /**
         * Filters the required user capability to access the MailChimp for WordPress' settings pages, view the dashboard widgets.
         *
         * Defaults to `manage_options`
         *
         * @since 3.0
         * @param string $capability
         * @see https://codex.wordpress.org/Roles_and_Capabilities
         */
        $capability = (string) apply_filters( 'mc4wp_admin_required_capability', $capability );

        return $capability;
    }

}

User Contributed Notes

You must log in before being able to contribute a note.