s2Member

https://s2member.com/kb/
Admin
s2Member is a WordPress plugin that provides membership control, user registration, and payment...
Tokens:140,740
Snippets:2,368
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example One-Time-Offer Configuration File

Source: https://s2member.com/kb-article/configuring-s2member-general-options

Provides examples of how to structure a One-Time-Offer configuration file. It demonstrates offers for all users on specific logins, and offers for specific access levels.

```plaintext
1:http://example.com/your-first-login/  
25:http://example.com/customer-loyalty-reward/  
3:1:http://example.com/upgrade-to-level-2/ (displayed on 3rd login, to Level #1 Members only)  
1:0:http://example.com/upgrade-to-level-1/  

```

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

### Example Coupon Codes for Import

Source: https://s2member.com/kb-article/is-it-possible-to-import-coupon-codes

This example file demonstrates how to list multiple coupon codes with different configurations, including discounts, date ranges, and usage restrictions.

```text
SAVE5PERCENT|5%
SAVE10|10
CHRISTMAS2015|25%|2015-12-01~2016-01-01
JULY4TH|40%|2015-07-04~2015-07-05|ta-only|1||1000
SAVE20|20|~2015-10-03|ta-only|||1000

```

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

### Example User Import Row

Source: https://s2member.com/kb-article/importingupdating-users

A complete example of a single row in a user import CSV file, demonstrating how to populate all fields, including custom ones.

```csv
"","johnsmith22","mY!passwrD","John","Smith","John Smith","john.smith@example.com","http://www.example.com/","2","music,videos","12/31/2000","01/10/2001","12/31/2020","12/31/2021","www.example.com|123.357.125.654","I-2342934SSER243","paypal","fishing,biking,computers","xx-large"

```

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

### New User Import Line Example

Source: https://s2member.com/kb-article/importingupdating-users

Example of a single line in a CSV file for importing a new user. The 'ID' field is left empty for new user creation.

```csv
"","johndoe22","8834ks9903","John","Doe","John Doe","johndoe22@example.com"
```

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

### Example WordPress Pages for Username Redirection

Source: https://s2member.com/kb-article/customizing-your-login-welcome-page

These are example WordPress page URLs that would be created to match the dynamic redirection URL based on specific usernames.

```text
http://www.example.com/johndoe22-account-page
http://www.example.com/maryjane-account-page
http://www.example.com/billybob-account-page
http://www.example.com/acmecorp-account-page
```

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

### CSV Import Example with Specific Custom Fields

Source: https://s2member.com/kb-article/importingupdating-users

Example demonstrating the CSV structure for importing specific custom fields like 'interests', 't_shirt_size', and 'zipcode'. Values must be in alphabetical order of their IDs.

```csv
...,"fishing,biking,computers","xx-large","30052"

```

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

### Full s2Member Pro-Form Example with Fixed EOT

Source: https://s2member.com/kb-article/how-do-you-create-a-subscription-that-ends-on-a-fixed-date

This is a complete example combining the PHP logic for calculating days until a fixed EOT with an s2Member Pro-Form shortcode. It ensures that all subscriptions end on '31 October 2025'. This example is for PayPal Pro-Forms but can be adapted for Authorize.Net or Stripe.

```php
[php]
    $now = strtotime('now'); // The time now (in seconds).
    $fixed_eot_time = strtotime('31 October 2025'); // Future time (in seconds).
    $days_until_fixed_eot_time = round(($fixed_eot_time - $now) / DAY_IN_SECONDS);
    // ↑ This is where we calculate the number of days until an EOT should occur.
[/php]

[s2Member-Pro-PayPal-Form level="1" desc="$0.01 USD / Access Until October 31st, 2025" ra="0.01" rr="BN" rt="D" rp="[php]echo $days_until_fixed_eot_time;[/php]" /]
```

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

### Example s2Member Meta Fields in Export

Source: https://s2member.com/kb-article/advanced-importexport-tools

This snippet shows example CSV headers and corresponding data for s2Member-related meta fields. It illustrates the 'meta_key__' prefix used to classify these fields.

```csv
"meta_key__wp_s2member_custom","meta_key__wp_s2member_subscr_id","meta_key__wp_s2member_subscr_baid","meta_key__wp_s2member_subscr_cid","meta_key__wp_s2member_subscr_gateway","meta_key__wp_s2member_registration_ip","meta_key__wp_s2member_ipn_signup_vars","meta_key__wp_s2member_paid_registration_times","meta_key__wp_s2member_access_cap_times","meta_key__wp_s2member_sp_references","meta_key__wp_s2member_last_status_scan","meta_key__wp_s2member_first_payment_txn_id","meta_key__wp_s2member_last_payment_time","meta_key__wp_s2member_auto_eot_time","meta_key__wp_s2member_file_download_access_arc","meta_key__wp_s2member_file_download_access_log"
"www.example.com","9983JKSD03343","2098234DF","980234LSEFJ","stripe","123.456.789.0","{private: JSON object}","{ \"level\":1406275414, \"level1\":1406275414}","{ \"1406275414.0001\":\"level1\"}","{private: JSON object}","1406271660","90823GAUI92323F","1406554660","1406271700","{private: JSON object}","{private: JSON object}"
```

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

### Example WordPress Pages for Membership Level Redirection

Source: https://s2member.com/kb-article/customizing-your-login-welcome-page

These are example WordPress page URLs that would be created to match the dynamic redirection URL based on specific membership levels.

```text
http://www.example.com/0-account-page
http://www.example.com/1-account-page
http://www.example.com/2-account-page
http://www.example.com/3-account-page
http://www.example.com/4-account-page
```

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

### Basic Content Dripping

