Paid Memberships Pro

https://www.paidmembershipspro.com/documentation/
Admin
Paid Memberships Pro is a WordPress plugin for creating and managing membership sites with support...
Tokens:153,489
Snippets:2,305
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Order Search Examples

Source: https://www.paidmembershipspro.com/documentation/admin/orders

Practical examples of searching for orders by subscription ID or user email domain.

```text
subscription_transaction_id:I-34K34LL492G
```

```text
user_email:@acmeco.com
```

--------------------------------

### Column Attribute Examples

Source: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/column-shortcodes

Examples of using column attributes to define grid behavior on different screen sizes.

```text
small="6"
small_offset="3"
medium="6"
medium_offset="2"
large="10"
large_offset="1"
```

--------------------------------

### Regular Icon Shortcode Examples

Source: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/font-awesome-icons

Examples of the [fa] shortcode used to display various regular Font Awesome icons.

```shortcode
[fa type="regular" icon="address-book"]
```

```shortcode
[fa type="regular" icon="address-card"]
```

```shortcode
[fa type="regular" icon="alarm-clock"]
```

```shortcode
[fa type="regular" icon="bell"]
```

```shortcode
[fa type="regular" icon="bell-slash"]
```

```shortcode
[fa type="regular" icon="bookmark"]
```

```shortcode
[fa type="regular" icon="building"]
```

```shortcode
[fa type="regular" icon="calendar"]
```

```shortcode
[fa type="regular" icon="calendar-check"]
```

```shortcode
[fa type="regular" icon="calendar-days"]
```

```shortcode
[fa type="regular" icon="calendar-minus"]
```

```shortcode
[fa type="regular" icon="calendar-plus"]
```

```shortcode
[fa type="regular" icon="calendar-xmark"]
```

```shortcode
[fa type="regular" icon="camera"]
```

```shortcode
[fa type="regular" icon="chart-bar"]
```

```shortcode
[fa type="regular" icon="chess-bishop"]
```

```shortcode
[fa type="regular" icon="chess-king"]
```

```shortcode
[fa type="regular" icon="chess-knight"]
```

```shortcode
[fa type="regular" icon="chess-pawn"]
```

```shortcode
[fa type="regular" icon="chess-queen"]
```

```shortcode
[fa type="regular" icon="chess-rook"]
```

```shortcode
[fa type="regular" icon="circle"]
```

```shortcode
[fa type="regular" icon="circle-check"]
```

```shortcode
[fa type="regular" icon="circle-dot"]
```

```shortcode
[fa type="regular" icon="circle-down"]
```

```shortcode
[fa type="regular" icon="circle-left"]
```

```shortcode
[fa type="regular" icon="circle-pause"]
```

```shortcode
[fa type="regular" icon="circle-play"]
```

```shortcode
[fa type="regular" icon="circle-question"]
```

```shortcode
[fa type="regular" icon="circle-right"]
```

```shortcode
[fa type="regular" icon="circle-stop"]
```

```shortcode
[fa type="regular" icon="circle-up"]
```

```shortcode
[fa type="regular" icon="circle-user"]
```

```shortcode
[fa type="regular" icon="circle-xmark"]
```

```shortcode
[fa type="regular" icon="clipboard"]
```

```shortcode
[fa type="regular" icon="clock"]
```

```shortcode
[fa type="regular" icon="clone"]
```

```shortcode
[fa type="regular" icon="closed-captioning"]
```

```shortcode
[fa type="regular" icon="cloud"]
```

```shortcode
[fa type="regular" icon="comment"]
```

```shortcode
[fa type="regular" icon="comment-dots"]
```

```shortcode
[fa type="regular" icon="comments"]
```

```shortcode
[fa type="regular" icon="compass"]
```

```shortcode
[fa type="regular" icon="copy"]
```

```shortcode
[fa type="regular" icon="copyright"]
```

```shortcode
[fa type="regular" icon="credit-card"]
```

```shortcode
[fa type="regular" icon="envelope"]
```

```shortcode
[fa type="regular" icon="envelope-open"]
```

```shortcode
[fa type="regular" icon="eye"]
```

```shortcode
[fa type="regular" icon="eye-slash"]
```

