Skip to content

Latest commit

 

History

History
113 lines (72 loc) · 5.82 KB

README.md

File metadata and controls

113 lines (72 loc) · 5.82 KB

Ultimate Member - Account tabs

Adds custom tabs to the Account page menu.

Key features

  • Ability to create custom account tabs.
  • Ability to embed the profile form fields into the custom account tab.
  • Ability to embed the profile form header with cover and profile photo uploaders into the custom account tab.
  • Ability to restrict custom account tabs for specific user roles.
  • Ability to customise the custom account tab colour, icon and position.

Installation

Note: This plugin requires the Ultimate Member plugin to be installed first.

How to install from GitHub

Open git bash, navigate to the plugins folder and execute this command:

git clone --branch=main git@github.com:umdevelopera/um-account-tabs.git um-account-tabs

Once the plugin is cloned, enter your site admin dashboard and go to wp-admin > Plugins > Installed Plugins. Find the Ultimate Member - Account tabs plugin and click the Activate link.

How to install from ZIP archive

You can install this plugin from the ZIP file as any other plugin. Follow this instruction.

How to use

How to create a tab

Go to wp-admin > Ultimate Member > Account Tabs and click the Add New button to create a draft.

WP, Ultimate Member, Account Tabs

Configure the account tab settings:

  1. Title - The title of the tab (menu item text).

  2. Content - The content of the tab. You can add text, Gutenberg blocks, shortcodes. Note: forms are not allowed!

  3. Embed content:

  • Embed a profile form - Use this tool if you need to embed profile form fields into the tab.
  • Display the profile header - Use this tool if you need to embed cover and profile photo uploaders.
  • Display the profile fields - Use this to display profile form fields under the profile header.
  • Submit button text - Allows you to change the button text. "Update" by default.
  1. Restrictions:
  • Show on these roles accounts - Select user roles, in whose accounts you want to display the tab. The tab is displayed in all accounts if empty.
  1. Appearance:
  • Icon - Set the icon of the tab menu item. Default +.
  • Background color - Set the background color of the tab menu item. Default #E0E0E0.
  • Text color - Set the text and icon color of the tab menu item. Default #404040.
  • Tab position - Set the position of the tab item in the menu. A number from 1 to 999. Default is 800.
  • Tab slug - Set the slug of the tab. This is a part of the account page URL specific for the tab. Default post slug.

How to use placeholders, shortcodes and blocks

The tab content supports placeholders: {user_id}, {user_role}, {user_avatar}, {usermeta:meta_key}, {display_name}, {first_name}, {last_name}, {username}, {email}, {admin_email}, {site_name}, {site_url}, {user_account_link}, {user_profile_link}. Just add a placeholder into the text in the Content section.

  • {user_id} placeholder may be helpful for shortcodes that require the user_id attribute.
  • {usermeta:meta_key} placeholder may be helpful to display a custom field value.

The Content section supports shortcodes and Gutenberg blocks.

Example 1: Placeholders and shortcodes. 114a1+

114e1

How to embed the profile form fields

Account tabs can not contain forms. Select the profile form you need in the Embed a profile form dropdown to embed its fields into the tab.

Example 2: Embeded profile form fields e2a+

114e2

How to embed cover and profile photo uploaders

Select the profile form you need in the Embed a profile form dropdown and turn on the Display the profile header setting.

Example 3: Embeded cover and profile photo uploaders. 114a3+

114e3

How to translate

It is possible to translate custom account tabs if you use the Polylang multilingual plugin. Install the Ultimate Member - Polylang extension. Go to wp-admin > Ultimate Member > Account Tabs and click the Create Tabs button in the notice to duplicate tabs for all languages. Once the tabs are duplicated, you can manually edit the tab titles.

WP, Ultimate Member, Account Tabs (Create Tabs)

Support

This is a free extension created for the community. The Ultimate Member team does not provide support for this extension. Open new issue if you are facing a problem or have a suggestion.

Please give a star if you think this extension is useful. I wish to know how many people use it. Thanks.

Useful links

Ultimate Member documentation

Ultimate Member core plugin info and download

Free extensions for Ultimate Member

Code snippets for Ultimate Member