Source: https://s2member.com/kb-article/s2drip-shortcode

Use this snippet to display content to members at a specific level or higher, starting from a certain day of their membership. The content remains visible indefinitely after the specified start day.

```shortcode
[s2Drip access="level1" from_day="4"]
    Some content for Members at Level 1 (or higher).

    This content will show only after day 3 of their paid membership.
        ~ i.e. it starts showing on day 4.

    It will continue to be shown every day thereafter.
[/s2Drip]
```

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

### JW Player Sharing and Logo Example

Source: https://s2member.com/kb-article/s2stream-shortcode-documentation

Configures both social sharing and adds a logo with a link to the JW Player. The logo will be displayed on the player.

```html
[s2Stream player_option_blocks="sharing:{},logo:{file:'/logo.png',link:'http://example.com'}"]
```

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

### s2Member Import Format with Optional Fields

Source: https://s2member.com/kb-article/migrating-from-other-software-to-s2member

An extended example showing all possible fields for s2Member import, including subscription and custom field data.

```csv
"ID","Username","Password","First Name","Last Name","Display Name","Email","Website","Level[0-9]+ or Role ID","Custom Capabilities","Registration Date ( mm/dd/yyyy )","First Payment Date ( mm/dd/yyyy )","Last Payment Date ( mm/dd/yyyy )","Auto-EOT Date ( mm/dd/yyyy )","Custom Value ( starts w/domain )","Paid Subscr. ID","Paid Subscr. Gateway","Custom Field ID #1","Custom Field Value #1","Custom Field ID #2","Custom Field Value #2", ...

```

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

### Sample s2Member Import Data for Three Users

Source: https://s2member.com/kb-article/migrating-from-other-software-to-s2member

This example demonstrates importing three users with basic information, s2Member Levels, and subscription IDs. Empty password fields will result in auto-generated passwords.

```csv
"", "johnsmith22", "", "John", "Smith", "John Smith", "john.smith@example.com", "", "2", "", "", "", "", "", "", "I-2342934SSER243", "paypal", "", "", "", ""
"", "janedoe11", "", "Jane", "Doe", "Jane Doe", "jane.doe@example.com", "", "3", "", "", "", "", "", "", "I-2426974EEFR216", "paypal", "", "", "", ""
"", "tombradley84", "", "Tom", "Bradley", "Tom Bradley", "tom.bradley@example.com", "", "0", "", "", "", "", "", "", "", "", "", "", "", "", ""

```

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

### JW Player v6 Skin Example

Source: https://s2member.com/kb-article/s2stream-shortcode-documentation

Specify a custom skin for JW Player v6 using the player_skin attribute.

```shortcode
player_skin="/jwplayer/my-skin.xml"
```

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

### Display Access Expires and Next Payment

Source: https://s2member.com/kb-article/s2eot-shortcode-documentation

Use these examples to display fixed EOT or NPT based on the mode attribute. The default behavior for each mode is to output only the date.

```shortcode
[s2Eot mode="fixed" /]
```

```shortcode
[s2Eot mode="next" /]
```

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

### JW Player General Attributes Examples

Source: https://s2member.com/kb-article/s2stream-shortcode-documentation

Examples of common JW Player attributes that can be passed via the s2Stream shortcode.

```shortcode
player_key="my-license-key"
```

```shortcode
player_width="480"
```

```shortcode
player_height="270"
```

```shortcode
player_title="My Video"
```

```shortcode
player_description="A video about something."
```

```shortcode
player_image="http://www.example.com/video-preview.jpg"
```

```shortcode
player_mediaid="ei0wsx23"
```

```shortcode
player_autostart="true"
```

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

### Using PHP in WordPress

Source: https://s2member.com/kb-article/introduction-to-s2member

Example of using PHP within WordPress Posts, Pages, or Text Widgets with a plugin like ezPHP.

```php
<?php
// Example usage of PHP for s2Member customizations
// This would typically be within a plugin or theme file,
// or a shortcode provided by a plugin like ezPHP.

// Example: Accessing a user field via s2Member API (conceptual)
// $user_id = get_current_user_id();
// $custom_field_value = s2member_get_user_field($user_id, 'your_custom_field_name');

// Example: Using a shortcode within PHP (conceptual)
// echo do_shortcode('[s2Member-List /]');
?>
```

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

### Mass-Update User Line Example

Source: https://s2member.com/kb-article/importingupdating-users

Example of a single line in a CSV file for mass-updating an existing user. The 'ID' field contains the WordPress User ID of the account to be updated.

```csv
"123","johndoe22","8834ks9903","John","Doe","John Doe","johndoe22@example.com"
```

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

### Basic PHP Conditional Tag Example

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

This shows a fundamental example of using PHP's `if` statement for conditional logic, demonstrating how s2Member's shortcodes are built upon standard PHP conditional structures.

```php
<?php
if ( is_user_logged_in() ) {
    echo 'Welcome back!';
}
?>
```

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

### Displaying EOT/NPT with HTML Markup

Source: https://s2member.com/kb-article/s2eot-shortcode-documentation

This example shows the rich text output with HTML markup and CSS classes for the [s2Eot /] shortcode, allowing for easy customization of the displayed date and label.

```html
<strong class="s2member-sc-eot-label -future">Access Expires:</strong> <span class="s2member-sc-eot-date -future">Jul 16th, 2025, 12:00 am UTC</span>
```

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

### JW Player Skinning Example

Source: https://s2member.com/kb-article/s2stream-shortcode-documentation

Use this attribute to apply a custom skin to JW Player v7. Ensure you are using JW Player v7 for this option.

```html
[s2Stream player_option_blocks="skin:{name:'myskin'}"]
```

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

### CRON Job URL Example

