Contents
Shortcodes List
Paid Member Subscriptions comes with a list of shortcodes that you can use right away:
- [pms-register] – Generates a Registration form that allows users to purchase your Subscription Plans
- [pms-login] – Generates a Login Form
- [pms-logout] – Displays the Front End Logout Text and Link
- [pms-account] – Generates the Account Form that allows the users to manage their information and Subscription Plans
- [pms-recover-password] – Generates the Recover Password Form
- [pms-restrict] – Restricts content inside a post or a page so you can have content that’s protected and content that’s not protected in the same page
- [pms-payment-history] – Adds a Front End Table with the Member’s Payment History
- [pms-action] – Lets you generate a direct link to an action (retry payment, renew etc.)
Member Registration form
In order to generate the Registration Form follow the steps below:
- Create a new page and name it appropriately, for example Register or something similar
- Add the [pms-register] shortcode inside using the Text Editor (not Visual)
- Hit “Publish” and you’ll be prompted with a Registration Form in the Front End
All the Subscription Plans created in Paid Member Subscriptions -> Subscription Plans will be displayed inside the Registration Form.
Front End Registration Form
Parameters
Array
- subscription_plans – A comma separated list of Subscription Plans IDs to list only certain Subscription Plans, or you can use “none” to allow users to register without becoming members (to not list any Subscriptions Plans). If this attribute is not set, all active Subscription Plans will be displayed
- plans_position – Where to display the Subscription Plans in relation to the Register fields. The parameter can use the values “bottom” or “top” and the default is set to bottom
- selected – The ID of the Subscription Plan that should be selected by default when we display the Register form
Example of parameters used inside the [pms-register] shortcodeArray
The above shortcode, will create a Registration Form that will list the Gold, Silver and Free Subscription Plans and position them above the rest of the fields. By default the Silver Subscription Plan (with the ID 18) is selected.
Allow Users to Register without becoming Members
You can allow users to register on your domain without subscribing to a Subscription Plan by using the “none” value inside the subscription_plans parameter like so: [pms-register subscription_plans="none"].
All users that will use this Registration Form will register as a normal user.
Allow logged in users to become Members
If you already have users on your website and you want them to purchase a subscription plan, all they have to do is login to their account and then visit the page with the [pms-register] shortcode.
The page acts as the main way for users to purchase Subscriptions, while also allowing them to register for an account on your website if they don’t already have one.
Choose which subscription plans to show
This can be done through the `subscription_plans` parameter. This parameter takes a comma separated list of Subscription Plan IDs to list only certain plans.
Example:Array
Will show only plans with ID 1 and 2, the others will be hidden from the form.
Exclude subscription plans from showing
You can also use a parameter to exclude subscription plans from showing, so the plugin will display every available plan except the one(s) you’ve added in this parameter.
Example:Array
This will show all plans in the form except the ones with ID 3 and 4.
Pre-select a subscription plan through an URL parameter
You might want to create a better presentation for your subscription plans and what they offer through a Membership Pricing Table and when the user selects a plan, he should be sent to the subscription form with the plan pre-selected.
This can be achieved by adding the subscription_plan parameter to the URL of your subscription page.
In case you’re looking to link to a subscribe form containing just this specific plan (and excluding the others) you can use a second URL parameter: single_plan=yes.
Example:
The URL of your page is: https://website.com/subscribe and the id of the plan you wish to be pre-selected is 15.
The link to pre-select this plan would be: https://website.com/subscribe?subscription_plan=15
The link to pre-select this plan and exclude others would be: https://website.com/subscribe?subscription_plan=15&single_plan=yes
Login Form
In order to generate the Login Form follow the steps below:
- Create a new page and name it appropriately, for example Login or something similar
- Add the [pms-login] shortcode inside using the Text Editor (not Visual)
- Hit “Publish” and you’ll be prompted with a Login Form in the Front End
The Login Form allows your users to login from the Front End of WordPress, instead of the default WordPress Login Form.
Front End Login Form
Parameters
Array
- redirect_url – Will redirect the user to an url of your choosing after a successful login
- logout_redirect_url – Will redirect the user to an url of your choosing after log out
- register_url – Adds a link to the Register Form
- lostpassword_url – Adds a link to the Recover Password Form
Redirect User after Login
Paid Member Subscriptions makes it really easy to redirect users after login to any URL by using the redirect_url parameter.
Example:Array
Add Register and Lost Password? links below the Login form
You can add a “Register” and a “Lost your password?” link below the Login form using the register_url and lostpassword_url parameters.
Example:Array
Front End Login Form
Member Account form
In order to generate the Account Form follow the steps below:
- Create a new page and name it appropriately, for example Account or something similar
- Add the [pms-account] shortcode inside using the Text Editor (not Visual)
- Hit “Publish” and you’ll be prompted with an Account Form in the Front End
The Account Form will allow your members to View, Upgrade, Renew, Cancel or Abandon their Subscription Plan, and also to modify their information like Email, First Name, Last Name and Password on the site.
In case their initial payment when creating an account failed, they will also be able to Retry the payment.
Front End Account Form Logged In Member
Parameters
Array
- show_tabs=”no” – Only shows the first tab (Subscriptions) and removes the navigation from the shortcode
- logout_redirect_url=”” – If not empty, defines the redirect URL when a user logs out
Front End Account Form for Logged Out Member
If a logged out user is visiting your page with this shortcode, he will be shown a login form so he can login and view his account information.
Do not display tabs in Account Form
You can display only the Subscription Plans inside the Account Form using the show_tabs parameter.
Example:Array
Subscription Actions
Retry Payment
The Retry Payment option appears if the user didn’t successfully pay for the subscription and the status is pending.
This option can be used by the user to reinitiate the payment either by sending the user to the payment gateway or showing the credit card details form.
Upgrade
The Upgrade option lets users purchase higher ordered subscriptions from the same tier.
This option will only appear if there is an upgrade available.
Renew
The Renew option gives your users the possibility to manually renew a subscription plan.
This option appears for users that have Canceled or Expired subscriptions and also for users of Active subscriptions, which have 15 days or less remaining on their subscription.
Cancel
The Cancel option gives your users the option to stop recurring subscriptions. The status of the subscription will be set to Canceled and it will expire after the Expiration Date.
These users will still have access to your restricted content until the expiration date has passed.
Abandon
The Abandon option will completely remove a subscription from a users account. Recurring payments will be canceled and any access to restricted content will be revoked.
The user will need to purchase a subscription plan again from a page with the [pms-register] shortcode.
Downgrade or Change
These actions are disabled by default. In order to enable them, go to the Paid Member Subscriptions -> Settings -> Payments page.
After enabling one of them, the Upgrade action will be named `Change` and through it, your users will be able to Upgrade, Downgrade or Change their subscription plans.
Downgrading a subscription means that the user will be able to go down a subscription level (or more) and through the Change action, users can go to a subscription from a different tier.
Logout Link
In order to generate the Logout Link follow the steps below:
- Create a new page and name it appropriately, for example Logout or something similar
- Add the [pms-logout] shortcode inside using the Text Editor (not Visual)
- Hit “Publish” and you’ll be prompted with a Logout Link in the Front End
The Logout Link allows your users to logout from the Front End of WordPress.
Front End Logout Link
Parameters
Array
- text – Modify the message that is shown to the Logged In User. You can use the following tags: {{meta_user_name}} and {{meta_display_name}}
- link_text – Modify the text of the Logout Link
- redirect_url – Will redirect the user to an url of your choosing after a successful logout. If this is not set, the user will be redirected to the current page
Redirect user after Logout
To redirect the user after logout you will need to use the redirect_url parameter.
Example:Array
Modify the message displayed to the Logged In User
To modify the text and the link text displayed to the logged in user you will need to use the text and the link_text parameters.
Example:Array
Front End Logout Link
Recover Password
In order to generate the Recover Password Form follow the steps below:
- Create a new page and name it appropriately, for example Recover Password or something similar
- Add the [pms-recover-password] shortcode inside using the Text Editor (not Visual)
- Hit “Publish” and you’ll be prompted with a Recover Password Form in the Front End
The [pms-recover-password] shortcode will create a simple Recover Password Form for your users that can be used in the Front End, so you don’t have to use the default WordPress Recover Password Form.
Front End Recover Password Form
Parameters
Array
- redirect_url – Will redirect the user to an url of your choosing (ex: Login page) after a successful password recovery
Redirect User after Password Recovery
You can redirect the user to an url (ex: Login page) after a successful password recovery by using the redirect_url parameter.
Example:Array
Restrict Content
In order to use the Restrict Content shortcode follow the steps below:
- Create a new page and name it appropriately, for example Premium Content or something similar
- Add the [pms-restrict] shortcode inside using the Text Editor (not Visual)
- Hit “Publish” and you’ll be prompted with a Premium Content page that has restricted content
All the content added between the [pms-restrict] [/pms-restrict] shortcode will be restricted for the logged out user. Logged in users will be able to view the restricted content. To restrict the content based on Subscription Plan you will need to use the subscription_plans parameter inside the shortcode.
Front End Premium Content Logged Out User
Front End Premium Content Logged In User
Parameters
Array
- subscription_plans – A comma separated list of Subscription Plans IDs to display the restricted content only to certain Subscription Plans. If this attribute is not set, all logged in users will see the Restricted Content
- display_to – Can take the value of “not_logged_in” to display the content only to Logged Out Users or “not_subscribed” to display content to users that are not subscribed to any / a certain plan
- message – Adds a custom message to users who don’t have access to the Restricted Content
Restrict Content based on Subscription Plan
In order to restrict the content based on Subscription Plan we will need to use the subscription_plans parameter inside the [pms-restrict] shortcode. If we don’t use the subscription_plans parameter all the restricted content will be displayed to all logged in users.
Example:Array
Based on the example above, the content will be restricted for all the members that didn’t subscribe to the Subscription Plan with the ID 177, and in our case it is the Gold Subscription Plan.
Display Content only to Logged Out Users
In order to display content only to Logged Out Users we will need to add the “not_logged_in” value inside the display_to parameter.
Example:Array
We use the message parameter to not display the message to the Logged In User.
Modify the Message displayed to the User
In order to modify the message displayed to the user that doesn’t have the appropriate Subscription Plan to view the restricted content, we will need to use the message parameter.
Example:Array
The message parameter will overwrite the default message setup in Paid Member Subscriptions -> Settings -> Content Restriction -> Messages for logged-in non-member users.
Display Content to non-subscribers
You can also use the shortcode to show content to users that are not subscribed to a plan or any plan.
Example:Array
The first example will display to any non-subscriber from your website and the second one will be shown only to users that do not have plans 123 or 251.
The `message=” “` parameter was also added so the shortcode doesn’t display anything when the user has the right plan.
Display Content to Group Subscription owners
Custom content can also be added for Group Subscriptions owners:
Example:Array
You can also add a second parameter `group_owner_user_id` in order to use the functionality in emails where the current user is not the one the email is being sent to.
Example:Array
Payment History
In order to use the Payment History shortcode follow the steps below:
- Create a new page and name it appropriately, for example Payment History or something similar
- Add the [pms-payment-history] shortcode inside using the Text Editor (not Visual)
- Hit “Publish” and you’ll be prompted with a Payment History Table in the Front End
The [pms-payment-history] shortcode, will create a Payment History Table that will list all the Payments done by the user including the ID, Amount, Date/Time and Status. If no payments were made by the user then the “No payments found” notification will be displayed.
Front End Payment History Table
Parameters
Array
- number_per_page – Set the number of payments that will be displayed inside the Payment History Table
Generate Action Link
Subscription actions are part of the [pms-account] shortcode. They are shown on the Subscriptions tab and let the user manage his subscription. For more information click here.
Using a shortcode, it is possible to display these actions on other pages, prompting the user to renew, retry the payment and more.
Usage
Array
The action is chosen based on the tags you are using to wrap your link text. In the example above, we use the {{retry}}…{{/retry}} tags in order to generate a Retry Payment link. You need to replace this with the action that you need to generate the link for. Available actions are:
- retry
- renew
- upgrade
- cancel
- abandon
If no tags are added inside the shortcode or if the closing tag is missing, the shortcode will not return anything.
Multiple Subscriptions per User
If the user has more than 1 subscription, when generating the URL, you can add a shortcode parameter to specify to which subscription plan the action you are defining refers to:Array
So we added the plan_id parameter to the shortcode, alongside the id of the plan we’re looking to target (123 in the example).
Return only the URL
The shortcode can be used to return only the URL for the Action instead of the HTML markup. This is useful in a scenario where the markup is generated by something else (a button generated by your page builder for example) and you only need the correct URL appended.
Usage:Array
Paid Member Subscriptions Pro
Accept (recurring) payments, create subscription plans and restrict content on your website. Easily setup a WordPress membership site using Paid Member Subscriptions.
Unlock PRO Features