Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-25 22:35:02 +02:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
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.
Built from https://develop.svn.wordpress.org/trunk@54262


git-svn-id: http://core.svn.wordpress.org/trunk@53821 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2022-09-20 16:26:10 +00:00
parent 9d0887f112
commit 7049f79f97
3 changed files with 86 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
wp-includes/author-template.php
View File

@ -450,32 +450,63 @@ function wp_list_authors( $args = '' ) {
'include' => '', 'include' => '',
); );
$args = wp_parse_args( $args, $defaults ); $parsed_args = wp_parse_args( $args, $defaults );
$return = ''; $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'; $query_args['fields'] = 'ids';
$authors = get_users( $query_args );
$author_count = array(); /**
foreach ( (array) $wpdb->get_results( "SELECT DISTINCT post_author, COUNT(ID) AS count FROM $wpdb->posts WHERE " . get_private_posts_cap_sql( 'post' ) . ' GROUP BY post_author' ) as $row ) { * Filters the query arguments for the list of all authors of the site.
$author_count[ $row->post_author ] = $row->count; *
* @since 6.1.0
*
* @param array $query_args The query arguments for get_users().
* @param array $parsed_args The arguments passed to wp_list_authors() combined with the defaults.
*/
$query_args = apply_filters( 'wp_list_authors_args', $query_args, $parsed_args );
$authors = get_users( $query_args );
$post_counts = array();
/**
* Filters whether to short-circuit performing the query for author post counts.
*
* @since 6.1.0
*
* @param int[]|false $post_counts Array of post counts, keyed by author ID.
* @param array $parsed_args The arguments passed to wp_list_authors() combined with the defaults.
*/
$post_counts = apply_filters( 'pre_wp_list_authors_post_counts_query', false, $parsed_args );
if ( ! is_array( $post_counts ) ) {
$post_counts = $wpdb->get_results(
"SELECT DISTINCT post_author, COUNT(ID) AS count
FROM $wpdb->posts
WHERE " . get_private_posts_cap_sql( 'post' ) . '
GROUP BY post_author'
);
foreach ( (array) $post_counts as $row ) {
$post_counts[ $row->post_author ] = $row->count;
}
} }
foreach ( $authors as $author_id ) {
$posts = isset( $author_count[ $author_id ] ) ? $author_count[ $author_id ] : 0;
if ( ! $posts && $args['hide_empty'] ) { foreach ( $authors as $author_id ) {
$posts = isset( $post_counts[ $author_id ] ) ? $post_counts[ $author_id ] : 0;
if ( ! $posts && $parsed_args['hide_empty'] ) {
continue; continue;
} }
$author = get_userdata( $author_id ); $author = get_userdata( $author_id );
if ( $args['exclude_admin'] && 'admin' === $author->display_name ) { if ( $parsed_args['exclude_admin'] && 'admin' === $author->display_name ) {
continue; continue;
} }
if ( $args['show_fullname'] && $author->first_name && $author->last_name ) { if ( $parsed_args['show_fullname'] && $author->first_name && $author->last_name ) {
$name = sprintf( $name = sprintf(
/* translators: 1: User's first name, 2: Last name. */ /* translators: 1: User's first name, 2: Last name. */
_x( '%1$s %2$s', 'Display name based on first name and last name' ), _x( '%1$s %2$s', 'Display name based on first name and last name' ),
@ -486,13 +517,13 @@ function wp_list_authors( $args = '' ) {
$name = $author->display_name; $name = $author->display_name;
} }
if ( ! $args['html'] ) { if ( ! $parsed_args['html'] ) {
$return .= $name . ', '; $return .= $name . ', ';
continue; // No need to go further to process HTML. continue; // No need to go further to process HTML.
} }
if ( 'list' === $args['style'] ) { if ( 'list' === $parsed_args['style'] ) {
$return .= '<li>'; $return .= '<li>';
} }
@ -504,46 +535,46 @@ function wp_list_authors( $args = '' ) {
$name $name
); );
if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) { if ( ! empty( $parsed_args['feed_image'] ) || ! empty( $parsed_args['feed'] ) ) {
$link .= ' '; $link .= ' ';
if ( empty( $args['feed_image'] ) ) { if ( empty( $parsed_args['feed_image'] ) ) {
$link .= '('; $link .= '(';
} }
$link .= '<a href="' . get_author_feed_link( $author->ID, $args['feed_type'] ) . '"'; $link .= '<a href="' . get_author_feed_link( $author->ID, $parsed_args['feed_type'] ) . '"';
$alt = ''; $alt = '';
if ( ! empty( $args['feed'] ) ) { if ( ! empty( $parsed_args['feed'] ) ) {
$alt = ' alt="' . esc_attr( $args['feed'] ) . '"'; $alt = ' alt="' . esc_attr( $parsed_args['feed'] ) . '"';
$name = $args['feed']; $name = $parsed_args['feed'];
} }
$link .= '>'; $link .= '>';
if ( ! empty( $args['feed_image'] ) ) { if ( ! empty( $parsed_args['feed_image'] ) ) {
$link .= '<img src="' . esc_url( $args['feed_image'] ) . '" style="border: none;"' . $alt . ' />'; $link .= '<img src="' . esc_url( $parsed_args['feed_image'] ) . '" style="border: none;"' . $alt . ' />';
} else { } else {
$link .= $name; $link .= $name;
} }
$link .= '</a>'; $link .= '</a>';
if ( empty( $args['feed_image'] ) ) { if ( empty( $parsed_args['feed_image'] ) ) {
$link .= ')'; $link .= ')';
} }
} }
if ( $args['optioncount'] ) { if ( $parsed_args['optioncount'] ) {
$link .= ' (' . $posts . ')'; $link .= ' (' . $posts . ')';
} }
$return .= $link; $return .= $link;
$return .= ( 'list' === $args['style'] ) ? '</li>' : ', '; $return .= ( 'list' === $parsed_args['style'] ) ? '</li>' : ', ';
} }
$return = rtrim( $return, ', ' ); $return = rtrim( $return, ', ' );
if ( $args['echo'] ) { if ( $parsed_args['echo'] ) {
echo $return; echo $return;
} else { } else {
return $return; return $return;

47
wp-includes/user.php
View File

@ -811,22 +811,33 @@ function wp_list_users( $args = array() ) {
'include' => '', 'include' => '',
); );
$args = wp_parse_args( $args, $defaults ); $parsed_args = wp_parse_args( $args, $defaults );
$return = ''; $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'; $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 ) { foreach ( $users as $user_id ) {
$user = get_userdata( $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; continue;
} }
if ( $args['show_fullname'] && '' !== $user->first_name && '' !== $user->last_name ) { if ( $parsed_args['show_fullname'] && '' !== $user->first_name && '' !== $user->last_name ) {
$name = sprintf( $name = sprintf(
/* translators: 1: User's first name, 2: Last name. */ /* translators: 1: User's first name, 2: Last name. */
_x( '%1$s %2$s', 'Display name based on first name and last name' ), _x( '%1$s %2$s', 'Display name based on first name and last name' ),
@ -837,54 +848,54 @@ function wp_list_users( $args = array() ) {
$name = $user->display_name; $name = $user->display_name;
} }
if ( ! $args['html'] ) { if ( ! $parsed_args['html'] ) {
$return .= $name . ', '; $return .= $name . ', ';
continue; // No need to go further to process HTML. continue; // No need to go further to process HTML.
} }
if ( 'list' === $args['style'] ) { if ( 'list' === $parsed_args['style'] ) {
$return .= '<li>'; $return .= '<li>';
} }
$row = $name; $row = $name;
if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) { if ( ! empty( $parsed_args['feed_image'] ) || ! empty( $parsed_args['feed'] ) ) {
$row .= ' '; $row .= ' ';
if ( empty( $args['feed_image'] ) ) { if ( empty( $parsed_args['feed_image'] ) ) {
$row .= '('; $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 = ''; $alt = '';
if ( ! empty( $args['feed'] ) ) { if ( ! empty( $parsed_args['feed'] ) ) {
$alt = ' alt="' . esc_attr( $args['feed'] ) . '"'; $alt = ' alt="' . esc_attr( $parsed_args['feed'] ) . '"';
$name = $args['feed']; $name = $parsed_args['feed'];
} }
$row .= '>'; $row .= '>';
if ( ! empty( $args['feed_image'] ) ) { if ( ! empty( $parsed_args['feed_image'] ) ) {
$row .= '<img src="' . esc_url( $args['feed_image'] ) . '" style="border: none;"' . $alt . ' />'; $row .= '<img src="' . esc_url( $parsed_args['feed_image'] ) . '" style="border: none;"' . $alt . ' />';
} else { } else {
$row .= $name; $row .= $name;
} }
$row .= '</a>'; $row .= '</a>';
if ( empty( $args['feed_image'] ) ) { if ( empty( $parsed_args['feed_image'] ) ) {
$row .= ')'; $row .= ')';
} }
} }
$return .= $row; $return .= $row;
$return .= ( 'list' === $args['style'] ) ? '</li>' : ', '; $return .= ( 'list' === $parsed_args['style'] ) ? '</li>' : ', ';
} }
$return = rtrim( $return, ', ' ); $return = rtrim( $return, ', ' );
if ( ! $args['echo'] ) { if ( ! $parsed_args['echo'] ) {
return $return; return $return;
} }
echo $return; echo $return;

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.1-alpha-54261'; $wp_version = '6.1-alpha-54262';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.