Source: https://s2member.com/kb-article/rolescapabilities-via-php

This is the URL to trigger the automated user role change script. Ensure you use a secure, secret key.

```text
http://example.com/?my_cron_job=secret-cron-job-key

```

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

### JW Player Sharing Functionality Example

Source: https://s2member.com/kb-article/s2stream-shortcode-documentation

Enables social sharing functionality for the JW Player. This is a basic configuration for sharing.

```html
[s2Stream player_option_blocks="sharing:{}"]
```

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

### Importing a New User via CSV Format

Source: https://s2member.com/kb-article/basic-usermember-importexport-guide

This is an example of the CSV format required to import a new user. The first field is empty to indicate a new user creation. Ensure the data matches the specified columns: Username, Password, First Name, Last Name, Display Name, and Email.

```csv
"","Username","Password","First Name","Last Name","Display Name","Email"

```

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

### Example s2Member Coupon Import File Format

Source: https://s2member.com/kb-article/is-it-possible-to-import-coupon-codes

This is the format for the text file used to import coupon codes. Each line represents a coupon with various parameters.

```text
code|discount|start(YYYY-MM-DD)~end(YYYY-MM-DD)|directive|singulars|users|max-uses

```

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

### Basic WordPress MU Plugin Webhook Handler

Source: https://s2member.com/kb-article/building-an-api-notification-handler-webhook

This basic MU plugin checks for specific GET parameters in the URL to identify a payment notification and then exits WordPress execution. It's a starting point for handling webhook requests.

```php
<?php
add_action('init', 's2_payment_notification');
function s2_payment_notification()
    {
        if(!empty($_GET['s2_payment_notification']) && $_GET['s2_payment_notification'] === 'yes') 
        // ↑ In my URL, I have `?s2_payment_notification=yes`, that's what I'm looking for here.
            {
                if(!empty($_GET['user_id']) && !empty($_GET['item_number']))
                // In my URL, I have `&user_id=%%user_id%%&item_number=%%item_number%%`, that's what I'm looking for here.
                    {
                        // Here I might perform any number of tasks related to this user.
                    }
                exit; // We can exit here. There's no reason to continue loading WordPress in this case.
            }
    }


```

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

### Testing for Custom Capabilities

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

This example shows how to use [s2If /] to check if a logged-in user possesses specific custom capabilities, often used for role-based access control beyond standard levels.

```shortcode
[s2If capability='edit_posts']
This content is visible to users who can edit posts.
[/s2If]
```

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

### Combining Conditionals with Other Shortcodes

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

This example demonstrates nesting or combining [s2If /] shortcodes with other WordPress or s2Member shortcodes to create intricate content display logic.

```shortcode
[s2If is_user_logged_in()]
[s2If level1]
This content is for logged-in Level 1 members only.
[/s2If]
[/s2If]
```

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

### Implementing AND Conditional Expressions

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

This example shows how to create an 'AND' condition, where content is displayed only if multiple criteria are met simultaneously. It uses a comma-separated list within the shortcode attribute.

```shortcode
[s2If groups='group1,group2' level1]
This content is visible only if the user is in group1 AND has Level 1.
[/s2If]
```

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

### Basic s2MOP Messages

Source: https://s2member.com/kb-article/s2mop-shortcode

Use these examples to display generic messages when a user attempts to access protected content. The messages can be customized using placeholders like %%SEEKING_TYPE%%, %%REQUIRED_TYPE%%, and %%RESTRICTION_TYPE%%.

```html
[s2MOP]You were trying to access a protected: %%SEEKING_TYPE%%[/s2MOP]
```

```html
[s2MOP]You were trying to access content that requires a %%REQUIRED_TYPE%% that you don't have.[/s2MOP]
```

```html
[s2MOP]You were trying to access content protected via %%RESTRICTION_TYPE%% restrictions[/s2MOP]
```

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

### Set Custom Capabilities for a Post

Source: https://s2member.com/kb-article/rolescapabilities-via-php

This example sets custom capability requirements ('pro', 'unlimited') for a specific post using `update_post_meta`. The post ID is 123.

```php
<?php
$ccaps_required = array('pro', 'unlimited');
update_post_meta(123, 's2member_ccaps_req', $ccaps_required);


```

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

### Access for Members with Level 1 or Higher

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

This example restricts content access to members who have a s2Member Level of 1 or greater. It's ideal for tiered access based on membership level.

```shortcode
[s2If level0]
This content is visible to anyone with a Level 0 membership or higher.
[/s2If]
```

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

### JW Player Base64 Encoded Sharing Example

Source: https://s2member.com/kb-article/s2stream-shortcode-documentation

Provides a base64 encoded version of the sharing option block. This is useful for complex configurations or to avoid issues with special characters in shortcode attributes.

```html
[s2Stream player_option_blocks="c2hhcmluZzoge30="]
```

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

### JW Player v6 Captions Example

Source: https://s2member.com/kb-article/s2stream-shortcode-documentation

Configure captions for JW Player v6. s2Member automatically wraps caption objects with square array brackets.

```shortcode
player_captions="{file:'/assets/captions-en.vtt',label:'English'}"
```

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

### Execute PHP with [php][/php] Shortcodes

Source: https://s2member.com/kb-article/ezphp-for-wordpress

Utilize the `[php][/php]` shortcode for embedding PHP logic, particularly useful within the WordPress Visual Editor. This example demonstrates conditional content display based on user login status.

```php
[php]if(is_user_logged_in()):[/php]
    Content for a user that is logged-in.
[php]else: // Otherwise show this.[/php]
    Content for everyone else.
[php]endif;[/php]

```

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

### JW Player v7 Captions Example

