Admin Users panel add custom column and include in search

Adds the column Billing Phone to the administrative Users list screen and expands search fields to include this in search results.

add_filter( 'manage_users_columns', function( $column ) {

	$column['billing_phone'] = 'Phone number';

	return $column;

} );

add_filter( 'manage_users_custom_column', function( $val, $column_name, $user_id ) {

	switch( $column_name ) {
		case 'billing_phone':
			return get_user_meta( $user_id, 'billing_phone', true );
		default:
	}

	return $val;

}, 10, 3 );

add_action( 'pre_user_query', function( $query ) {

	// Users Page Only
	global $pagenow;
	if( $pagenow != 'users.php' ) {
		return;
	}

	// Search Only
	if( empty( $query->query_vars['search'] ) ) {
		return;
	}

	// Left Join Usermeta
	global $wpdb;
	$query->query_from .= sprintf(
		"
			LEFT JOIN %s umeta_phone
			ON umeta_phone.user_id = %s.ID
			AND umeta_phone.meta_key = 'billing_phone'
		",
		$wpdb->usermeta, $wpdb->users
	);

} );

// Add Usermeta To Search Columns
add_filter( 'user_search_columns', function( $search_columns, $search, $query ) {

	$search_columns[] = 'umeta_phone.meta_value';

	return $search_columns;

}, 10, 3 );

Instructions for Admin Users panel add custom column and include in search

  1. Log into a staging or locally hosted clone of your site.
  2. Install and activate Code Snippets plugin.
  3. WP Admin > Snippets > Add New
  4. Copy and paste the code from the section above.
  5. Check to ensure formatting came over properly.
  6. Customize the code as desired.
  7. Add a meaningful title.
  8. Select whether to run on front-end or back-end (or both).
  9. Click “Save and Activate”.
  10. Test your site to ensure it works.
  11. Disable if any problems, or recover.
  12. Repeat for live environment.

Need help modifying Admin Users panel add custom column and include in search?

Contact me. I can help with fitting projects or refer to my partner.

License

All code snippets are licensed GPLv2 (or later) matching WordPress licensing.

Except when otherwise stated in writing the copyright holders and/or other parties provide the program as-is without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose.

Disclaimer of warranty