cleanup, mostly inline docs w/ some formatting

includes/admin/tabs/class-wp-members-admin-tab-fields.php

@@ -87,7 +87,7 @@ public static function build_settings() {
 
 		if ( 'delete' == $delete_action ) {
 
-			$delete_fields = wpmem_get( 'delete' ); ?>
+			$delete_fields = wpmem_sanitize_array( wpmem_get( 'delete' ) );?>
 
 			<?php if ( empty( $delete_fields ) ) { ?>
 				<p><?php _e( 'No fields selected for deletion', 'wp-members' ); ?></p>

includes/admin/tabs/class-wp-members-admin-tab-options.php

@@ -203,7 +203,7 @@ static function build_settings() {
 								<h3><?php _e( 'Other Settings', 'wp-members' ); ?> <a href="https://rocketgeek.com/plugins/wp-members/docs/plugin-settings/options/#other" target="_blank" title="info"><span class="dashicons dashicons-info"></span></a></h3>
 								<ul>
 								<?php 
-								/** This filter is defined in class-wp-members.php */
+								/** This filter is defined in includes/class-wp-members.php */
 								$dropin_dir = apply_filters( 'wpmem_dropin_dir', $wpmem->dropin_dir );
 								$rows = array(
 									array(__('Enable Products', 'wp-members'),'wpmem_settings_products',__('Enables creation of different membership products','wp-members'),'enable_products'),

includes/api/api-forms.php

@@ -24,7 +24,7 @@
  * to the current function documentation.
  *
  * @since 2.5.1
- * @since 3.1.7 Now a wrapper for $wpmem->forms->login_form()
+ * @since 3.1.7 Now an alias for $wpmem->forms->login_form()
  * @since 3.3.0 Added to API.
  * @since 3.4.0 Main API function for displaying login form.
  *

includes/api/api-users.php

@@ -166,7 +166,7 @@ function wpmem_user_has_meta( $meta, $value = false, $user_id = false ) {
  * Checks if a user is activated.
  *
  * @since 3.1.7
- * @since 3.2.3 Now a wrapper for WP_Members_Users::is_user_activated().
+ * @since 3.2.3 Now an alias for WP_Members_Users::is_user_activated().
  *
  * @global object $wpmem
  * @param  int    $user_id
@@ -199,7 +199,7 @@ function wpmem_user_data( $user_id = false, $all = false ) {
 /**
  * Updates a user's role.
  *
- * This is a wrapper for $wpmem->update_user_role(). It can add a role to a
+ * This is an alias for $wpmem->update_user_role(). It can add a role to a
  * user, change or remove the user's role. If no action is specified it will
  * change the role.
  *
@@ -319,7 +319,7 @@ function wpmem_set_as_logged_in( $user_id ) {
  * @since 2.5.2 Now uses wp_signon().
  * @since 2.7.7 Sets cookie using wp_set_auth_cookie().
  * @since 3.0.0 Removed wp_set_auth_cookie(), this already happens in wp_signon().
- * @since 3.1.7 Now a wrapper for login() in WP_Members_Users Class.
+ * @since 3.1.7 Now an alias for login() in WP_Members_Users Class.
  * @since 3.2.4 Moved to user API (could be deprecated).
  *
  * @global object $wpmem
@@ -337,7 +337,7 @@ function wpmem_login() {
  *
  * @since 2.0.0
  * @since 3.1.6 Added wp_destroy_current_session(), removed nocache_headers().
- * @since 3.1.7 Now a wrapper for logout() in WP_Members_Users Class.
+ * @since 3.1.7 Now an alias for logout() in WP_Members_Users Class.
  * @since 3.2.4 Moved to user API (could be deprecated).
  *
  * @global object $wpmem
@@ -354,7 +354,7 @@ function wpmem_logout( $redirect_to = false ) {
  * Handles user password change (not reset).
  *
  * @since 2.1.0
- * @since 3.1.7 Now a wrapper for password_update() in WP_Members_Users Class.
+ * @since 3.1.7 Now an alias for password_update() in WP_Members_Users Class.
  * @since 3.2.4 Moved to user API (could be deprecated).
  *
  * @global int $user_ID The WordPress user ID.
@@ -372,7 +372,7 @@ function wpmem_change_password() {
  * Resets a forgotten password.
  *
  * @since 2.1.0
- * @since 3.1.7 Now a wrapper for password_update() in WP_Members_Users Class.
+ * @since 3.1.7 Now an alias for password_update() in WP_Members_Users Class.
  * @since 3.2.4 Moved to user API (could be deprecated).
  *
  * @global object $wpmem The WP-Members object class.
@@ -390,7 +390,7 @@ function wpmem_reset_password() {
  *
  * @since 3.0.8
  * @since 3.1.6 Dependencies now loaded by object.
- * @since 3.1.8 Now a wrapper for $wpmem->retrieve_username() in WP_Members_Users Class.
+ * @since 3.1.8 Now an alias for $wpmem->retrieve_username() in WP_Members_Users Class.
  * @since 3.2.4 Moved to user API (could be deprecated).
  *
  * @global object $wpmem The WP-Members object class.

includes/api/api-utilities.php

@@ -22,10 +22,10 @@
  *
  * This is the primary function that picks up where wpmem() leaves off.
  * Determines whether content is shown or hidden for both post and pages.
- * Since 3.0, this function is a wrapper for $wpmem->do_securify().
+ * Since 3.0, this function is an alias for $wpmem->do_securify().
  *
  * @since 2.0.0
- * @since 3.0.0 Now a wrapper for $wpmem->do_securify().
+ * @since 3.0.0 Now an alias for $wpmem->do_securify().
  * @since 3.2.4 Moved to utility API (could be deprecated).
  *
  * @global object $wpmem The WP-Members object class.
@@ -43,7 +43,7 @@ function wpmem_securify( $content = null ) {
  * Sets an array of user meta fields to be excluded from update/insert.
  *
  * @since 2.9.3
- * @since Unknown Now a wrapper for get_excluded_fields().
+ * @since Unknown Now an alias for get_excluded_fields().
  * @since 3.3.9 excluded_fields() moved to forms object class.
  *
  * @param  string $tag A tag so we know where the function is being used.
@@ -112,7 +112,7 @@ function wpmem_get_sub_str( $needle, $haystack, $position = 'after', $keep_needl
  * Creates an excerpt on the fly if there is no 'more' tag.
  *
  * @since 2.6
- * @since 3.2.3 Now a wrapper for WP_Members::do_excerpt().
+ * @since 3.2.3 Now an alias for WP_Members::do_excerpt().
  *
  * @global object $wpmem The WP_Members object.
  *
@@ -133,7 +133,7 @@ function wpmem_do_excerpt( $content ) {
  * Currently only used for the login form to remove the <br> tag that WP puts in after the "Remember Me".
  *
  * @since 2.6.4
- * @since 3.2.3 Now a wrapper for WP_Members::texturize().
+ * @since 3.2.3 Now an alias for WP_Members::texturize().
  *
  * @todo Possibly deprecate or severely alter this process as its need may be obsolete.
  *

includes/api/api.php

@@ -478,9 +478,7 @@ function wpmem_is_reg_type( $type ) {
 /**
  * Displays the post restricted message.
  *
- * @todo Evaluate - this doesn't seem to be used yet.
- *
- * @since 3.3.5
+ * @since 3.4.0
  *
  * @return string
  */

includes/class-wp-members-pwd-reset.php

@@ -290,7 +290,7 @@ function reset_password_form( $args ) {
 	/**
 	 * Sets and gets the password reset key.
 	 *
-	 * This function is a wrapper for the WP function get_password_reset_key().
+	 * This function is an alias for the WP function get_password_reset_key().
 	 *
 	 * @since 3.3.8
 	 *

includes/class-wp-members-widget.php

@@ -34,14 +34,14 @@ function __construct() {
 	 */
 	function form( $instance ) {
 
-		/* Default widget settings. */
+		// Default widget settings.
 		$defaults = array( 
 			'title'       => __( 'Login Status', 'wp-members' ),
 			'redirect_to' => '',
 		);
 		$instance = wp_parse_args( ( array ) $instance, $defaults );
 
-		/* Title input */ ?>
+		// Title input. ?>
 		<p>
 			<label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:', 'wp-members' ); ?></label>
 			<input id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" value="<?php echo $instance['title']; ?>" style="width:95%;" />

includes/class-wp-members.php

@@ -1430,6 +1430,7 @@ public function loginout_script() {
 	 */
 	public function do_loginout_script() {
 		global $wpmem;
+		/** This filter is defined in /includes/api/api.php */
 		$logout = apply_filters( 'wpmem_logout_link', add_query_arg( 'a', 'logout' ) );
 		?><script type="text/javascript">
 			jQuery('.wpmem_loginout').html('<a class="login_button" href="<?php echo esc_url( $logout ); ?>"><?php echo $this->get_text( 'menu_logout' ); ?></a>');
@@ -1782,7 +1783,7 @@ function loginout_args( $args = array() ) {
 		$redirect = ( is_user_logged_in() ) ? $args['logout_redirect_to'] : $args['login_redirect_to'];
 		$text     = ( is_user_logged_in() ) ? $args['logout_text']        : $args['login_text'];
 		if ( is_user_logged_in() ) {
-			/** This filter is defined in /inc/dialogs.php */
+			/** This filter is defined in /includes/api/api.php */
 			$link = apply_filters( 'wpmem_logout_link', add_query_arg( 'a', 'logout' ) );
 		} else {
 			$link = wpmem_login_url( $redirect );

includes/deprecated.php

@@ -57,7 +57,7 @@ function wpmem_inc_status() {
 
 	global $user_login, $wpmem;
 
-	/** This filter is documented in wp-members/inc/dialogs.php */
+	/** This filter is defined in /includes/api/api.php */
 	$logout = apply_filters( 'wpmem_logout_link', $url . '/?a=logout' );
 
 	$status = '<p>' . sprintf( wpmem_get_text( 'sb_login_status' ), $user_login )
@@ -233,7 +233,7 @@ function wpmem_a_deactivate_user( $user_id ) {
  * Loads the form for changing password.
  *
  * @since 2.0.0
- * @since 3.2.0 Now a wrapper for $wpmem->forms->do_changepassword_form()
+ * @since 3.2.0 Now an alias for $wpmem->forms->do_changepassword_form()
  * @deprecated 3.3.0 Use wpmem_change_password_form() instead.
  *
  * @global object $wpmem The WP_Members object.
@@ -253,7 +253,7 @@ function wpmem_inc_changepassword() {
  * Loads the form for resetting password.
  *
  * @since 2.1.0
- * @since 3.2.0 Now a wrapper for $wpmem->forms->do_resetpassword_form()
+ * @since 3.2.0 Now an alias for $wpmem->forms->do_resetpassword_form()
  * @deprecated 3.3.0 Use wpmem_reset_password_form() instead.
  *
  * @global object $wpmem The WP_Members object.
@@ -426,7 +426,7 @@ function wpmem_get_captcha_err( $wpmem_captcha_err ) {
  *
  * @since 1.8
  * @since 3.1.4 Global $wpmem_regchk no longer needed.
- * @since 3.2.0 Now a wrapper for $wpmem->forms->do_login_form().
+ * @since 3.2.0 Now an alias for $wpmem->forms->do_login_form().
  * @deprecated 3.3.0 Use wpmem_login_form() instead.
  *
  * @global object $post         The WordPress Post object.
@@ -450,7 +450,7 @@ function wpmem_inc_login( $page = "page", $redirect_to = null, $show = 'show' )
  * Outputs the form for new user registration and existing user edits.
  *
  * @since 2.5.1
- * @since 3.1.7 Now a wrapper for $wpmem->forms->register_form()
+ * @since 3.1.7 Now an alias for $wpmem->forms->register_form()
  * @since 3.2.0 Preparing for deprecation, use wpmem_register_form() instead.
  * @deprecated 3.3.0 Use wpmem_register_form() instead.
  *

wp-members.php

@@ -128,7 +128,7 @@ function wpmem_init() {
 function wpmem_admin_options() {
 	global $wpmem;
 	if ( ! is_multisite() || ( is_multisite() && current_user_can( 'edit_theme_options' ) ) ) {
-		$plugin_page = add_options_page ( 'WP-Members', 'WP-Members', 'manage_options', 'wpmem-settings', 'wpmem_admin' );
+		$plugin_page = add_options_page( 'WP-Members', 'WP-Members', 'manage_options', 'wpmem-settings', 'wpmem_admin' );
 	}
 }