Source: https://s2member.com/kb-article/s2stream-shortcode-documentation

Configure captions for JW Player v7 using the player_tracks attribute. s2Member automatically wraps track objects with square array brackets.

```shortcode
player_tracks="{kind:'captions',file:'/assets/captions-en.vtt',label:'English'}"
```

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

### Mass-Update Existing Users

Source: https://s2member.com/kb-article/advanced-importexport-tools

Import a CSV file to update existing users' roles and capabilities. This example shows updating 'role', 'ccaps', and specific s2Member subscription meta fields.

```csv
"ID", "role", "ccaps", "meta_key__wp_s2member_subscr_gateway", "meta_key__wp_s2member_subscr_id", "meta_key__wp_s2member_subscr_cid"
"123", "s2member_level1", "music,videos", "paypal", "S-8234LSDK23KKSL", ""
"456", "s2member_level4", "games,music", "stripe", "sub_0290902234953ff", "cus_290242f65k44k3k3"
```

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

### Testing Custom Capabilities and User Roles

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

Check for custom capabilities or specific WordPress user roles to conditionally display content. This example also shows how to integrate s2Member shortcodes with other s2Member shortcodes.

```shortcode
[s2If current_user_can(access_s2member_ccap_free_gift)]
    This Member can access Custom Capability: `free_gift`.
    Hi there [s2Get constant="S2MEMBER_CURRENT_USER_DISPLAY_NAME" /]!
        ~ Claim your free gift by clicking here.
[/s2If]

[s2If !current_user_can(access_s2member_level4)]
    Content for someone who does NOT have Level #4 access.
   [s2Member-PayPal-Button modify="1" level="4" ra="49.95" desc="Upgrade To Level #4" /]
[/s2If]

[s2If current_user_is(administrator)]
    Content specifically for a WordPress® Administrator.
[/s2If]

[s2If current_user_is(editor)]
    Content specifically for a WordPress® Editor.
[/s2If]

[s2If current_user_is(author)]
    Content specifically for a WordPress® Author.
[/s2If]

[s2If current_user_is(contributor)]
    Content specifically for a WordPress® Contributor.
[/s2If]

[s2If current_user_is(subscriber)]
    Content specifically for a WordPress® Subscriber.
[/s2If]
```

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

### s2MOP with Specific Attributes

Source: https://s2member.com/kb-article/s2mop-shortcode

These examples demonstrate using attributes like `seeking_type`, `required_type`, and `restriction_type` to create more specific access restriction messages. The `required_value` attribute can further refine the conditions.

```html
[s2MOP seeking_type="post" required_type="level" restriction_type="post"]You were trying to access a restricted post with Post ID %%SEEKING_POST_ID%% which requires that you be a Member at Level #%%REQUIRED_LEVEL%%[/s2MOP]
```

```html
[s2MOP required_type="level"]"%%POST_TITLE%%" is a protected %%SEEKING_TYPE%% that requires Membership Level %%REQUIRED_LEVEL%%[/s2MOP]
```

```html
[s2MOP required_type="level" required_value="0|1"]You were trying to access a Post that requires Level <code>0</code> or <code>1</code>[/s2MOP]
```

```html
[s2MOP required_type="ccap" required_value="free_gift"]This content required a Custom Capability called <code>free_gift</code>[/s2MOP]
```

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

### Capability Fields in s2Member Export CSV

Source: https://s2member.com/kb-article/advanced-importexport-tools

This example demonstrates the structure for defining user capabilities using the 'role' and 'ccaps' fields in an s2Member CSV import/export file. 'role' specifies membership levels or WordPress roles, and 'ccaps' lists custom capabilities.

```csv
"role","ccaps"
"s2member_level1", "music,videos"
```

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

### PHP Example for s2member Variables

Source: https://s2member.com/kb-article/s2mop-shortcode

This PHP code snippet demonstrates how to access and process s2member variables directly from the request, bypassing the shortcode. It's useful for custom integrations or when direct API access is preferred.

```php
<?php
if(!empty($_REQUEST["_s2member_vars"]))
    @list($restriction_type, $requirement_type, $requirement_type_value, $seeking_type, $seeking_type_value, $seeking_uri)
            = explode("..", stripslashes((string)$_REQUEST["_s2member_vars"]));

if (!empty($seeking_type) /* One of: page|post|catg|ptag|file|ruri */ )
    echo 'You were trying to access a protected: ' . esc_html($seeking_type) . '.';


```

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

### Bare Bones Login Welcome Page

Source: https://s2member.com/kb-article/customizing-your-login-welcome-page

A minimal template for a Login Welcome Page, displaying a greeting and a profile editing form.

```html
<h4>Welcome <strong>[s2Get constant="S2MEMBER_CURRENT_USER_DISPLAY_NAME" /]</strong><em>!</em></h4>
<h4>You can edit your profile using the form below.</h4>
[s2Member-Profile /]

```

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

### Login Welcome Page Based on User Capabilities

Source: https://s2member.com/kb-article/customizing-your-login-welcome-page

A template that conditionally displays content based on the current user's capabilities, allowing for granular access control.

```html
<h4>Welcome <strong>[s2Get constant="S2MEMBER_CURRENT_USER_DISPLAY_NAME" /]</strong><em>!</em></h4>

[s2If current_user_can(access_s2member_level1)]
    Content for Members who are logged in with an s2Member Level >= 1.
[/s2If]

[s2If current_user_cannot(access_s2member_level1)]
    Content for Free Subscribers.
[/s2If]

<h4>You can edit your profile using the form below.</h4>
[s2Member-Profile /]

```

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

### One-Time-Offer Configuration File Format

Source: https://s2member.com/kb-article/configuring-s2member-general-options

