Documentation

Installation and Configuration

Minimum Requirements

To be able to install and use this plugin, there are a few minimum requirements that will have to be met first. This includes the version of GetSimple CMS you are using, plus the server environment being run on.

Installation

You can install this plugin to your GetSimple installation by following these simple instructions. After activation, two default user groups will be created, “Administrators” and “Standard Users”. Once installed, go to the settings tab in the Admin panel, then click on the new “User Management” link in the sidebar.

Configuration

To configure the plugins settings, go to the Settings tab in the Admin panel, then click on the “User Management” link in the sidebar. Then, in the top-right you will find the settings button. Click the Settings button.

Front-End Display Functions

Profile Templates
get_user_profile()

Plugin Developer Information

Integrating Your Plugin

Setting up permissions
Checking permissions

Action & Filter Hooks

There are currently no Action or Filter Hooks available, however this is a feature that is planned for a future version. When this feature does become available, it will be documented here. Stay tuned for more…

Public Functions

add_permissions()

Adds the permissions array to the global list of permissions as used by other functions. This function is designed to be used in an action hook within a plugin, but can be used stand alone if you prefer (eg.: in a theme’s functions.php file).

exec_permission()

This is a filtering function that’s used to determine if the currently logged in user has permission to view the page that you pass to it. It work by taking an output buffer of your page’s content and will only echo it out if permission is granted.

get_user_permission()

Checks the given permission agains the given user or current user and returns the result. This function is useful when you need to check if a user has permission to perform an action, such as save or delete.


Project Guidelines and Information

Contribution Guidelines

Everyone is welcome to make suggestions o how thisi plugin can be improved. You can do this by either submitting an issue to report a bug or discuss a feature, or a pull-request to fix a bug or add a feature. Here you will also find the following information:

Pull Request Guidelines
Issue Reporting Guidelines
Repository Structure Information

GNU General Public License

The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program–to make sure it remains free software for all its users.