```shortcode
[fa type="regular" icon="face-angry"]
```

```shortcode
[fa type="regular" icon="face-dizzy"]
```

```shortcode
[fa type="regular" icon="face-flushed"]
```

```shortcode
[fa type="regular" icon="face-frown"]
```

```shortcode
[fa type="regular" icon="face-frown-open"]
```

```shortcode
[fa type="regular" icon="face-grimace"]
```

```shortcode
[fa type="regular" icon="face-grin"]
```

```shortcode
[fa type="regular" icon="face-grin-beam"]
```

```shortcode
[fa type="regular" icon="face-grin-beam-sweat"]
```

```shortcode
[fa type="regular" icon="face-grin-hearts"]
```

```shortcode
[fa type="regular" icon="face-grin-squint"]
```

```shortcode
[fa type="regular" icon="face-grin-squint-tears"]
```

```shortcode
[fa type="regular" icon="face-grin-stars"]
```

```shortcode
[fa type="regular" icon="face-grin-tears"]
```

```shortcode
[fa type="regular" icon="face-grin-tongue"]
```

```shortcode
[fa type="regular" icon="face-grin-tongue-squint"]
```

--------------------------------

### Membership Card Shortcode Example

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/pmpro-membership-card/shortcode

A basic example of the shortcode with custom elements, avatar display, and QR code enabled.

```shortcode
[pmpro_membership_card elements="display_name;Level,membership_name;Member Since,user_registered;Expires,membership_enddate" show_avatar="true" qr_code="true"]
```

--------------------------------

### Liquid Syntax Examples for Email Personalization

Source: https://www.paidmembershipspro.com/documentation/member-emails/templates/admin-change

Examples of using Liquid syntax to format variables, set defaults, and implement conditional logic in email templates.

```liquid
{{ display_name }}
```

```liquid
{{ display_name | upcase }}
```

```liquid
{{ display_name | default: "member" }}
```

```liquid
{% if discount_code_name %} <p>Discount Code: {{ discount_code_name }}</p> {% endif %}
```

```liquid
{% if order_total_raw >= 250 %} <p>Here is your personalized meal plan!</p> {% else %} <p>Thank you for becoming a member!</p> {% endif %}
```

--------------------------------

### Initialization Hook

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/import-members-from-csv-add-on/action-and-filter-hooks

Fires after the Add On has fully initialized, allowing for custom setup code.

```php
do_action( 'pmproiucsv_after_init' );
```

--------------------------------

### Memberlite Subpage List Shortcode Examples

Source: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/subpage-list

Examples of the [memberlite_subpagelist] shortcode used to display subpages with various configurations.

```php
<!-- Show a list of subpages of the page with ID 255585 with an excerpt, sorted by title -->
[memberlite_subpagelist post_parent="255585" link="true" orderby="title" order="ASC" show="excerpt"]

<!-- Show the full content of all children of the current page, without linking -->
[memberlite_subpagelist link="false" show="content"]

<!-- Show a list of links to any page that has the meta_key 'featured' -->
[memberlite_subpagelist meta_key="featured" link="true" link_text="" show="none" post_parent="-1"]
```

--------------------------------

### Implement Memberlite Accordion Shortcode

Source: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/accordions

Example of the structure required to create an accordion with multiple items.

```php
<?php  
/**  
 * Example of using the Memberlite Accordion shortcode.  
 * Learn more at https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/accordions/  
 *  
 * title: Example of the Memberlite Accordion Shortcode.  
 * layout: snippet  
 * collection: memberlite  
 * category: shortcodes  
 * link: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/accordions/  
 *  
 */  
?>  
[memberlite_accordion]  
[memberlite_accordion_item title="Accordion Item Title 1"]This is the first item in the list.[/memberlite_accordion_item]  
[memberlite_accordion_item title="Accordion Item Title 2"]This is the second item in the list.[/memberlite_accordion_item]  
[memberlite_accordion_item title="Accordion Item Title 3"]This is the third item in the list.[/memberlite_accordion_item]  
[memberlite_accordion_item title="Accordion Item Title 4"]This is the fourth item in the list.[/memberlite_accordion_item]  
[memberlite_accordion_item title="Accordion Item Title 5"]This is the fifth item in the list.[/memberlite_accordion_item]  
[/memberlite_accordion]
```