Defines the special format for One-Time-Offer URLs within a configuration file. This format specifies the number of logins, optional access level, and the target URL.

```plaintext
[Logins]:[Access Level]:[One-Time-Offer URL]

```

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

### Create New Users

Source: https://s2member.com/kb-article/advanced-importexport-tools

Import a CSV file to create new users. The minimum required fields are 'user_login' and 'user_email'. If 'user_pass' is omitted, a password will be generated automatically.

```csv
"user_login", "user_email", "user_pass"
"johndoe", "john@example.com", "pasSw29914943!"
"maryjane", "mary@example.com", "uudkO90!!~!"
```

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

### Login Welcome Page with Additional Details

Source: https://s2member.com/kb-article/customizing-your-login-welcome-page

An advanced template displaying comprehensive account details such as membership level, user ID, login counter, and custom fields.

```html
<h4>Welcome <strong>[s2Get constant="S2MEMBER_CURRENT_USER_DISPLAY_NAME" /]</strong><em>!</em></h4>
<h4>Your Account Details:</h4>

Membership Level: [s2Get constant="S2MEMBER_CURRENT_USER_ACCESS_LEVEL" /]
Your are a:  [s2Get constant="S2MEMBER_CURRENT_USER_ACCESS_LABEL" /]

Your User ID is: [s2Get constant="S2MEMBER_CURRENT_USER_ID" /]
Your Username is: [s2Get constant="S2MEMBER_CURRENT_USER_LOGIN" /]
Your Email Address is: [s2Get constant="S2MEMBER_CURRENT_USER_EMAIL" /]

Your First Name is: [s2Get constant="S2MEMBER_CURRENT_USER_FIRST_NAME" /]
Your Last Name is: [s2Get constant="S2MEMBER_CURRENT_USER_LAST_NAME" /]

You have logged in [s2Get constant="S2MEMBER_CURRENT_USER_LOGIN_COUNTER" /] times.
Your IP Address is: [s2Get constant="S2MEMBER_CURRENT_USER_IP" /]

Custom Registration/Profile Field: [s2Get user_field="custom_field_id" /]
See: s2Member® -> General Options -> Registration/Profile Fields

<h4>You can edit your profile using the form below.</h4>
[s2Member-Profile /]

```

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

### Combine Conditions and Use s2Get

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

Demonstrates using 'OR' logic to combine conditions and the [s2Get /] shortcode to display user display names, access labels, and custom field values.

```shortcode
[s2If current_user_is(s2member_level1)]
    Content for Members at exactly Level# 1, on this Blog.
[/s2If]

[s2If current_user_is(s2member_level2) OR current_user_is_for_blog(24,s2member_level2)]
    They are either a Level #2 Member on this Blog,
    OR ... they're at Level# 2 on Blog ID# 24 (i.e. Multisite Networking)

        * Note the use of `OR` here. True if either condition is met.
[/s2If]

[s2If current_user_is(s2member_level3) OR current_user_is(s2member_level4)]
    Content for Level #3 - OR - Level #4 Members. Either/or.

    Hi there [s2Get constant="S2MEMBER_CURRENT_USER_DISPLAY_NAME" /].
    You have [s2Get constant="S2MEMBER_CURRENT_USER_ACCESS_LABEL" /].

        ^ This uses the s2Get Shortcode to retrieve the value of s2Member API Constants.
            These are also documented under: `Dashboard → s2Member → API Scripting`.

        So, this might come out to something like:
            `Hi there John.
            You have Gold Membership.`

        Here is a Custom Field value:
        [s2Get user_field="country_code" /]
        Custom Registration/Profile Field with the ID: `country_code`.
[/s2If]
```

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

### Get User Field via Shortcode

Source: https://s2member.com/kb-article/introduction-to-s2member

This shortcode is a shortcode version of the s2Member API function get_user_field(), useful in PHP template files.

```shortcode
[s2Get /]
```

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

### Using PHP Equivalent in Pro Login Widget

Source: https://s2member.com/kb-article/can-the-eot-time-be-added-to-the-pro-login-widget

Leverage the PHP equivalent of the [s2Eot /] shortcode within the 'Additional XHTML/PHP Code?' field for more granular control over EOT time display.

```php
<?php echo do_shortcode('[s2Eot /]'); ?>
```

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

### Create Four Level 1 Free Registration Pro-Forms with 3-Day Trial

Source: https://s2member.com/kb-article/setting-up-two-membership-types-professional-student-with-two-sub-types-gold-bronze-and-a-3-day-free-trial

Use these shortcodes to create distinct registration forms for Professional Gold, Professional Bronze, Student Gold, and Student Bronze memberships. Each form provides Level 1 access and a 3-day trial period. Ensure the 'custom' attribute matches your website's domain.

```shortcodes
[s2Member-Pro-PayPal-Form register="1" level="1" ccaps="professional,gold" tp="3" tt="D" desc="Professional Gold" custom="example.com" captcha="clean" /]
[s2Member-Pro-PayPal-Form register="1" level="1" ccaps="professional,bronze" tp="3" tt="D" desc="Professional Bronze" custom="example.com" captcha="clean" /]
[s2Member-Pro-PayPal-Form register="1" level="1" ccaps="student,gold" tp="3" tt="D" desc="Student Gold" custom="example.com" captcha="clean" /]
[s2Member-Pro-PayPal-Form register="1" level="1" ccaps="student,bronze" tp="3" tt="D" desc="Student Bronze" custom="example.com" captcha="clean" /]
```

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

### Change User Role

Source: https://s2member.com/kb-article/rolescapabilities-via-php

Use this snippet to change a user's role to a specific s2Member level. Ensure the role name is configured in your WordPress installation.

