Search Results for: short code

Description

Creates a membership.

Parameters

$args
(array) (required) Parameters for creating the membership CPT.

• (string) title User readable name of membership.
• (string) name Sanitized title of the membership to be used as the meta key.
• (string) status Published status: publish|draft (default: publish)
• (int) author User ID of membership author, Optional, defaults to site admin.
• (array) meta_input Meta fields for membership CPT (optional)
  • (string) name The sanitized title of the membership.
  • (string) default
  • (string) role Roles if a role is required.
  • (string) expires Expiration period if used (num|per).
  • (int) no_gap If renewal is "no gap" renewal.
  • (string) fixed_period (start|end|grace_num|grace_per)
  • (int) set_default_{key}
  • (string) message Custom message for restriction.
  • (int) child_access If membership hierarchy is used.

Usage

/**
 * This example would create a membership with the 
 * title "My Custom Membership", which, if unique
 * in the db, would result in a meta key of 
 * "my-custom-membership" and would have all other
 * properties set to the default values.
 */
$args = array( 'title' => 'My Custom Membership' );
wpmem_create_membership( $args );

Notes

• The only required value in the $args array is the "title" (user readable name of the membership). All other values can be created with defaults.

Changelog

• Introduced in version 3.4.6

Source

wpmem_create_membership() is located in /includes/api/api-products.php

Description

Filters the form defaults for heading, action, button text, redirect_to (login form only), and the field elements (such as label text).

$form iterations:

• wpmem_login_form_defaults
• wpmem_changepassword_form_defaults
• wpmem_resetpassword_form_defaults
• wpmem_forgotusername_form_defaults

Introduced in 3.3.0, it replaces wpmem_inc_{$form}_inputs and wpmem_inc_{$form}_args, which should be considered deprecated.

Parameters

$args (array)

/*
@param array $args {
    @type string $heading      The form heading
    @type string $action       The form action (do not change unless you know what you are doing)
    @type string $button_text  The form submit button text
    @type string $redirect_to  The $redirect_to parameter
    @type array  $inputs {
        An array of inputs, there will be one array element for each form input, keyed starting with [0].
    
        @type string $name   The field label
        @type string $type   The field type
        @type string $tag    The field meta tag
        @type string $class  The CSS class
        @type string $div
    }
}
*/

Usage

// An example of changing a single major element.
add_filter( 'wpmem_login_form_defaults', function( $args ) {
    $args['heading'] = "Log in here";
    return $args;
});

// An example of changing a single field input element.
add_filter( 'wpmem_login_form_defaults', function( $args ) {
    $args['inputs'][0]['name'] = "Email";
    return $args;
});

// An example of changing multiple elements.
add_filter( 'wpmem_login_form_defaults', function( $args ) {
    $args['heading'] = "Log in here";
    $args['button_text'] = "Click to log in";
    $args['inputs'][0]['name'] = "Email";
    return $args;
});

Notes

• This is a "dynamic" filter where the {$form} tag shown above will be one of 4 possible iterations depending on the form being displayed:
  • login
  • changepassword
  • resetpassword
  • forgotusername
• All of the array/subarray keys are the same for any of the possible filters with the exception of "redirect_to" which only applies to the login form at present.
• The "inputs" are a subarray in the overall array. It is a numerically keyed array starting at 0. Each input is in the array in display order. For example, in the default login form, the username/email input is [0] and the password is [1], in the password change form, password is [0] and confirm password is [1], etc.

Changelog

• Introduced in version 3.3.0
• 3.4.6: Added $form parameter

Source

wpmem_{$form}_form_defaults is located in /includes/class-wp-members-forms.php

Returns or prints a requested message string from the WP_Members::get_text() method.

Parameters

$str
(string) (required) The array key of the string to retrieve from WP_Members::get_text().

$echo
(bool) (optional) Prints the requested string if true (default: false).

Return Values

(string) The requested message string.

Examples

Notes

List of possible strings by key:

Changelog

• Introduced in version 3.4.0, replaces wpmem_gettext()

Source

wpmem_get_text() is located in /includes/api/api.php.