--------------------------------

### Example Cloudflare Nameservers

Source: https://www.paidmembershipspro.com/documentation/hosting-docs/dns

Placeholder format for Cloudflare nameservers provided in support tickets. Use only the specific values provided in your migration ticket.

```text
jason.ns.cloudflare.com  
kim.ns.cloudflare.com
```

--------------------------------

### pmpromd_default_map_start

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/pmpro-member-directory/hooks

Adjust the map starting point location.

```APIDOC
## pmpromd_default_map_start

### Description
Adjust the map starting point location. This gets automatically overridden when there are markers on the map. Accepts an array of coordinates in the format array( 'lat' => -34.397, 'lng' => 150.644 ).

### Parameters
- **$default_start** (array) - The map starting coordinates. Overridden when markers are present.
- **$map_id** (string) - The unique identifier for the map.
```

--------------------------------

### Memberlite Contextual Message Shortcode Examples

Source: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/contextual-messages

Demonstrates various style configurations for the [memberlite_msg] shortcode.

```php
<?php  
/**  
 * Example of using the Memberlite Contextual Message shortcode.  
 * Learn more at https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/contextual-messages/  
 *  
 * title: Example of the Memberlite Contextual Message Shortcode.  
 * layout: snippet  
 * collection: memberlite  
 * category: shortcodes  
 * link: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/contextual-messages/  
 *  
 */  
?>  
[memberlite_msg style="default" text="Default Message"]  
   
[memberlite_msg style="success" text="Success Message"]  
   
[memberlite_msg style="alert" text="Alert Message"]  
   
[memberlite_msg style="error" text="Error Message"]  
   
[memberlite_msg style="info" text="Info Message"]
```

--------------------------------

### Memberlite Font Awesome Icon Shortcode Examples

Source: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/font-awesome-icons

Demonstrates various configurations of the [fa] shortcode including animation, rotation, color, and sizing options.

```php
[fa icon="heart" animate="beat"]
   
[fa icon="sync" animate="spin"]
   
[fa icon="arrow-right" rotate="90"]
   
[fa icon="check-circle" color="success" size="lg"]
   
[fa icon="exclamation-circle" color="error" size="2x"]
```

--------------------------------

### Memberlite Button Shortcode Usage

Source: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/buttons

Examples of the [memberlite_btn] shortcode demonstrating various style configurations.

```php
<?php  
/**
 * Example of using the Memberlite Button shortcode.
 * Learn more at https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/buttons/
 *
 * title: Example of the Memberlite Button Shortcode.
 * layout: snippet
 * collection: memberlite
 * category: shortcodes
 * link: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/buttons/
 *
 */
?>
[memberlite_btn style="success" href="/blog/" text="Success Button" target="self"]
   
[memberlite_btn style="alert" href="/blog/" text="Alert Button" target="self"]
   
[memberlite_btn style="error" href="/blog/" text="Error Button" target="self"]
   
[memberlite_btn style="info" href="/blog/" text="Info Button" target="self"]
   
[memberlite_btn style="link" href="/blog/" text="Link Button" target="self"]
   
[memberlite_btn style="default" href="/blog/" text="Default Button" target="self"]
   
[memberlite_btn style="primary" href="/blog/" text="Primary Button" target="self"]
   
[memberlite_btn style="secondary" href="/blog/" text="Secondary Button" target="self"]
   
[memberlite_btn style="action" href="/blog/" text="Action Button" target="self"]
```

--------------------------------

### memberlite_before_footer Action Hook

Source: https://www.paidmembershipspro.com/documentation/memberlite/action-hook

Executes before where the .site-footer wrapper starts.

```php
do_action( 'memberlite_before_footer' );
```

--------------------------------

### Basic Checkout Button Shortcode

Source: https://www.paidmembershipspro.com/documentation/shortcodes/general-shortcodes/pmpro_checkout_button-shortcode

Example of the shortcode usage with defined class, level ID, and custom button text.

```text
[pmpro_checkout_button class="pmpro_btn" level="1" text="Buy Now"]
```