```php
<?php
$user_id = 123;
$user = new WP_User($user_id);
$user->set_role("s2member_level1");

```

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

### Get Custom Registration/Profile Fields via PHP

Source: https://s2member.com/kb-article/gettingsetting-custom-registrationprofile-fields-configured-w-s2member

Use this snippet to retrieve all custom fields associated with the currently logged-in user. The fields are returned as an associative array.

```php
<?php
$user_id = get_current_user_id();
$custom_fields = get_user_option('s2member_custom_fields', $user_id);

print_r($custom_fields);
/*
Array
(
    [company] => Acme Incorporated
    [phone_number] => 1-555-555-5555
    [favorite_color] => beige
    [favorite_actor] => Keanu Reeves
)
*/
?>
```

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

### Conditional Content within a Text Widget

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

This example shows how to use [s2If /] shortcodes within a WordPress Text Widget to display content conditionally in sidebars or other widgetized areas.

```shortcode
[s2If level1]
This message appears in the widget only for Level 1 members.
[/s2If]
```

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

### Free Registration Pro-Form with 1-Week Trial

Source: https://s2member.com/kb-article/creating-a-free-membership-with-a-trial-period-limited-time-free-membership

Use this shortcode to create a free registration form that grants access for a limited trial period. The `tp` attribute defines the duration, and `tt` defines the unit (D=Days, W=Weeks, M=Months, Y=Years).

```shortcode
[s2Member-Pro-PayPal-Form register="1" level="0" ccaps="" desc="Signup now, it's Free!" tp="1" tt="W" captcha="clean" /]
```

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

### Get Custom Field Value for Current User

Source: https://s2member.com/kb-article/user-custom-fields-via-php-code

Use get_user_field() to retrieve the value of a custom field for the currently logged-in user. The custom field is referenced by its unique ID.

```php
<?php
$company = get_user_field('company');
// ↑ Pulls the value for a custom field with ID `company`, for the current user.
```

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

### Retrieve Current User Constants with s2Get Shortcode

Source: https://s2member.com/kb-article/s2get-shortcode-documentation

Use this shortcode to display s2Member's current user PHP constants, such as the display name. No additional setup is required.

```shortcode
[s2Get constant="S2MEMBER_CURRENT_USER_DISPLAY_NAME" /] # The current User's Display Name.
```

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

### Using [s2Eot /] Shortcode in Pro Login Widget

Source: https://s2member.com/kb-article/can-the-eot-time-be-added-to-the-pro-login-widget

Insert the [s2Eot /] shortcode into the 'Additional XHTML/PHP Code?' field of the Pro Login Widget to display EOT time information.

```text
[s2Eot /]
```

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

### Dynamic Login Welcome Page URL by Username

Source: https://s2member.com/kb-article/customizing-your-login-welcome-page

Use this format to create a redirection URL that incorporates the user's login name. You will need to create corresponding WordPress pages for each expected username.

```text
http://www.example.com/%%current_user_login%%-account-page
```

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

### Login Welcome Page Based on User Role

Source: https://s2member.com/kb-article/customizing-your-login-welcome-page

A template that conditionally displays content based on the current user's role, such as subscriber, administrator, or specific s2Member levels.

```html
<h4>Welcome <strong>[s2Get constant="S2MEMBER_CURRENT_USER_DISPLAY_NAME" /]</strong><em>!</em></h4>

[s2If current_user_is(subscriber)]
    You are a Free Subscriber.
[/s2If]

[s2If current_user_is(s2member_level1)]
    You are a Member @ Level #1.
[/s2If]

[s2If current_user_is(s2member_level2)]
    You are a Member @ Level #2.
[/s2If]

[s2If current_user_is(s2member_level3)]
    You are a Member @ Level #3.
[/s2If]

[s2If current_user_is(s2member_level4)]
    You are a Member @ Level #4.
[/s2If]

[s2If current_user_is(administrator)]
    You are an Administrator.
[/s2If]

<h4>You can edit your profile using the form below.</h4>
[s2Member-Profile /]

```

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

### Embed Pro Login Widget via PHP

Source: https://s2member.com/kb-article/pro-login-widget

Use the s2member_pro_login_widget() function to embed the login widget directly into your theme or plugin files. This basic example uses default options.

```php
<?php echo s2member_pro_login_widget(); ?>
```

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

### Example of redirect_to variable in a login form

Source: https://s2member.com/kb-article/login-redirection-url-is-not-working-at-all-why

This HTML snippet shows how a 'redirect_to' hidden input field in a login form can override s2Member's default login redirection URL.

```html
<input type="hidden" name="redirect_to" value="http://yoursite.com/" />
```

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

### Link to Pre-select Checkout Option

Source: https://s2member.com/kb-article/how-do-i-display-multiple-checkout-options

Link to a checkout page and pre-select a specific checkout option by appending '?s2p-option=[number]' to the URL. Option 1 is the default.

```url
http://www.example.com/my-checkout-form/?s2p-option=2

```

```url
http://www.example.com/my-checkout-form/?s2p-option=1

```

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

### URL to Trigger Coupon Import

Source: https://s2member.com/kb-article/is-it-possible-to-import-coupon-codes

Access this URL in your browser to initiate the coupon import process after uploading the necessary files and configuring the secret key.

```html
http://yoursite.com/?s2_new_coupons=[secret key]

```

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

### Conditional Tags Accepting Arrays

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

This snippet illustrates using conditional tags that can accept arrays, allowing for more complex matching criteria. For example, checking if a user belongs to multiple specified groups.

```shortcode
[s2If groups='group1,group2']
This content is visible if the user is in group1 OR group2.
[/s2If]
```

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

