Client Area shortcodes

The Client Area extension for WP-CRM System gives you a number of shortcodes that will allow you to create your very own client portal.

[wpcrm_system_register_form]

If you want to allow visitors to your site to register an account before being able to access your client area, this shortcode will display a simple registration form. It will also check WP-CRM System to see if there is a corresponding Contact that matches. If not it will create the Contact record for you.

Example use: [wpcrm_system_register_form]

[wpcrm_system_loginform]

On the client-only area on your site, you will likely want to place a login form unless you are managing logins some other way on your site. Simply place the login form shortcode on your page, and it will check to see if the current user is logged in. If they are not logged in, they will get a simple login form.

Example use: [wpcrm_system_loginform]

[wpcrm_system_client_area]

This shortcode requires the display attribute to be included in order for it to display the correct information. Possible display attributes include:

• projects: Displays all projects that are assigned to the current logged-in user, and any associated tasks.
• tasks: Displays only tasks that are assigned to the current logged-in user.
• campaigns: Displays campaigns that are assigned to the current logged-in user.
• invoices: Requires WP-CRM System Invoicing extension, and will display a list of invoices that are assigned to the current logged in user, their paid/unpaid status, value, and a link to the invoice for clients to view/pay the invoice.
• payments: Displays a payment form for clients to make a payment via Stripe. This attribute also requires one of two additional attributes:
  • plans=”true”: Use this to display a payment form with a drop down menu of subscription plans that your clients can select from. Plans must be set up in WP-CRM System > Dashboard > Client Area.
    • If you require a one-time “setup fee” you can also include the setup_fee=”xxxx” attribute.
  • amount=”xxxx”: Use this to display a payment form for a one-time payment.
    • Optionaly, you can also include the “currency” attribute with your currency’s three-character code (all lowercase) currency=”gbp”. If the currency attribute is excluded, this will default to usd (United States Dollars).
• cancel: Displays a message with a checkbox that allows your clients to cancel the plan they have subscribed to (if any).

In the payments attribute, the setup_fee and amount attributes require that you enter the values to be charged in cents. For example, $50.00 would be entered as 5000. Do not leave off the last two zeroes, otherwise only $0.50 will be charged.

Example uses:

To display client’s projects:

[wpcrm_system_client_area display=”projects”]

To display client’s tasks:

[wpcrm_system_client_area display=”tasks”]

To display client’s campaigns:

[wpcrm_system_client_area display=”campaigns”]

To display client’s invoices:

[wpcrm_system_client_area display=”invoices”]

To display a payment form pre-populated with your subscription plans:

[wpcrm_system_client_area display=”payments” plans=”true”]

To display a payment form pre-populated with your subscription plans and charge a $20 setup fee:

[wpcrm_system_client_area display=”payments” plans=”true” setup_fee=”2000″]

To display a one-time payment form for $10:

[wpcrm_system_client_area display=”payments” amount=”1000″]

To display a subscription plan cancellation form:

[wpcrm_system_client_area display=”cancel”]

[client_area_hidden]This should only be visible to logged in visitors[/client_area_hidden]

Important: Do not include other WP-CRM System Client Area shortcodes inside the client area hidden shortcode. The client area hidden shortcode can be used multiple times on the same page, so you can wrap it around various content areas on your page.

Incorrect use:

[client_area_hidden]
<h2>Projects</h2>
[wpcrm_system_client_area display="projects"]
[/client_area_hidden]

Correct use:

[client_area_hidden]
<h2>Projects</h2>
[/client_area_hidden]
[wpcrm_system_client_area display="projects"]