--------------------------------

### Memberlite Row and Column Shortcode Layouts

Source: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/column-shortcodes

Use these shortcodes to create responsive grid layouts. The example includes standard columns, centered columns, and nested row structures.

```php
<?php  
/**  
 * Example of using the Memberlite Row and Columns shortcode.  
 * Learn more at https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/column-shortcodes/  
 *  
 * title: Example of the Memberlite Row and Columns Shortcode.  
 * layout: snippet  
 * collection: memberlite  
 * category: shortcodes  
 * link: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/column-shortcodes/  
 *  
 */  
?>  
   
[row]  
[col medium="4" class="bg_secondary"]  
   
<span class="has-text-color has-white-color">1/3 column</span>  
   
[/col]  
[col medium="8" class="bg_primary"]  
   
<span class="has-text-color has-white-color">2/3 column</span>  
   
[/col]  
[/row]  
   
[row]  
[col medium="6" class="bg_action"]  
   
<span class="has-text-color has-white-color">1/2 column</span>  
   
[/col]  
[col medium="6" class="bg_primary"]  
   
<span class="has-text-color has-white-color">1/2 column</span>  
   
[/col]  
[/row]  
   
[row]  
[col medium="6" medium_offset="3" class="bg_primary"]  
   
<span class="has-text-color has-white-color">1/2 centered column</span>  
   
[/col]  
[/row]  
   
[row]  
[col medium="6" class="bg_primary"]  
   
<span class="has-text-color has-white-color">1/2 column</span>  
   
[/col]  
[col medium="6" class="bg_primary"]  
   
[row_row]  
[col_col medium="4" class="bg_secondary"]  
   
<span class="has-text-color has-white-color">Nested column</span>  
   
[/col_col]  
[col_col medium="8" class="bg_action"]  
   
<span class="has-text-color has-white-color">Nested column</span>  
   
[/col_col]  
[/row_row]  
   
[/col]  
[/row]
```

--------------------------------

### Font Awesome Shortcode Examples

Source: https://www.paidmembershipspro.com/documentation/memberlite/memberlite-shortcodes/font-awesome-icons

Use these shortcodes to display specific Font Awesome icons in your content.

```shortcode
[fa type="regular" icon="face-grin-tongue-wink"]
```

```shortcode
[fa type="regular" icon="face-grin-wide"]
```

```shortcode
[fa type="regular" icon="face-grin-wink"]
```

```shortcode
[fa type="regular" icon="face-kiss"]
```

```shortcode
[fa type="regular" icon="face-kiss-beam"]
```

```shortcode
[fa type="regular" icon="face-kiss-wink-heart"]
```

```shortcode
[fa type="regular" icon="face-laugh"]
```

```shortcode
[fa type="regular" icon="face-laugh-beam"]
```

```shortcode
[fa type="regular" icon="face-laugh-squint"]
```

```shortcode
[fa type="regular" icon="face-laugh-wink"]
```

```shortcode
[fa type="regular" icon="face-meh"]
```

```shortcode
[fa type="regular" icon="face-meh-blank"]
```

```shortcode
[fa type="regular" icon="face-rolling-eyes"]
```

```shortcode
[fa type="regular" icon="face-sad-cry"]
```

```shortcode
[fa type="regular" icon="face-sad-tear"]
```

```shortcode
[fa type="regular" icon="face-smile"]
```

```shortcode
[fa type="regular" icon="face-smile-beam"]
```

```shortcode
[fa type="regular" icon="face-smile-wink"]
```

```shortcode
[fa type="regular" icon="face-surprise"]
```

```shortcode
[fa type="regular" icon="face-tired"]
```

```shortcode
[fa type="regular" icon="file"]
```

```shortcode
[fa type="regular" icon="file-audio"]
```

```shortcode
[fa type="regular" icon="file-code"]
```

```shortcode
[fa type="regular" icon="file-excel"]
```

```shortcode
[fa type="regular" icon="file-image"]
```

```shortcode
[fa type="regular" icon="file-lines"]
```

```shortcode
[fa type="regular" icon="file-pdf"]
```

```shortcode
[fa type="regular" icon="file-powerpoint"]
```