### JW Player Integration with s2Member

Source: https://s2member.com/kb-article/s2stream-shortcode-documentation

This PHP and JavaScript code configures JW Player to stream MP4 videos. It uses s2member_file_download_url() to get a secure stream URL and handles access denial.

```php
<?php
// Configuration.
$s2_jw_config['jwplayer']            = '/jwplayer/'; // Relative URL path to JW Player files directory.
$s2_jw_config['mp4_video_file_name'] = 'video.mp4'; // Name of your MP4 test file.
// Don't edit anything else below unless you know what you're doing.
?>

    <div id="jw-container">JW Player appears here.</div>
    <script type="text/javascript" src="<?php echo $s2_jw_config["jwplayer"]; ?>jwplayer.js"></script>
    <script>jwplayer.key = 'YOUR KEY HERE';</script>

<?php // A direct URL to the RTMP source; counting the file against the current User in real-time.
$cfg = array('file_download' => $s2_jw_config['mp4_video_file_name'], 'url_to_storage_source' => TRUE, 'count_against_user' => TRUE); ?>

<?php // API Function `s2member_file_download_url()` returns false if access is denied to the current User.
if(($mp4 = s2member_file_download_url($cfg, 'get-streamer-array'))): ?>

    <script type="text/javascript">
        jwplayer('jw-container').setup({
                                           playlist: [{
                                                          sources: [
                                                              {type: 'rtmp', file: '<?php echo $mp4['streamer']; ?>/mp4:<?php echo $mp4['file']; ?>'},
                                                              {type: 'mp4', file: '<?php echo $mp4['url']; ?>'}
                                                          ]
                                                      }],
                                           primary : 'flash', width: 480, height: 270
                                       });
    </script>

<?php else: /* Access is denied to the current User. */ ?>
    Sorry, you do NOT have access to this file.
<?php endif; ?>

```

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

### Automate User Role Changes via CRON Job

Source: https://s2member.com/kb-article/rolescapabilities-via-php

This mu-plugin automates user role promotions based on registration time. It checks if a user has been a member for at least 10 days and promotes them to Level 2 if they don't already have that capability. Be cautious not to modify administrator roles.

```php
<?php
add_action('init', function () {
    if(!empty($_GET['my_cron_job']) && $_GET['my_cron_job'] === 'secret-cron-job-key')
    {
        foreach(get_users() as $user)
        {
            $user         = new WP_User($user->ID);
            $_10_days_ago = strtotime('-10 days');
            if(s2member_registration_time($user->ID) <= $_10_days_ago)
            {
                # A Member for at least 10 days.
                # Promote them now to Level #2.
                if(!$user->has_cap("access_s2member_level2"))
                    $user->set_role("s2member_level2");
            }
        }
        exit;
    }
});

```

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

### Get Custom Field Value for Specific User

Source: https://s2member.com/kb-article/user-custom-fields-via-php-code

Use get_user_field() with a specific user ID to retrieve the value of a custom field for that particular user. The custom field is referenced by its unique ID.

```php
<?php
$user_id = 123; // A specific user ID.
$company = get_user_field('company', $user_id);
// ↑ Pulls the value for a custom field with ID `company`, for user ID 123.
```

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

### Displaying Registration Data on Thank You Page

Source: https://s2member.com/kb-article/creating-a-registration-thank-you-page

Use ezPHP plugin to display registration data passed via URL parameters on your thank you page. Ensure the ezPHP plugin is installed and activated.

```php
Email: <?php echo esc_html($_REQUEST['email']); ?>
First Name: <?php echo esc_html($_REQUEST['fname']); ?>
```

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

### Dynamic Login Welcome Page URL by Membership Level

Source: https://s2member.com/kb-article/customizing-your-login-welcome-page

This format creates a redirection URL that includes the user's membership level. You will need to create corresponding WordPress pages for each membership level.

```text
http://www.example.com/%%current_user_level%%-account-page
```

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

### Basic True/False Conditional

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

Use `[s2If]` to check if a condition is true. Prepend `!` to test for a false value.

```shortcode
[s2If current_user_can()][/s2If]
```

```shortcode
[s2If !current_user_can()][/s2If]
```

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

### Configure ezPHP to Exclude Post Types

Source: https://s2member.com/kb-article/ezphp-for-wordpress

Define the `EZPHP_EXCLUDED_POST_TYPES` constant in your `/wp-config.php` file to prevent ezPHP from evaluating PHP tags in specific post types. This example excludes the 'post' post type.

```php
define('EZPHP_EXCLUDED_POST_TYPES', ''); // A comma-delimited list of Post Types to exclude.

```

```php
define('EZPHP_EXCLUDED_POST_TYPES', 'post');

```

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

### Content Dripping

Source: https://s2member.com/kb-article/introduction-to-s2member

Allows for the gradual, pre-scheduled release of premium content to paying Members. Requires s2Member Pro.

```shortcode
[s2Drip /]
```

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

### Implementing an 'else' Condition

Source: https://s2member.com/kb-article/s2if-simple-shortcode-conditionals

This snippet shows how to use the [s2IfElse] shortcode to provide alternative content when the primary [s2If] condition is not met. It's essential for fallback content or messages.

```shortcode
[s2If level1]
This content is for Level 1 members.
[s2IfElse]
This content is shown to everyone else.
[/s2If]
```

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

### Timed Content Dripping

Source: https://s2member.com/kb-article/s2drip-shortcode

This snippet displays content for a limited duration. Members at a specific level or higher will see the content starting from a certain day and it will automatically stop being visible after another specified day.

```shortcode
[s2Drip access="level1" from_day="4" to_day="30"]
    Some content for Members at Level 1 (or higher).

    This content will show only after day 3 of their paid membership.
        ~ i.e. it starts showing on day 4.

    In addition, this content will stop being shown on day 31 of their paid membership.
        ... i.e. show until (and including) day 30; stop showing after day 30.
[/s2Drip]
```

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

### Create or Update User via API

Source: https://s2member.com/kb-article/pro-api-for-remote-operations

Use this snippet to create a new user or update an existing one if the username already exists. Ensure your API key is correctly set and the required user details are provided. Optional parameters can be included to set membership levels, custom capabilities, and other user-specific information.

```php
<?php
$op["op"] = "create_user"; // The Remote Operation. 

$op["api_key"] = "296c096b6ac5c87d36b606842c76d6c2"; // Check your Dashboard for this value.
    // See: `s2Member 

$op["data"] = array(
    "user_login" => "johndoe22", // Required. A unique Username. Lowercase alphanumerics/underscores.
    "user_email" => "johndoe22@example.com", // Required. A valid/unique Email Address for the new User.

    // These additional details are 100% completely optional.

    "modify_if_login_exists" => "1", // Optional. Update/modify if ``user_login`` value already exists in the database?
        // A non-zero value tells s2Member to update/modify an existing account with the details you provide, if this Username already exists.

    "user_pass" => "456DkaIjsd!", // Optional. Plain text Password. If empty, this will be auto-generated.

    "first_name" => "John", // Optional. First Name for the new User.
    "last_name" => "Doe", // Optional. Last Name for the new User.

    "s2member_level" => "2", // Optional. Defaults to Level #0 (a Free Subscriber).
    "s2member_ccaps" => "music,videos", // Optional. Comma-delimited list of Custom Capabilities.

    "s2member_registration_ip" => "123.456.789.100", // Optional. User's IP Address. If empty, s2Member will fill this upon first login.

    "s2member_subscr_gateway" => "paypal", // Optional. User's Paid Subscr. Gateway Code. One of: (paypal|alipay|authnet|ccbill|clickbank|google).
    "s2member_subscr_id" => "I-DJASODJF8933J", // Optional. User's Paid Subscr. ID. For PayPal®, use their Subscription ID, or Recurring Profile ID.

    "s2member_custom" => "s2member.dev", // Optional. If provided, should always start with your installation domain name (i.e., $_SERVER["HTTP_HOST"]).

    "s2member_auto_eot_time" => "2030-12-25", // Optional. Can be any value that PHP's ``strtotime()`` function will understand (i.e., YYYY-MM-DD).

    "custom_fields" => array("my_field_id" => "Some value."), // Optional. An array of Custom Registration/Profile Field ID's, with associative values.

    "s2member_notes" => "Administrative notation. Created this User via API call.", // Optional. Administrative notations.

    "opt_in" => "1", // Optional. A non-zero value tells s2Member to attempt to process any List Servers you've configured in the Dashboard area.
        // This may result in your mailing list provider sending the User/Member a subscription confirmation email (i.e., ... please confirm your subscription).

    "notification" => "1", // Optional. A non-zero value tells s2Member to email the new User/Member their Username/Password.
        // The "notification" parameter also tells s2Member to notify the site Administrator about this new account.
);
$post_data = stream_context_create(array('http' => array('method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => 's2member_pro_remote_op='.urlencode(json_encode($op))))));
$result    = json_decode(trim(file_get_contents('https://jason.wpsharks.net/?s2member_pro_remote_op=1', false, $post_data)), true);

if ($result && empty($result['error']) && !empty($result['ID'])) {
    echo 'Success. New user created with ID: '.$result['ID'];
} elseif (!empty($result['error'])) {
    echo 'API error reads: '.$result['error'];
}


```

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

### Enable User Search Functionality

Source: https://s2member.com/kb-article/s2member-list-shortcode-documentation

Enables users to search for each other by displaying a search box and enabling list search.

```shortcode
[s2Member-List-Search-Box /]
```

```shortcode
[s2Member-List enable_list_search="yes" /]
```

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

### Custom Field Keys in CSV Export

Source: https://s2member.com/kb-article/advanced-importexport-tools

This example shows the format of custom field keys as they appear in an s2Member CSV export file. The 'custom_field_key__' prefix is used to identify columns that map to custom fields.

```csv
"custom_field_key__company","custom_field_key__dept"
"WebSharks","Web Design"
```

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

### User Fields in s2Member Export CSV

Source: https://s2member.com/kb-article/advanced-importexport-tools

This snippet shows the header row and an example data row for User Fields in an s2Member Advanced Export File. These fields correspond to columns in the `wp_users` database table.

```csv
"ID","user_login","user_nicename","user_email","user_url","user_registered","user_activation_key","user_status","display_name"
"1", "johndoe22", "johndoe22", "john@example.com", "http://john.example.com", "2014-04-04 17:06:50", "", "", "John Doe"
```

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

### Display User Summary and Login Box

Source: https://s2member.com/kb-article/introduction-to-s2member

Displays a summarized profile for the logged-in user or a login box if the user is not logged in. Requires s2Member Pro.

```shortcode
[s2Member-Summary /]
```

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

### Get Custom Field Value using get_user_option()

Source: https://s2member.com/kb-article/user-custom-fields-via-php-code

Use the core WordPress function get_user_option() to retrieve custom field values. You can reference s2Member custom fields by their unique ID, optionally prefixed with 's2_'.

```php
<?php
$company = get_user_option('company'); // An s2Member custom field with ID `company`.
$company = get_user_option('s2_company'); // This works for s2Member custom fields too; prefix is optional.
// ↑ Pulls the value for a custom field with ID `company`, for the current user.
```
Tokens:
Raw