Search Results for: short code

Description

API function to add an invite code.

Can add a code using default arguments or specific code attributes.

Parameters

$args
(array)(optional)

Return

Mixed – returns the invite code on success, otherwise false boolean

Useage

$args = array(
    'invite_code'    => 'The_Invite_Code', // Optional, will generate a value by default
    'description'    => 'A description of the invite code', // Optional
    'uses_remaining' => 1, // limit times a code can be used. Optional, will default to null
    'date_created'   => 'YYYY-MM-DD 00:00:00', // MySQL timestamp format Optional, will set by default
    'date_active'    => 'YYYY-MM-DD 00:00:00', // MySQL timestamp format Optional, will set by default
    'date_expired'   => 'YYYY-MM-DD 00:00:00', // MySQL timestamp format Optional, will set by default
);

$invite_code = wpmem_ic_add_code( $args );

Description

Fires after an invite code has been used for registration.

Parameters

$code_info
(array) An array of details of the code used.

“code_id” | integer | The invite code’s database primary key ID
“user_id” | integer | The user ID of the user
“invite_code” | string | The invite code used to register
“date_used | string | The date the code was used as MySQL timestamp (in string format)

Usage

add_action( 'wpmem_ic_code_used', function( $code_info ) {
    
    // The user ID is in the $code_info array.
    $user_id = $code_info['user_id'];
    
    // What is the slug of the membership to assign?
    $membership = "my-invite-only-membership";
    
    // Assign the membership to the user.
    wpmem_set_user_membership( $membership, $user_id );
    
});

Changelog

• Introduced in 2.0.0

Source

wpmem_ic_code_used is located in includes/class-wp-members-invite-codes.php

The plugin avoids checking role names for access to various administrative functions as this is not the proper way to control access. WP is a capability-based ruleset, and users can have multiple roles, and various roles can have different capabilities.

For example, the default WP admin role has edit_users permissions, and a custom role created to manage users but not only things the WP admin role can manage can also be given edit_users capability.

The following lists the primary restricted elements of the plugin and what capabilities they are restricted to. Some of the capabilities can be customized (to change the capability checked) by using a filter. If the capability requirement is filterable, it is listed.

All of the default capabilities listed below are only found in the administrator role if your WP instance is simply a default instance (i.e. no custom roles). However, you should not use a role definition if restricting with current_user_can(); rather, this should check the necessary user capability.

A role editor such as User Role Editor will allow you to manage the capabilities assigned to existing roles, and/or create custom roles with unique capability sets based on your specific needs.

Managing plugin options

The plugin’s admin screen is only accessible if the user has manage_options capability.

Managing memberships

This includes adding/editing/deleting membership properties as well as creating new memberships.

To add/edit/delete memberships: manage_options

To filter the capability for displaying the [wpmem_field] shortcode: wpmem_field_sc_required_capability
Default: list_users

Export users

Default capability: list_users

Filter: wpmem_export_args

Array value in filter: $defaults['required_caps']

Admin fields in dashboard user profile

This includes viewing “admin only” fields as well as activating/deactivating users and viewing the WP-Members profile tabs.

Default capability: edit_users

Filter: wpmem_user_profile_caps

Filter is a string value only for this.

See posts in admin that are marked as hidden

Default capability: edit_posts

Filter: none

Admin user actions

The plugin only loads its customizations for the Users > All Users screen for users that have list_users capability. There is no filter to change this, since a user without that capability wouldn’t be able to view that screen anyway. This includes custom user filter views, bulk actions (activate/deactivate, confirm/unconfirm), and user row hover links.

User search and user export is only added if user has list_users capability.

Custom plugin actions attached to post/page editor and all posts/pages screen

The plugin only loads these actions if the user has edit_posts capability. If they didn’t have this capability, they wouldn’t be able to view any of the associated screens anyway.