```shortcode
[fa type="regular" icon="file-video"]
```

```shortcode
[fa type="regular" icon="file-word"]
```

```shortcode
[fa type="regular" icon="file-zipper"]
```

```shortcode
[fa type="regular" icon="flag"]
```

```shortcode
[fa type="regular" icon="floppy-disk"]
```

```shortcode
[fa type="regular" icon="folder"]
```

```shortcode
[fa type="regular" icon="folder-closed"]
```

```shortcode
[fa type="regular" icon="folder-open"]
```

```shortcode
[fa type="regular" icon="font-awesome"]
```

```shortcode
[fa type="regular" icon="futbol"]
```

```shortcode
[fa type="regular" icon="gem"]
```

```shortcode
[fa type="regular" icon="hand"]
```

```shortcode
[fa type="regular" icon="hand-back-fist"]
```

```shortcode
[fa type="regular" icon="hand-lizard"]
```

```shortcode
[fa type="regular" icon="hand-peace"]
```

```shortcode
[fa type="regular" icon="hand-point-down"]
```

```shortcode
[fa type="regular" icon="hand-point-left"]
```

```shortcode
[fa type="regular" icon="hand-point-right"]
```

```shortcode
[fa type="regular" icon="hand-point-up"]
```

```shortcode
[fa type="regular" icon="hand-pointer"]
```

```shortcode
[fa type="regular" icon="hand-scissors"]
```

```shortcode
[fa type="regular" icon="hand-spock"]
```

```shortcode
[fa type="regular" icon="handshake"]
```

```shortcode
[fa type="regular" icon="hard-drive"]
```

```shortcode
[fa type="regular" icon="headphones"]
```

```shortcode
[fa type="regular" icon="heart"]
```

```shortcode
[fa type="regular" icon="hospital"]
```

```shortcode
[fa type="regular" icon="hourglass"]
```

```shortcode
[fa type="regular" icon="hourglass-half"]
```

```shortcode
[fa type="regular" icon="house"]
```

```shortcode
[fa type="regular" icon="id-badge"]
```

```shortcode
[fa type="regular" icon="id-card"]
```

```shortcode
[fa type="regular" icon="image"]
```

```shortcode
[fa type="regular" icon="images"]
```

```shortcode
[fa type="regular" icon="keyboard"]
```

```shortcode
[fa type="regular" icon="lemon"]
```

```shortcode
[fa type="regular" icon="life-ring"]
```

```shortcode
[fa type="regular" icon="lightbulb"]
```

```shortcode
[fa type="regular" icon="map"]
```

```shortcode
[fa type="regular" icon="message"]
```

```shortcode
[fa type="regular" icon="money-bill-1"]
```

```shortcode
[fa type="regular" icon="moon"]
```

```shortcode
[fa type="regular" icon="newspaper"]
```

```shortcode
[fa type="regular" icon="note-sticky"]
```

```shortcode
[fa type="regular" icon="object-group"]
```

```shortcode
[fa type="regular" icon="object-ungroup"]
```

```shortcode
[fa type="regular" icon="paper-plane"]
```

```shortcode
[fa type="regular" icon="paste"]
```

```shortcode
[fa type="regular" icon="pen-to-square"]
```

```shortcode
[fa type="regular" icon="rectangle-list"]
```

```shortcode
[fa type="regular" icon="rectangle-xmark"]
```

```shortcode
[fa type="regular" icon="registered"]
```

```shortcode
[fa type="regular" icon="share-from-square"]
```

```shortcode
[fa type="regular" icon="snowflake"]
```

--------------------------------

### Instantiate PMPro_Discount_Code

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/pmpro-discount-code-class

Create a new instance of the PMPro_Discount_Code class.

```php
$discount_code = new PMPro_Discount_Code();
```

--------------------------------

### pmproiucsv_after_init

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/import-members-from-csv-add-on/action-and-filter-hooks

Action hook that fires after the Add On has fully initialized.

```APIDOC
## do_action( 'pmproiucsv_after_init' )

### Description
Fires after the Add On has fully initialized, allowing developers to run custom code once all core plugin setup is complete.
```

--------------------------------

### View Available CLI Commands

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/pmpro-toolkit/cli-commands

Displays the help menu for the pmpro-toolkit CLI commands.

```bash
wp help pmpro-toolkit
```

--------------------------------

### GET /wp-json/pmpro/v1/cancel_membership_level

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Cancels a user's membership level.

```APIDOC
## GET /wp-json/pmpro/v1/cancel_membership_level

### Description
This method allows you to cancel a user's membership level.

### Method
GET

### Endpoint
/wp-json/pmpro/v1/cancel_membership_level

### Parameters
#### Query Parameters
- **user_id** (int) - Optional - The ID of the user whose membership level you want to cancel.
- **email** (string) - Optional - The email address of the user whose membership level you want to cancel.
- **level_id** (int) - Required - The ID of the level you would like to cancel.

### Response
#### Success Response (200)
- **boolean** - Returns true if the level cancellation was completed, false otherwise.
```

--------------------------------

### Comparison Operators

Source: https://www.paidmembershipspro.com/documentation/member-emails/liquid-syntax

Examples of comparison operators used within if statements.

```liquid
{% if membership_level_name == "Gold" %}
```

```liquid
{% if discount_code != "" %}
```

```liquid
{% if order_total_raw > 100 %}
```

```liquid
{% if order_total_raw < 50 %}
```

```liquid
{% if order_total_raw >= 100 %}
```

```liquid
{% if order_total_raw <= 50 %}
```

--------------------------------

### GET /wp-json/pmpro/v1/order

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Retrieves an order object for a specified order code.

```APIDOC
## GET /wp-json/pmpro/v1/order

### Description
Returns an order object for the specified order code. Requires the pmpro_orders capability, though members can retrieve their own orders.

### Method
GET

### Endpoint
https://example.com/wp-json/pmpro/v1/order

### Parameters
#### Query Parameters
- **code** (string) - Required - The order code (e.g., 'ORD-ABC123').

### Response
#### Success Response (200)
- **id, code, user_id, membership_id, billing, subtotal, tax, total, payment_type, cardtype, accountnumber, expirationmonth, expirationyear, status, gateway, gateway_environment, payment_transaction_id, subscription_transaction_id, timestamp, affiliate_id, affiliate_subid, notes, checkout_id** (object) - The order object containing these fields.
```

--------------------------------

### GET /wp-json/pmpro/v1/discount_code

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Retrieves, updates, or creates a discount code object.

```APIDOC
## GET /wp-json/pmpro/v1/discount_code

### Description
Returns the full PMPro_Discount_Code object for a specified code. Can also be used to update or create discount codes by including additional parameters.

### Method
GET

### Endpoint
https://example.com/wp-json/pmpro/v1/discount_code

### Parameters
#### Query Parameters
- **code** (string) - Required - The code value (e.g., 'SAVE50') of the discount code object to return or modify.
```

--------------------------------

### Display all site courses with shortcode

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/courses-for-membership-add-on/default-module/shortcode-and-block

Use this shortcode to list all courses available on the site, regardless of user access level.

```shortcode
[pmpro_all_courses limit="10"]
```

--------------------------------

### GET /wp-json/pmpro/v1/membership_level

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Retrieves, creates, or updates a membership level object.

```APIDOC
## GET /wp-json/pmpro/v1/membership_level

### Description
This method returns the full PMPro_Membership_Level object for the specified level_id. It can also be used to update or create a new level when additional parameters are provided.

### Method
GET

### Endpoint
/wp-json/pmpro/v1/membership_level

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the PMPro_Membership_Level object you would like to return or modify.

### Response
#### Success Response (200)
- **object** - Returns the PMPro_Membership_Level object for the requested level ID.
```

--------------------------------

### Action pmpro_courses_module_settings

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/courses-for-membership-add-on/action-and-filter-hooks

Output custom settings fields within the module settings UI.

```php
do_action( 'pmpro_courses_module_settings', $module );
```

--------------------------------

### GET /wp-json/pmpro/v1/get_membership_level_for_user

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Retrieves the membership level object for a specific user.

