Skip to content
Snippets Groups Projects
Commit b0d5f41e authored by mattwire's avatar mattwire
Browse files

Update docs

parent a2b78964
No related branches found
No related tags found
No related merge requests found
# cmsuser
This provides the following CiviRules entities:
## Features
### This provides the following CiviRules entities:
- Condition: "Contact has CMS user".
- Action: "Create CMS User". *CMS username is set to contact email address*.
This provides the following API3 functions:
### This provides the following API3 functions:
- `Cmsuser.create` to create a CMS user for a contact.
- Returns ['uf_id' => {CMS USER ID}, 'created' => TRUE|FALSE]
- `created` = FALSE if CMS user already existed.
- Otherwise exception is thrown.
- `Cmsuser.get` to get the CMS user account for a contact.
### Search action and searchKit action:
- Provides an action to bulk "Create CMS user" with optional notify.
![action - create cms user](docs/images/action_createcmsuser.png)
The extension is licensed under [AGPL-3.0](LICENSE.txt).
## Installation
See: https://docs.civicrm.org/sysadmin/en/latest/customize/extensions/#installing-a-new-extension
## CMS specific notes
This extension uses the generic CiviCRM classes and in most cases does not implement any CMS specific functionality.
### Drupal 7
This extension passes an extra parameter to trigger an account activation email.
### WordPress
The default user create for WordPress automatically sends a "Login Details" email with a link to set the password.
## Release Notes
### 1.3 (2023-08-17)
......
docs/images/action_createcmsuser.png

25.6 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment