Ultimate Member
New in 3.21.1 (Pro). Two dispatcher tools work with Ultimate Member 2.14.1:
| Tool | Default | Purpose |
|---|---|---|
ultimate-member-read | On | Status, forms, directories, member status and content restrictions (7 operations) |
ultimate-member-write | Off | A form’s main button label and a directory’s page size (2 operations) |
Enable the write tool under Tools > Plugins > Ultimate Member.
Requirements
Section titled “Requirements”- An active EMCP Pro licence.
- Ultimate Member 2.14.1 exactly, on a single site. Another version answers
unsupported_version; multisite answersunsupported_environment. - An administrator (
manage_options). Forms, directories and posts are checked with WordPress’s edit permission, members withedit_user.
Read operations
Section titled “Read operations”| Operation | What it does |
|---|---|
status | Version, whether forms and directories are registered; membership_writes_supported is false |
list-forms | Forms (limit up to 100, offset): ID, title, status, mode, whether custom settings are on, main button label, version |
get-form | One form by id, plus up to 200 fields with key, type, label and required |
list-directories | Member directories: ID, title, status, page size on desktop and mobile, version |
get-directory | One directory by id |
get-member-status | One member’s account status by user id: approved, inactive, rejected, awaiting admin review, awaiting email confirmation, or unset |
get-content-restriction | The restriction stored on a post or page: custom or not, audience (everyone, logged out, logged in), roles, hidden from queries |
Lists cover up to 5,000 forms or directories. No user emails, passwords or other user data are returned. The content restriction is the post’s stored rule only; global rules and extensions can restrict further.
Write operations
Section titled “Write operations”Both need the object’s version and confirm: true; dry_run: true validates first.
| Operation | What it does |
|---|---|
set-form-label | Set the main button label of a register, login or profile form: label, plain text up to 120 characters |
set-directory-page-size | Set page_size (1 to 100) for device desktop (default) or mobile |
Rules and refusals
Section titled “Rules and refusals”- The form must already use custom settings in Ultimate Member, or the answer is
unsupported_form. - A setting stored in more than one row is refused for writes and undo, even with
force(unsupported_storage). - The current and new values must both fit the supported format (
unsupported_value). - The operation must match the object: a label for a form, a page size for a directory (
wrong_type). - Roles, account status, approvals, restriction rules, templates, registration and emails are never changed.
History
Section titled “History”Both changes can be undone from History, which puts back the earlier value, or removes it if it was not set, with a conflict check. If a hook fails, EMCP puts the value back and records a recovery entry.
