Changeset 54262 for trunk/src/wp-includes/user.php

Timestamp:

09/20/2022 04:24:56 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Users: Make wp_list_authors() and wp_list_users() filterable.

This commit adds three filters to customize the wp_list_authors() and wp_list_users() output:

• wp_list_authors_args: Filters the query arguments for the list of all authors of the site.
• pre_wp_list_authors_post_counts_query: Filters whether to short-circuit performing the query for author post counts. This may be useful to account for custom post types or post statuses.
• wp_list_users_args: Filters the query arguments for the list of all users of the site.

Follow-up to [979], [3848], [5135], [5727], [31653], [52064], [53486], [53501].

Props kevinB, wonderboymusic, DrewAPicture, Mte90, audrasjb, rafiahmedd, costdev, nacin, afercia, chetan200891, hellofromTonya, TimothyBlynJacobs, chaion07, SergeyBiryukov.
Fixes #17025.

File:

• trunk/src/wp-includes/user.php (modified) (6 diffs)

trunk/src/wp-includes/user.php

@@ -812 +812 @@
         );
 
-        $args = wp_parse_args( $args, $defaults );
+        $parsed_args = wp_parse_args( $args, $defaults );
 
         $return = '';
 
-        $query_args           = wp_array_slice_assoc( $args, array( 'orderby', 'order', 'number', 'exclude', 'include' ) );
+        $query_args           = wp_array_slice_assoc( $parsed_args, array( 'orderby', 'order', 'number', 'exclude', 'include' ) );
         $query_args['fields'] = 'ids';
-        $users                = get_users( $query_args );
+
+        /**
+         * Filters the query arguments for the list of all users of the site.
+         *
+         * @since 6.1.0
+         *
+         * @param array $query_args  The query arguments for get_users().
+         * @param array $parsed_args The arguments passed to wp_list_users() combined with the defaults.
+         */
+        $query_args = apply_filters( 'wp_list_users_args', $query_args, $parsed_args );
+
+        $users = get_users( $query_args );
 
         foreach ( $users as $user_id ) {
                 $user = get_userdata( $user_id );
 
-                if ( $args['exclude_admin'] && 'admin' === $user->display_name ) {
+                if ( $parsed_args['exclude_admin'] && 'admin' === $user->display_name ) {
                         continue;
                 }
 
-                if ( $args['show_fullname'] && '' !== $user->first_name && '' !== $user->last_name ) {
+                if ( $parsed_args['show_fullname'] && '' !== $user->first_name && '' !== $user->last_name ) {
                         $name = sprintf(
                                 /* translators: 1: User's first name, 2: Last name. */
@@ -838 +849 @@
                 }
 
-                if ( ! $args['html'] ) {
+                if ( ! $parsed_args['html'] ) {
                         $return .= $name . ', ';
 
@@ -844 +855 @@
                 }
 
-                if ( 'list' === $args['style'] ) {
+                if ( 'list' === $parsed_args['style'] ) {
                         $return .= '<li>';
                 }
@@ -850 +861 @@
                 $row = $name;
 
-                if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) {
+                if ( ! empty( $parsed_args['feed_image'] ) || ! empty( $parsed_args['feed'] ) ) {
                         $row .= ' ';
-                        if ( empty( $args['feed_image'] ) ) {
+                        if ( empty( $parsed_args['feed_image'] ) ) {
                                 $row .= '(';
                         }
 
-                        $row .= '<a href="' . get_author_feed_link( $user->ID, $args['feed_type'] ) . '"';
+                        $row .= '<a href="' . get_author_feed_link( $user->ID, $parsed_args['feed_type'] ) . '"';
 
                         $alt = '';
-                        if ( ! empty( $args['feed'] ) ) {
-                                $alt  = ' alt="' . esc_attr( $args['feed'] ) . '"';
-                                $name = $args['feed'];
+                        if ( ! empty( $parsed_args['feed'] ) ) {
+                                $alt  = ' alt="' . esc_attr( $parsed_args['feed'] ) . '"';
+                                $name = $parsed_args['feed'];
                         }
 
                         $row .= '>';
 
-                        if ( ! empty( $args['feed_image'] ) ) {
-                                $row .= '<img src="' . esc_url( $args['feed_image'] ) . '" style="border: none;"' . $alt . ' />';
+                        if ( ! empty( $parsed_args['feed_image'] ) ) {
+                                $row .= '<img src="' . esc_url( $parsed_args['feed_image'] ) . '" style="border: none;"' . $alt . ' />';
                         } else {
                                 $row .= $name;
@@ -874 +885 @@
                         $row .= '</a>';
 
-                        if ( empty( $args['feed_image'] ) ) {
+                        if ( empty( $parsed_args['feed_image'] ) ) {
                                 $row .= ')';
                         }
@@ -880 +891 @@
 
                 $return .= $row;
-                $return .= ( 'list' === $args['style'] ) ? '</li>' : ', ';
+                $return .= ( 'list' === $parsed_args['style'] ) ? '</li>' : ', ';
         }
 
         $return = rtrim( $return, ', ' );
 
-        if ( ! $args['echo'] ) {
+        if ( ! $parsed_args['echo'] ) {
                 return $return;
         }