```APIDOC
## GET /wp-json/pmpro/v1/get_membership_level_for_user

### Description
Retrieves the membership level object for a user identified by their ID or email address.

### Method
GET

### Endpoint
/wp-json/pmpro/v1/get_membership_level_for_user

### Parameters
#### Query Parameters
- **user_id** (integer) - Optional - The ID of the user whose membership level you want to check.
- **email** (string) - Optional - The email address of the user whose membership level you want to check.

### Response
#### Success Response (200)
- **$level** (object) - The membership level object for the user.
```

--------------------------------

### GET /pmpro/v1/post_restrictions

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Retrieves the current membership level restrictions for a specific post.

```APIDOC
## GET /pmpro/v1/post_restrictions

### Description
Returns the membership level IDs restricting a given post.

### Method
GET

### Endpoint
/pmpro/v1/post_restrictions

### Parameters
#### Query Parameters
- **post_id** (integer) - Required - The ID of the post to retrieve restrictions for.

### Response
#### Success Response (200)
- **membership_id** (array) - An array of objects representing levels restricting the post.
```

--------------------------------

### GET /wp-json/pmpro/v1/get_membership_levels_for_user

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Retrieves an array of membership level objects for a specific user.

```APIDOC
## GET /wp-json/pmpro/v1/get_membership_levels_for_user

### Description
Retrieves an array of membership level objects for a user identified by their ID or email address.

### Method
GET

### Endpoint
/wp-json/pmpro/v1/get_membership_levels_for_user

### Parameters
#### Query Parameters
- **user_id** (integer) - Optional - The ID of the user whose membership levels you want to check.
- **email** (string) - Optional - The email address of the user whose membership levels you want to check.

### Response
#### Success Response (200)
- **$levels** (array) - An array of membership level objects for the user.
```

--------------------------------

### Retrieve order timestamp

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/memberorder-class

Gets the order timestamp, optionally formatted as GMT.

```php
$order = new MemberOrder();
$order_date = $order->getTimeStamp( true );
```

--------------------------------

### Define Constructor Parameters

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/pmpro-discount-code-class

The constructor accepts an optional string parameter representing the discount code or ID.

```php
string $code = null
```

--------------------------------

### GET /wp-json/pmpro/v1/membership_levels

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Retrieves an array of all PMPro_Membership_Level objects for the site, including inactive levels.

```APIDOC
## GET /wp-json/pmpro/v1/membership_levels

### Description
Returns an array of all membership level objects. This endpoint is publicly accessible and requires no authentication.

### Method
GET

### Endpoint
https://example.com/wp-json/pmpro/v1/membership_levels
```

--------------------------------

### GET /wp-json/pmpro/v1/has_membership_access

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Checks whether a specific user has membership access to a given post.

```APIDOC
## GET /wp-json/pmpro/v1/has_membership_access

### Description
Tests whether a user has access to specified content based on their membership level.

### Method
GET

### Endpoint
/wp-json/pmpro/v1/has_membership_access

### Parameters
#### Query Parameters
- **post_id** (integer) - Required - The ID of the post to check access for.
- **user_id** (integer) - Optional - The ID of the user to check.
- **email** (string) - Optional - The email address of the user to check.

### Response
#### Success Response (200)
- **result** (boolean) - Returns true if the user has access, false otherwise.
```

--------------------------------

### Instantiate MemberOrder Class

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/memberorder-class

Create a new instance of the MemberOrder class. Use an empty constructor for a blank object or pass an ID or order code to retrieve existing data.

```php
$order = new MemberOrder();
```

```php
$membership_level = new MemberOrder( '1' );
```

```php
$membership_level = new MemberOrder( 'FF453F9B1A' );
```

--------------------------------

### POST export/start

Source: https://www.paidmembershipspro.com/documentation/advanced/api/rest-api

Initiates a CSV export for members or orders. Returns a download URL for small datasets or an export ID for asynchronous processing.

