• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar

RocketGeek

Home of WP-Members, The Original WordPress Membership Plugin

  • WordPress Plugins
    • WP-Members
      • FAQs
      • Quick Start
      • Documentation
      • Extensions
    • Advanced Options
      • Documentation
      • Purchase the Plugin
      • Get the Pro Bundle
    • Download Protect
      • Documentation
      • Purchase the Plugin
      • Get the Pro Bundle
    • Invite Codes
      • Documentation
      • Purchase the Plugin
      • Get the Pro Bundle
    • MailChimp Integration
      • Documentation
      • Purchase the Plugin
      • Get the Pro Bundle
    • PayPal Subscriptions
      • Documentation
      • Purchase the Plugin
      • Get the Pro Bundle
    • Salesforce Web-to-Lead
    • Security
      • Documentation
      • Purchase the Plugin
      • Get the Pro Bundle
    • Text Editor
      • Purchase the Plugin
      • Get the Pro Bundle
    • User List
      • Documentation
      • Purchase the Plugin
      • Get the Pro Bundle
    • User Tracking
      • Documentation
      • Purchase the Plugin
      • Get the Pro Bundle
    • Memberships for WooCommerce
    • WordPass
  • Blog
    • Basics
    • Tips and Tricks
    • Filters
    • Actions
    • Code Snippets
    • Shortcodes
    • Design
    • Release Announcements
  • Store
    • Cart
    • Checkout
  • Contact
  • Log In
  • Show Search
Hide Search
Home » Plugins » WP-Members » Documentation » Filter Hooks » wpmem_views_users

wpmem_views_users

Description

This filter allows you to filter the views available in the WP Users > All Users screen. You can use this to add custom views when used along with wpmem_query_where

Parameters

$views
(array) (required) An array containing all possible views.

$show
(string) (optional) The currently selected view (if a view is selected).

Examples

This example shows how to use wpmem_views_users to add a custom view generated by wpmem_query_where.

/**
 * This adds a custom query that can be used in the Users > All Users filtered views.
 * 
 * Set the variables according to comments noted in the snippet.  You will need to 
 * set values for the $view_name (a unique slug), $meta_key, and $meta_value as
 * noted below. 
 */
add_filter( 'wpmem_query_where', function( $query_where, $show ) {
    
    // Set these accordingly:
    
    // The view name: 
    $view_name  = 'my_unique_view_name';
    
    // The meta key of the field you are filtering by:
    $meta_key   = 'my_field_meta_key';
    
    // The value of the field you want to filter by:
    $meta_value = 'the field value';
    
    // Don't change this:
    $query_where = wpmem_add_query_where( $query_where, $view_name, $meta_key, $meta_value );
    return $query_where;
}, 10, 2 );


/**
 * This adds the link for the custom query you created above.
 * 
 * Similar to the snippet above, you'll need to set the variable values
 * to be used.  Note that some of them need to be the same as what you
 * set in the above snippet (the field name and value and the filter name).
 */
add_filter( 'wpmem_views_users', function( $views, $show ) {
    
    // Displayed value of your filter link in Users > All Users
    $name = "My Filter View";
    
    // Custom view name (should match $view_name used above)
    $view_name = "my_unique_view_name";
    
    // The meta key of the field you are filtering by (should
    // match what you're using above, this is for the count)
    $meta_key   = 'my_field_meta_key';
    
    // The value of the field you want to filter by (should
    // match what you're using above, this is for the count)
    $meta_value = 'the field value';
    
    // Don't change this:
    $views = wpmem_add_user_view_link( $views, $name, $view_name, $meta_key, $meta_value );
    return $views;
}, 10, 2 );

Notes

This filter only adds/removes filter view links in the Users > All Users screen. If you are adding a custom view, use this filter to add the link. You’ll need to also use wpmem_query_where to add the SQL parts for the custom view.

As of 3.4.5, there are API functions in the admin API for simplifying the adding of custom user views so that you do not have to write all of the code necessary to create the “current” class for the link and the count for the number in the view. You can use wpmem_add_user_view_link() to add a custom view link (or multiple view links).

It is highly recommended to use a unique prefix for the custom view slug. For example, if you have a custom view slug of “custom_view” and your site name is “My Site”, use “ms_” (thus making it “ms_custom_view”) to prefix any custom view slugs to minimize the chance of them conflicting with something in the plugin.

Changelog

Introduced in version 3.3.0

Source

wpmem_views_users is located in includes/admin/class-wp-members-admin-users.php

Not sure what to do with this code?

You're not a "coder" and don't know what to do? Don't worry! Code Snippets are the basic building blocks of WordPress customization, and once you know the basics, they are simple to use.

Here are some free articles to get you started:

  • Using Code Snippets from the Site
  • Using a code snippets plugin
  • The functions.php File
  • Create a plugin file for custom functions
  • Create a child theme
  • Do not modify plugin files!

For "hands on" help, consider a plugin support subscription or the Pro Bundle.

  • Getting Started
  • Recommended WordPress® Settings
  • Plugin Settings
    • Options
    • Fields
    • Dialogs
    • Emails
    • New Feature Settings
  • Managing Content
    • Restricting Posts
    • Restricting Pages
    • Show Excerpts
    • Custom Post Types
  • Managing Users
    • Import Users
    • Export Users
    • Edit Users
    • Search Users
  • Login
  • Registration
    • Choosing Fields
    • Create a Registration Page
    • Moderating Registration
    • Using CAPTCHA
    • Removing Registration Options
  • User Profile
  • Memberships
    • Membership Properties
    • Membership Levels
  • Menus
    • Individual Menu Items
    • Logged In Menus
    • Login/Logout Menu Link
  • Customizing Emails
    • Email Address
    • Email Content
    • Email Format
    • Email Shortcodes
    • Email Troubleshooting
  • Customizing Forms
    • Create a Custom Stylesheet
    • Using the WordPress Customizer
    • Login Form HTML
    • Registration Form HTML
    • Widget Login Form HTML
  • Translation and Localization
    • Maintain a custom translation file
    • Filter untranslated strings
    • Multi-language Considerations
  • Shortcodes
    • Pages and Forms
    • Login Status
    • User Fields
    • Memberships
    • Email
    • Other Shortcodes
  • WP-CLI Commands
  • API Functions
  • Filter Hooks
  • Action Hooks
  • FAQs
    • Email troubleshooting
    • Passwords are not being included in Emails
    • The plugin isn’t blocking my content
    • Are files protected?
    • How can I prevent registration spam?
    • How to add a shortcode
    • How to apply login redirects
    • Why can’t users log in?
    • Why does reCAPTCHA v3 fail?
    • Troubleshooting Really Simple Captcha
    • Why do I get a 403 error?
    • How do I use code snippets?
    • My changes aren’t showing up
    • How to hide the “Admin Bar”
    • How to add a forgot password link
    • Password reset doesn’t show any fields
    • Domain not included in the password reset link
    • There was an error processing the form
    • Hidden vs. Restricted
  • Demo Videos
  • How to Request Support
  • Copy Settings for Support
  • Hosting Recommendations

Ready to get started?

Join Today!

© 2025 · butlerblog.com · RocketGeek is built using WordPress, WP-Members, and the Genesis Framework

  • butlerblog.com
  • WP-Members Support Subscription
  • Terms of Service
  • Privacy Policy
  • Refund Policy