API Functions

WP-Members has several functions that can be used for customizing how your install works and operates.  These can be used in conjunction with the various filter and action hooks as well as shortcodes.

Form Pages and URLs

• wpmem_redirect_to_login() – redirects content to the login page (if one is set).
• wpmem_is_blocked() – checks if content is blocked or not.
• wpmem_is_hidden() – checks if a post is marked as hidden.
• wpmem_get_block_setting() – returns the block setting value for a post.
• wpmem_login_url() – returns the login page URLas set in the plugin’s settings.
• wpmem_register_url() – returns the register page URLas set in the plugin’s settings.
• wpmem_profile_url() – returns the user profile page URLas set in the plugin’s settings.
• wpmem_pwd_reset_url()
• wpmem_forgot_username_url()
• wpmem_user_pages() – returns an array of login, register, and profile page urls.
• wpmem_current_url() – returns the current page URL.
• wpmem_current_post_id() – returns the post ID for the current URL.
• wpmem_is_reg_page() – checks the value of the wpmem_reg_page hidden field to validate what page the registration is occurring on.
• wpmem_logout_link() – returns the URL used to log a user out.

Forms

• wpmem_form_field() – creates a form field.
• wpmem_form_label() – creates a field label.
• wpmem_fields() – gets the form fields settings array.
• wpmem_login_form()
• wpmem_wp_login_form()
• wpmem_register_form()
• wpmem_change_password_form()
• wpmem_reset_password_form()
• wpmem_forgot_username_form()
• wpmem_sanitize_class()
• wpmem_sanitize_array()
• wpmem_sanitize_field()
• wpmem_form_nonce()
• WP_Members_Captcha
• wpmem_field_display_value()
• wpmem_checkbox_field_display()
• wpmem_select_field_display()

Dialogs and Emails

• wpmem_gettext() – returns a requested string from the get_text function.
• wpmem_display_message() – displays a requested dialog.
• wpmem_use_custom_dialog() – uses a custom message dialog.
• wpmem_add_custom_dialog() – adds a custom message dialog.
• wpmem_add_custom_email() – adds a custom email message.
• wpmem_login_status() – displays a user’s login status.
• wpmem_loginout() – creates a login/logout link.
• wpmem_mail_from()
• wpmem_mail_from_name()
• wpmem_email_to_user()
• wpmem_notify_admin()
• wpmem_gettext()

User Functions

• wpmem_is_user() – returns boolean (true|false) to check if a user is a WP user.
• wpmem_get_user_id() – returns a user ID from a username or email.
• wpmem_get_user_obj() – returns a user object from a user ID, username, or email.
• wpmem_get_user_role() – returns the user’s current role as an array, false if no role.
• wpmem_user_has_role() – checks if a user has a specific role.
• wpmem_get_user_meta() – functions exactly like WP’s get_user_meta(), but without the need for $single (always returns a string).
• wpmem_get_user_meta_checkbox() – returns a user’s saved result for a specified checkbox field.
• wpmem_get_user_meta_select() – returns a user’s saved result for a specified select (dropdown) field.
• wpmem_get_user_meta_radio() – returns a user’s saved result for a specified radio field.
• wpmem_get_user_meta_multi() – returns a user’s saved result for a specified multiple checkbox or multiple select field as a string.
• wpmem_user_has_meta() – checks if a user has a given meta value.
• wpmem_is_user_activated() – checks if the current or requested user is activated.
• wpmem_user_data() – returns an array of the user’s registration data.
• wpmem_update_user_role() – updates a user’s role.
• wpmem_user_has_access() – checks if a user has valid access criteria.
• wpmem_set_user_product() – assigns product access to a user.
• wpmem_remove_user_product() – removes product access from a user.
• wpmem_get_user_products() – gets all memberships for a user.
• wpmem_set_as_logged_in() – sets a user as logged in.
• wpmem_login() – logs the user in using wp_signon().
• wpmem_logout() – logs the user out, destroy session.
• wpmem_create_membership_number() – creates a membership number.
• wpmem_activate_user() – sets activation flag (for moderated registration).
• wpmem_deactivate_user() – sets activation flag to 0.
• wpmem_set_user_status() – sets the WP user_status value according to activated/deactivated.
• wpmem_get_user_ip() – gets the current user’s IP address.
• wpmem_export_users()
• wpmem_get_users_by_meta()
• wpmem_get_pending_users()
• wpmem_get_activated_users()
• wpmem_get_deactivated_users()

Memberships

• wpmem_get_product_post_list()

Utilities

• wpmem_get() – utility to check posted variables and query strings.
• wpmem_securify() – filters the main content variable.
• wpmem_do_excerpt()
• wpmem_get_excluded_meta()
• wpmem_use_ssl() – checks if ssl is being used and returns https:// or http:// accordingly.
• wpmem_force_ssl() – forces a given URL to use ssl (https://).
• wpmem_write_log()
• wpmem_array_insert() – inserts array items at specific point in an array.
• wpmem_load_dropins() – loads dropin code snippets.
• wpmem_format_date() – formats a given date.
• wpmem_do_shortcode() – executes a given shortcode (any shortcode, not just WP-Members) without running the full shortcode regex.
• wpmem_get_sub_str()
• wpmem_texturize()
• wpmem_format_date()
• wpmem_user_sets_password() – checks if a password field is part of registration.
• wpmem_maybe_unserialize()
• wpmem_get_suffix()
• wpmem_get_hidden_posts()
• wpmem_update_hidden_posts()
• wpmem_is_rest()

Extension API Functions

MailChimp Integration

• wpmem_mc_get_list_member() – retreives subscriber data from the MailChimp API.
• wpmem_mc_process_user() – subscribe, update, unsubscribe, or delete a user from the list.