```APIDOC
## POST export/start

### Description
Initiates a CSV export for the specified type. For small datasets, the export runs synchronously and returns a `download_url` immediately. For larger datasets, it runs asynchronously via Action Scheduler and returns an `export_id`.

### Method
POST

### Endpoint
/pmpro/v1/export/start

### Parameters
#### Query Parameters
- **type** (string) - Required - Export type. Accepted values: `members`, `orders`.
- **l** (int/string) - Optional - Filter by membership level ID.
- **s** (string) - Optional - Search string to filter results.
- **force_async** (boolean) - Optional - Force background processing even for small datasets.

### Response
#### Success Response (200)
- **export_id** (string) - ID for polling status (if async).
- **type** (string) - The export type.
- **status** (string) - Current status (e.g., `complete`, `running`).
- **total_count** (int) - Total records to export.
- **processed_count** (int) - Records processed so far.
- **download_url** (string) - URL to download the file (if status is `complete`).

#### Error Response
- **error** (string) - Description of the problem.
```

--------------------------------

### Get TOS Consent Log

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/memberorder-class

Retrieves the terms of service consent history for the order.

```php
$order = new MemberOrder( 14 );
$tos_log = $order->get_tos_consent_log_entry();
```

--------------------------------

### get_membership_level_categories( $id )

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/pmpro-membership-level-class

Gets post categories that should be restricted to the passed membership level ID.

```APIDOC
## get_membership_level_categories( $id )

### Description
Gets posts categories that should be restricted to the passed membership level ID by querying the pmpro_memberships_categories table.

### Parameters
- **$id** (string) - Required - The membership level to get categories for.

### Return
array of category strings to restrict.
```

--------------------------------

### pmpro_courses_module_settings

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/courses-for-membership-add-on/action-and-filter-hooks

Action hook to output custom settings fields in the module UI.

```APIDOC
## do_action( 'pmpro_courses_module_settings', $module )

### Description
Fires inside the settings page UI for each active module. Use this to output custom settings fields.
```

--------------------------------

### memberlite_after_site_info Action Hook

Source: https://www.paidmembershipspro.com/documentation/memberlite/action-hook

Executes after the .site-info copyright area wrapper in the default footer.

```php
do_action( 'memberlite_after_site_info' );
```

--------------------------------

### process()

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/memberorder-class

Triggers the payment gateway processing step for the order.

```APIDOC
## process()

### Description
Calls the process step of the associated gateway class.

### Returns
- **result** (mixed) - The results returned by the gateway's process method.
```

--------------------------------

### Convert WebP images via WP-CLI

Source: https://www.paidmembershipspro.com/documentation/hosting-docs/admin-panels/webp-images

Triggers a background batch job to generate WebP versions for existing media library images.

```bash
wp pmpro-hosting webp-convert
```

--------------------------------

### Get an empty discount code object

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/pmpro-discount-code-class

Initializes an empty discount code object template.

```php
$discount_code = new PMPro_Discount_Code();
$discount_code->get_empty_discount_code( 'S0DE87D5119' );
```

--------------------------------

### Instantiate PMPro_Membership_Level

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/pmpro-membership-level-class

Create a new instance of the membership level class.

```php
$membership_level = new PMPro_Membership_Level();
```

--------------------------------

### Get restricted categories

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/pmpro-membership-level-class

Retrieves an array of category IDs restricted to a specific membership level.

```php
$membership_level = new PMPro_Membership_Level();
$categories = $membership_level->get_membership_level_categories( '1' );
```

--------------------------------

### Filter Default Map Starting Point

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/pmpro-member-directory/hooks

Adjusts the initial map coordinates, which are overridden if markers are present.

```php
apply_filters( 'pmpromd_default_map_start', array $default_start, $map_id );
```

--------------------------------

### pmproiucsv_pre_user_import

Source: https://www.paidmembershipspro.com/documentation/add-on-docs/import-members-from-csv-add-on/action-and-filter-hooks

Action hook that fires immediately before a single user is imported.

```APIDOC
## do_action( 'pmproiucsv_pre_user_import', $userdata, $usermeta, $user )

### Description
Fires immediately before a single user is imported, allowing developers to modify or act on the user data and metadata before creation or update.
```

--------------------------------

### Retrieve Membership Level at Checkout

Source: https://www.paidmembershipspro.com/documentation/advanced/classes/memberorder-class

Gets the membership level object as it existed at the time of checkout for the order.

```php
$order = new MemberOrder();
$level = $order->getMembershipLevelAtCheckout( true );
```
Tokens:
Raw