Fast Tip: Present All Customers Sorted by Metadata

Within the earlier submit on sorting customers by meta knowledge, I concluded with the next:

Be aware that how the standing is about will rely upon the plugin you’re engaged on and whether or not or not you wish to render a column on the All Customers web page for this. And I can present that in one other tip in a future submit.

By this, I imply that it’s one factor to really type the customers on the All Customers web page nevertheless it doesn’t make quite a lot of sense until there’s a column by which the standing is proven and the worth of mentioned standing.

Provided that, right here’s how we are able to present all customers sorted by the metadata that we reviewed within the earlier submit.

Present All Customers Sorted by Metadata

First, we wish to add a column on the All Customers web page. That is straightforward to do given the manage_users_columns hook. This filter will permit us so as to add a customized column to the array of columns that render on the web page.

In brief, we’re going so as to add a column header that reads Standing:

add_filter(
    'manage_users_columns',
    operate ($columns) {
        $columns['status'] = 'Standing';
        return $columns;
    }
);

This provides the column nevertheless it doesn’t present the worth. Utilizing yet another motion, we are able to add the worth of the metadata and we are able to render the worth inline with the given consumer.

add_action(
    'manage_users_custom_column',
    operate ($worth, $columnName, $userId) {
        if ('standing' === strtolower($columnName)) {
            $standing = get_user_meta($userId, 'standing', true);
            return '1' === $standing ? 'Energetic' : 'Inactive;';
        }
    },
    10,
    3
);

Within the above code, discover that we’re utilizing manage_users_custom_column hook.

Filters the show output of customized columns within the Customers record desk.

Developer Handbook

We’re additionally executing this with a precedence of 10 and we’re sending 3 arguments into the operate:

1. The worth
2. The column title
3. The ID of the consumer being rendered

We have to examine the $columnName worth. I exploit strtolower to make it straightforward to run a conditional examine towards the column. Because of this standing is decrease case.

Subsequent, we take the $userId after which get the metadata utilizing the get_user_meta WordPress API operate. We’ll specify the present $userId key, the standing meta key, after which specify true since we wish the worth to be returned as a string.

Lastly, we’ll evaluate the worth of $standing to 1 and decide whether or not or not the consumer is energetic or not. Relying on the result, we’ll return Energetic or Inactive. Subsequent to the consumer within the All Customers web page.