2004-01-27 10:58:01 +01:00
< ? php
2007-12-17 00:47:58 +01:00
/**
* Author Template functions for use in themes .
*
2008-05-25 17:45:05 +02:00
* These functions must be used within the WordPress Loop .
*
2015-04-12 23:29:32 +02:00
* @ link https :// codex . wordpress . org / Author_Templates
2008-05-25 17:45:05 +02:00
*
2007-12-17 00:47:58 +01:00
* @ package WordPress
* @ subpackage Template
*/
2005-06-13 01:22:06 +02:00
2007-06-02 05:04:01 +02:00
/**
2022-04-15 17:14:09 +02:00
* Retrieves the author of the current post .
2007-12-17 00:47:58 +01:00
*
2013-12-24 19:57:12 +01:00
* @ since 1.5 . 0
*
2020-07-23 09:39:02 +02:00
* @ global WP_User $authordata The current author ' s data .
2007-12-17 00:47:58 +01:00
*
2007-06-02 05:04:01 +02:00
* @ param string $deprecated Deprecated .
2015-05-21 22:10:26 +02:00
* @ return string | null The author ' s display name .
2007-06-02 05:04:01 +02:00
*/
2017-12-01 00:11:00 +01:00
function get_the_author ( $deprecated = '' ) {
2005-10-12 19:01:50 +02:00
global $authordata ;
2009-12-30 17:23:39 +01:00
2017-12-01 00:11:00 +01:00
if ( ! empty ( $deprecated ) ) {
2016-07-06 14:40:29 +02:00
_deprecated_argument ( __FUNCTION__ , '2.1.0' );
2017-12-01 00:11:00 +01:00
}
2009-12-30 17:23:39 +01:00
2013-09-13 21:25:10 +02:00
/**
2016-05-22 20:25:26 +02:00
* Filters the display name of the current post ' s author .
2013-09-13 21:25:10 +02:00
*
* @ since 2.9 . 0
*
2020-07-23 09:39:02 +02:00
* @ param string | null $display_name The author ' s display name .
2013-09-13 21:25:10 +02:00
*/
2017-12-01 00:11:00 +01:00
return apply_filters ( 'the_author' , is_object ( $authordata ) ? $authordata -> display_name : null );
2004-01-27 10:58:01 +01:00
}
2005-06-13 01:22:06 +02:00
2007-06-02 05:04:01 +02:00
/**
2022-04-15 17:14:09 +02:00
* Displays the name of the author of the current post .
2007-12-17 00:47:58 +01:00
*
2008-05-25 17:45:05 +02:00
* The behavior of this function is based off of old functionality predating
* get_the_author () . This function is not deprecated , but is designed to echo
* the value from get_the_author () and as an result of any old theme that might
* still use the old behavior will also pass the value from get_the_author () .
2007-12-28 22:19:44 +01:00
*
2008-05-25 17:45:05 +02:00
* The normal , expected behavior of this function is to echo the author and not
2016-05-13 20:41:31 +02:00
* return it . However , backward compatibility has to be maintained .
2007-12-28 22:19:44 +01:00
*
2007-12-17 00:47:58 +01:00
* @ since 0.71
2020-06-16 23:07:14 +02:00
*
2007-06-02 05:04:01 +02:00
* @ see get_the_author ()
2019-07-26 00:45:57 +02:00
* @ link https :// developer . wordpress . org / reference / functions / the_author /
2007-12-17 00:47:58 +01:00
*
2019-04-01 16:23:53 +02:00
* @ param string $deprecated Deprecated .
* @ param bool $deprecated_echo Deprecated . Use get_the_author () . Echo the string or return it .
2015-05-21 22:10:26 +02:00
* @ return string | null The author ' s display name , from get_the_author () .
2007-06-02 05:04:01 +02:00
*/
2009-12-30 17:23:39 +01:00
function the_author ( $deprecated = '' , $deprecated_echo = true ) {
2015-11-06 00:38:27 +01:00
if ( ! empty ( $deprecated ) ) {
2016-07-06 14:40:29 +02:00
_deprecated_argument ( __FUNCTION__ , '2.1.0' );
2015-11-06 00:38:27 +01:00
}
if ( true !== $deprecated_echo ) {
2017-12-01 00:11:00 +01:00
_deprecated_argument (
2018-08-17 03:51:36 +02:00
__FUNCTION__ ,
'1.5.0' ,
2017-12-01 00:11:00 +01:00
sprintf (
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 19:13:59 +02:00
/* translators: %s: get_the_author() */
2017-12-01 00:11:00 +01:00
__ ( 'Use %s instead if you do not want the value echoed.' ),
2015-11-06 00:38:27 +01:00
'<code>get_the_author()</code>'
)
);
}
if ( $deprecated_echo ) {
2006-08-31 07:07:12 +02:00
echo get_the_author ();
2015-11-06 00:38:27 +01:00
}
2006-08-31 07:07:12 +02:00
return get_the_author ();
2004-12-16 00:15:17 +01:00
}
2009-02-27 18:54:47 +01:00
/**
2022-04-15 17:14:09 +02:00
* Retrieves the author who last edited the current post .
2009-02-27 18:54:47 +01:00
*
2013-12-24 19:57:12 +01:00
* @ since 2.8 . 0
*
2022-04-15 15:55:10 +02:00
* @ return string | void The author ' s display name , empty string if unknown .
2009-02-27 18:54:47 +01:00
*/
function get_the_modified_author () {
2019-01-08 06:50:49 +01:00
$last_id = get_post_meta ( get_post () -> ID , '_edit_last' , true );
if ( $last_id ) {
2017-12-01 00:11:00 +01:00
$last_user = get_userdata ( $last_id );
2013-09-13 21:25:10 +02:00
/**
2016-05-22 20:25:26 +02:00
* Filters the display name of the author who last edited the current post .
2013-09-13 21:25:10 +02:00
*
* @ since 2.8 . 0
*
2022-04-15 15:55:10 +02:00
* @ param string $display_name The author ' s display name , empty string if unknown .
2013-09-13 21:25:10 +02:00
*/
2022-04-15 15:47:12 +02:00
return apply_filters ( 'the_modified_author' , $last_user ? $last_user -> display_name : '' );
2009-02-27 18:54:47 +01:00
}
}
/**
2022-04-15 17:14:09 +02:00
* Displays the name of the author who last edited the current post ,
2015-05-21 22:10:26 +02:00
* if the author ' s ID is available .
2009-02-27 18:54:47 +01:00
*
2013-12-24 19:57:12 +01:00
* @ since 2.8 . 0
*
2009-02-27 18:54:47 +01:00
* @ see get_the_author ()
*/
function the_modified_author () {
echo get_the_modified_author ();
}
2007-06-02 05:04:01 +02:00
/**
2017-06-26 20:24:40 +02:00
* Retrieves the requested data of the author of the current post .
*
* Valid values for the `$field` parameter include :
*
* - admin_color
* - aim
* - comment_shortcuts
* - description
* - display_name
* - first_name
* - ID
* - jabber
* - last_name
* - nickname
* - plugins_last_view
* - plugins_per_page
* - rich_editing
Editor: Add CodeMirror-powered code editor with syntax highlighting, linting, and auto-completion.
* Code editor is integrated into the Theme/Plugin Editor, Additional CSS in Customizer, and Custom HTML widget. Code editor is not yet integrated into the post editor, and it may not be until accessibility concerns are addressed.
* The CodeMirror component in the Custom HTML widget is integrated in a similar way to TinyMCE being integrated into the Text widget, adopting the same approach for integrating dynamic JavaScript-initialized fields.
* Linting is performed for JS, CSS, HTML, and JSON via JSHint, CSSLint, HTMLHint, and JSONLint respectively. Linting is not yet supported for PHP.
* When user lacks `unfiltered_html` the capability, the Custom HTML widget will report any Kses-invalid elements and attributes as errors via a custom Kses rule for HTMLHint.
* When linting errors are detected, the user will be prevented from saving the code until the errors are fixed, reducing instances of broken websites.
* The placeholder value is removed from Custom CSS in favor of a fleshed-out section description which now auto-expands when the CSS field is empty. See #39892.
* The CodeMirror library is included as `wp.CodeMirror` to prevent conflicts with any existing `CodeMirror` global.
* An `wp.codeEditor.initialize()` API in JS is provided to convert a `textarea` into CodeMirror, with a `wp_enqueue_code_editor()` function in PHP to manage enqueueing the assets and settings needed to edit a given type of code.
* A user preference is added to manage whether or not "syntax highlighting" is enabled. The feature is opt-out, being enabled by default.
* Allowed file extensions in the theme and plugin editors have been updated to include formats which CodeMirror has modes for: `conf`, `css`, `diff`, `patch`, `html`, `htm`, `http`, `js`, `json`, `jsx`, `less`, `md`, `php`, `phtml`, `php3`, `php4`, `php5`, `php7`, `phps`, `scss`, `sass`, `sh`, `bash`, `sql`, `svg`, `xml`, `yml`, `yaml`, `txt`.
Props westonruter, georgestephanis, obenland, melchoyce, pixolin, mizejewski, michelleweber, afercia, grahamarmfield, samikeijonen, rianrietveld, iseulde.
See #38707.
Fixes #12423, #39892.
Built from https://develop.svn.wordpress.org/trunk@41376
git-svn-id: http://core.svn.wordpress.org/trunk@41209 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-13 08:08:47 +02:00
* - syntax_highlighting
2017-06-26 20:24:40 +02:00
* - user_activation_key
* - user_description
* - user_email
* - user_firstname
* - user_lastname
* - user_level
* - user_login
* - user_nicename
* - user_pass
* - user_registered
* - user_status
* - user_url
* - yim
*
2009-05-25 01:47:49 +02:00
* @ since 2.8 . 0
2015-05-22 06:14:24 +02:00
*
2020-07-23 09:39:02 +02:00
* @ global WP_User $authordata The current author ' s data .
2015-05-22 06:14:24 +02:00
*
2019-04-01 16:23:53 +02:00
* @ param string $field Optional . The user field to retrieve . Default empty .
* @ param int | false $user_id Optional . User ID .
2017-06-13 04:33:42 +02:00
* @ return string The author 's field from the current author' s DB object , otherwise an empty string .
2007-06-02 05:04:01 +02:00
*/
2012-04-23 23:34:07 +02:00
function get_the_author_meta ( $field = '' , $user_id = false ) {
2015-05-25 15:06:25 +02:00
$original_user_id = $user_id ;
2012-04-23 23:34:07 +02:00
if ( ! $user_id ) {
2009-04-30 18:27:17 +02:00
global $authordata ;
2012-04-24 16:41:23 +02:00
$user_id = isset ( $authordata -> ID ) ? $authordata -> ID : 0 ;
2012-04-23 23:34:07 +02:00
} else {
2009-04-30 21:55:29 +02:00
$authordata = get_userdata ( $user_id );
2012-04-23 23:34:07 +02:00
}
2004-01-27 10:58:01 +01:00
2020-04-05 05:02:11 +02:00
if ( in_array ( $field , array ( 'login' , 'pass' , 'nicename' , 'email' , 'url' , 'registered' , 'activation_key' , 'status' ), true ) ) {
2012-04-23 23:34:07 +02:00
$field = 'user_' . $field ;
2017-12-01 00:11:00 +01:00
}
2009-05-25 01:47:49 +02:00
2012-04-23 23:34:07 +02:00
$value = isset ( $authordata -> $field ) ? $authordata -> $field : '' ;
2007-06-02 05:04:01 +02:00
2013-09-13 21:25:10 +02:00
/**
2016-05-22 20:25:26 +02:00
* Filters the value of the requested user metadata .
2013-09-13 21:25:10 +02:00
*
* The filter name is dynamic and depends on the $field parameter of the function .
*
* @ since 2.8 . 0
2015-05-25 15:06:25 +02:00
* @ since 4.3 . 0 The `$original_user_id` parameter was added .
2013-09-13 21:25:10 +02:00
*
2019-04-01 16:23:53 +02:00
* @ param string $value The value of the metadata .
* @ param int $user_id The user ID for the value .
* @ param int | false $original_user_id The original user ID , as passed to the function .
2013-09-13 21:25:10 +02:00
*/
2016-12-14 05:18:42 +01:00
return apply_filters ( " get_the_author_ { $field } " , $value , $user_id , $original_user_id );
2004-01-27 10:58:01 +01:00
}
2007-06-02 05:04:01 +02:00
/**
2015-05-22 06:14:24 +02:00
* Outputs the field from the user 's DB object. Defaults to current post' s author .
*
2009-05-25 01:47:49 +02:00
* @ since 2.8 . 0
2015-05-22 06:14:24 +02:00
*
2019-04-01 16:23:53 +02:00
* @ param string $field Selects the field of the users record . See get_the_author_meta ()
* for the list of possible fields .
* @ param int | false $user_id Optional . User ID .
2017-06-26 20:24:40 +02:00
*
* @ see get_the_author_meta ()
2007-06-02 05:04:01 +02:00
*/
2013-09-13 21:25:10 +02:00
function the_author_meta ( $field = '' , $user_id = false ) {
$author_meta = get_the_author_meta ( $field , $user_id );
/**
2022-04-15 17:14:09 +02:00
* Filters the value of the requested user metadata .
2013-09-13 21:25:10 +02:00
*
* The filter name is dynamic and depends on the $field parameter of the function .
*
* @ since 2.8 . 0
*
2019-04-01 16:23:53 +02:00
* @ param string $author_meta The value of the metadata .
* @ param int | false $user_id The user ID .
2013-09-13 21:25:10 +02:00
*/
2016-12-14 05:18:42 +01:00
echo apply_filters ( " the_author_ { $field } " , $author_meta , $user_id );
2004-01-27 10:58:01 +01:00
}
2010-04-07 14:26:28 +02:00
/**
2022-04-15 17:14:09 +02:00
* Retrieves either author 's link or author' s name .
2010-04-07 14:26:28 +02:00
*
* If the author has a home page set , return an HTML link , otherwise just return the
* author ' s name .
2015-05-21 22:10:26 +02:00
*
2016-12-27 10:21:44 +01:00
* @ since 3.0 . 0
*
2022-04-12 01:38:08 +02:00
* @ global WP_User $authordata The current author ' s data .
*
2015-05-21 22:10:26 +02:00
* @ return string | null An HTML link if the author ' s url exist in user meta ,
* else the result of get_the_author () .
2010-04-07 14:26:28 +02:00
*/
function get_the_author_link () {
2017-12-01 00:11:00 +01:00
if ( get_the_author_meta ( 'url' ) ) {
2022-04-12 01:38:08 +02:00
global $authordata ;
$author_url = get_the_author_meta ( 'url' );
$author_display_name = get_the_author ();
$link = sprintf (
2017-12-01 00:11:00 +01:00
'<a href="%1$s" title="%2$s" rel="author external">%3$s</a>' ,
2022-04-12 01:38:08 +02:00
esc_url ( $author_url ),
2019-09-03 02:41:05 +02:00
/* translators: %s: Author's display name. */
2022-04-12 01:38:08 +02:00
esc_attr ( sprintf ( __ ( 'Visit %s’s website' ), $author_display_name ) ),
$author_display_name
2016-08-24 01:18:29 +02:00
);
2022-04-12 01:38:08 +02:00
/**
* Filters the author URL link HTML .
*
* @ since 6.0 . 0
*
* @ param string $link The default rendered author HTML link .
* @ param string $author_url Author ' s URL .
* @ param WP_User $authordata Author user data .
*/
return apply_filters ( 'the_author_link' , $link , $author_url , $authordata );
2010-04-07 14:26:28 +02:00
} else {
return get_the_author ();
}
}
2007-06-02 05:04:01 +02:00
/**
2022-04-15 17:14:09 +02:00
* Displays either author 's link or author' s name .
2008-05-25 17:45:05 +02:00
*
* If the author has a home page set , echo an HTML link , otherwise just echo the
* author ' s name .
2007-12-17 00:47:58 +01:00
*
2019-07-26 00:45:57 +02:00
* @ link https :// developer . wordpress . org / reference / functions / the_author_link /
2013-12-24 19:57:12 +01:00
*
* @ since 2.1 . 0
2007-06-02 05:04:01 +02:00
*/
2006-08-30 20:07:49 +02:00
function the_author_link () {
2010-04-07 14:26:28 +02:00
echo get_the_author_link ();
2006-08-30 20:07:49 +02:00
}
2007-06-02 05:04:01 +02:00
/**
2022-04-15 17:14:09 +02:00
* Retrieves the number of posts by the author of the current post .
2007-12-17 00:47:58 +01:00
*
2013-12-24 19:57:12 +01:00
* @ since 1.5 . 0
*
2007-06-02 05:04:01 +02:00
* @ return int The number of posts by the author .
*/
2004-12-16 00:15:17 +01:00
function get_the_author_posts () {
2014-05-11 02:26:14 +02:00
$post = get_post ();
if ( ! $post ) {
return 0 ;
}
2015-01-08 20:53:22 +01:00
return count_user_posts ( $post -> post_author , $post -> post_type );
2004-12-16 00:15:17 +01:00
}
2005-10-12 19:01:50 +02:00
2007-06-02 05:04:01 +02:00
/**
2022-04-15 17:14:09 +02:00
* Displays the number of posts by the author of the current post .
2007-12-17 00:47:58 +01:00
*
2019-07-26 00:45:57 +02:00
* @ link https :// developer . wordpress . org / reference / functions / the_author_posts /
2007-12-17 00:47:58 +01:00
* @ since 0.71
2007-06-02 05:04:01 +02:00
*/
2004-01-27 10:58:01 +01:00
function the_author_posts () {
2005-10-12 19:01:50 +02:00
echo get_the_author_posts ();
2004-01-27 10:58:01 +01:00
}
2007-06-02 05:04:01 +02:00
/**
2015-09-29 03:49:25 +02:00
* Retrieves an HTML link to the author page of the current post ' s author .
2007-12-17 00:47:58 +01:00
*
2015-09-29 03:49:25 +02:00
* Returns an HTML - formatted link using get_author_posts_url () .
2007-12-17 00:47:58 +01:00
*
2015-09-29 03:49:25 +02:00
* @ since 4.4 . 0
2015-05-21 22:10:26 +02:00
*
2020-07-23 09:39:02 +02:00
* @ global WP_User $authordata The current author ' s data .
2015-05-22 06:14:24 +02:00
*
2019-01-16 06:54:49 +01:00
* @ return string An HTML link to the author page , or an empty string if $authordata isn ' t defined .
2007-06-02 05:04:01 +02:00
*/
2015-09-29 03:49:25 +02:00
function get_the_author_posts_link () {
2005-10-12 19:01:50 +02:00
global $authordata ;
2015-05-22 06:14:24 +02:00
if ( ! is_object ( $authordata ) ) {
2019-01-16 06:54:49 +01:00
return '' ;
2015-05-22 06:14:24 +02:00
}
2017-12-01 00:11:00 +01:00
$link = sprintf (
'<a href="%1$s" title="%2$s" rel="author">%3$s</a>' ,
2013-02-28 19:58:52 +01:00
esc_url ( get_author_posts_url ( $authordata -> ID , $authordata -> user_nicename ) ),
2019-09-03 02:41:05 +02:00
/* translators: %s: Author's display name. */
2009-08-18 18:05:07 +02:00
esc_attr ( sprintf ( __ ( 'Posts by %s' ), get_the_author () ) ),
2007-06-02 05:04:01 +02:00
get_the_author ()
);
2013-09-13 21:25:10 +02:00
/**
2016-05-22 20:25:26 +02:00
* Filters the link to the author page of the author of the current post .
2013-09-13 21:25:10 +02:00
*
* @ since 2.9 . 0
*
* @ param string $link HTML link .
*/
2015-09-29 03:49:25 +02:00
return apply_filters ( 'the_author_posts_link' , $link );
}
/**
* Displays an HTML link to the author page of the current post ' s author .
*
* @ since 1.2 . 0
* @ since 4.4 . 0 Converted into a wrapper for get_the_author_posts_link ()
*
* @ param string $deprecated Unused .
*/
function the_author_posts_link ( $deprecated = '' ) {
if ( ! empty ( $deprecated ) ) {
2016-07-06 14:40:29 +02:00
_deprecated_argument ( __FUNCTION__ , '2.1.0' );
2015-09-29 03:49:25 +02:00
}
echo get_the_author_posts_link ();
2007-06-02 05:04:01 +02:00
}
/**
2022-04-15 17:14:09 +02:00
* Retrieves the URL to the author page for the user with the ID provided .
2007-12-17 00:47:58 +01:00
*
2008-08-27 08:45:13 +02:00
* @ since 2.1 . 0
2015-05-22 06:14:24 +02:00
*
2019-08-04 03:19:56 +02:00
* @ global WP_Rewrite $wp_rewrite WordPress rewrite component .
2015-05-22 06:14:24 +02:00
*
2015-12-17 18:30:43 +01:00
* @ param int $author_id Author ID .
* @ param string $author_nicename Optional . The author ' s nicename ( slug ) . Default empty .
2007-06-02 05:04:01 +02:00
* @ return string The URL to the author ' s page .
*/
2015-12-17 18:30:43 +01:00
function get_author_posts_url ( $author_id , $author_nicename = '' ) {
2007-12-06 20:49:33 +01:00
global $wp_rewrite ;
2022-01-12 12:17:08 +01:00
$author_id = ( int ) $author_id ;
$link = $wp_rewrite -> get_author_permastruct ();
2005-10-12 19:01:50 +02:00
2017-12-01 00:11:00 +01:00
if ( empty ( $link ) ) {
2010-11-17 17:38:28 +01:00
$file = home_url ( '/' );
2022-01-12 12:17:08 +01:00
$link = $file . '?author=' . $author_id ;
2005-10-12 19:01:50 +02:00
} else {
2020-05-16 20:42:12 +02:00
if ( '' === $author_nicename ) {
2017-12-01 00:11:00 +01:00
$user = get_userdata ( $author_id );
if ( ! empty ( $user -> user_nicename ) ) {
2006-07-28 01:27:27 +02:00
$author_nicename = $user -> user_nicename ;
2017-12-01 00:11:00 +01:00
}
2006-07-28 01:27:27 +02:00
}
2017-12-01 00:11:00 +01:00
$link = str_replace ( '%author%' , $author_nicename , $link );
2010-11-16 17:09:46 +01:00
$link = home_url ( user_trailingslashit ( $link ) );
2005-10-12 19:01:50 +02:00
}
2013-09-13 21:25:10 +02:00
/**
2016-05-22 20:25:26 +02:00
* Filters the URL to the author ' s page .
2013-09-13 21:25:10 +02:00
*
* @ since 2.1 . 0
*
* @ param string $link The URL to the author ' s page .
2020-06-28 16:09:04 +02:00
* @ param int $author_id The author ' s ID .
2013-09-13 21:25:10 +02:00
* @ param string $author_nicename The author ' s nice name .
*/
$link = apply_filters ( 'author_link' , $link , $author_id , $author_nicename );
2005-10-12 19:01:50 +02:00
return $link ;
2004-03-19 17:20:49 +01:00
}
2007-06-02 05:04:01 +02:00
/**
2022-04-15 17:14:09 +02:00
* Lists all the authors of the site , with several options available .
2007-12-17 00:47:58 +01:00
*
2019-07-26 00:45:57 +02:00
* @ link https :// developer . wordpress . org / reference / functions / wp_list_authors /
2014-06-30 00:34:14 +02:00
*
2008-08-27 08:45:13 +02:00
* @ since 1.2 . 0
2014-06-30 00:34:14 +02:00
*
2015-10-15 01:44:25 +02:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-22 06:14:24 +02:00
*
2014-06-30 00:34:14 +02:00
* @ param string | array $args {
* Optional . Array or string of default arguments .
*
2016-07-04 16:34:27 +02:00
* @ type string $orderby How to sort the authors . Accepts 'nicename' , 'email' , 'url' , 'registered' ,
* 'user_nicename' , 'user_email' , 'user_url' , 'user_registered' , 'name' ,
* 'display_name' , 'post_count' , 'ID' , 'meta_value' , 'user_login' . Default 'name' .
* @ type string $order Sorting direction for $orderby . Accepts 'ASC' , 'DESC' . Default 'ASC' .
* @ type int $number Maximum authors to return or display . Default empty ( all authors ) .
* @ type bool $optioncount Show the count in parenthesis next to the author ' s name . Default false .
2019-01-09 07:52:50 +01:00
* @ type bool $exclude_admin Whether to exclude the 'admin' account , if it exists . Default true .
2016-07-04 16:34:27 +02:00
* @ type bool $show_fullname Whether to show the author ' s full name . Default false .
* @ type bool $hide_empty Whether to hide any authors with no posts . Default true .
* @ type string $feed If not empty , show a link to the author ' s feed and use this text as the alt
* parameter of the link . Default empty .
* @ type string $feed_image If not empty , show a link to the author ' s feed and use this image URL as
* clickable anchor . Default empty .
2019-08-11 19:21:57 +02:00
* @ type string $feed_type The feed type to link to . Possible values include 'rss2' , 'atom' .
* Default is the value of get_default_feed () .
2016-07-04 16:34:27 +02:00
* @ type bool $echo Whether to output the result or instead return it . Default true .
* @ type string $style If 'list' , each author is wrapped in an `<li>` element , otherwise the authors
* will be separated by commas .
* @ type bool $html Whether to list the items in HTML form or plaintext . Default true .
2020-11-19 19:24:09 +01:00
* @ type int [] | string $exclude Array or comma / space - separated list of author IDs to exclude . Default empty .
* @ type int [] | string $include Array or comma / space - separated list of author IDs to include . Default empty .
2014-06-30 00:34:14 +02:00
* }
2020-01-11 19:32:05 +01:00
* @ return void | string Void if 'echo' argument is true , list of authors if 'echo' is false .
2007-06-02 05:04:01 +02:00
*/
2014-05-13 08:02:14 +02:00
function wp_list_authors ( $args = '' ) {
2007-03-29 03:39:05 +02:00
global $wpdb ;
2007-06-14 04:25:30 +02:00
2007-09-04 01:32:58 +02:00
$defaults = array (
2017-12-01 00:11:00 +01:00
'orderby' => 'name' ,
'order' => 'ASC' ,
'number' => '' ,
'optioncount' => false ,
'exclude_admin' => true ,
'show_fullname' => false ,
'hide_empty' => true ,
'feed' => '' ,
'feed_image' => '' ,
'feed_type' => '' ,
'echo' => true ,
'style' => 'list' ,
'html' => true ,
'exclude' => '' ,
'include' => '' ,
2007-05-11 05:10:05 +02:00
);
2007-06-01 07:43:24 +02:00
2010-09-15 21:52:25 +02:00
$args = wp_parse_args ( $args , $defaults );
2007-06-01 07:43:24 +02:00
$return = '' ;
2017-12-01 00:11:00 +01:00
$query_args = wp_array_slice_assoc ( $args , array ( 'orderby' , 'order' , 'number' , 'exclude' , 'include' ) );
2010-12-21 17:27:34 +01:00
$query_args [ 'fields' ] = 'ids' ;
2017-12-01 00:11:00 +01:00
$authors = get_users ( $query_args );
2007-06-01 07:43:24 +02:00
2007-03-29 03:39:05 +02:00
$author_count = array ();
2017-12-01 00:11:00 +01:00
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 ) {
$author_count [ $row -> post_author ] = $row -> count ;
2014-05-13 08:02:14 +02:00
}
2010-12-21 17:27:34 +01:00
foreach ( $authors as $author_id ) {
2019-04-17 16:50:50 +02:00
$posts = isset ( $author_count [ $author_id ] ) ? $author_count [ $author_id ] : 0 ;
2009-03-18 03:43:45 +01:00
2019-04-17 16:50:50 +02:00
if ( ! $posts && $args [ 'hide_empty' ] ) {
2010-09-15 21:52:25 +02:00
continue ;
2014-05-13 08:02:14 +02:00
}
2009-03-18 03:43:45 +01:00
2019-04-17 16:50:50 +02:00
$author = get_userdata ( $author_id );
2005-10-12 19:01:50 +02:00
2019-04-17 16:50:50 +02:00
if ( $args [ 'exclude_admin' ] && 'admin' === $author -> display_name ) {
2010-09-15 21:52:25 +02:00
continue ;
2014-05-13 08:02:14 +02:00
}
2010-09-15 21:52:25 +02:00
2014-05-13 08:02:14 +02:00
if ( $args [ 'show_fullname' ] && $author -> first_name && $author -> last_name ) {
2005-10-12 19:01:50 +02:00
$name = " $author->first_name $author->last_name " ;
2014-05-13 08:02:14 +02:00
} else {
2010-09-15 21:52:25 +02:00
$name = $author -> display_name ;
2014-05-13 08:02:14 +02:00
}
2005-10-12 19:01:50 +02:00
2014-05-13 08:02:14 +02:00
if ( ! $args [ 'html' ] ) {
2010-09-15 21:52:25 +02:00
$return .= $name . ', ' ;
2009-02-15 10:06:24 +01:00
2010-09-15 21:52:25 +02:00
continue ; // No need to go further to process HTML.
2009-02-15 10:06:24 +01:00
}
2020-05-16 20:42:12 +02:00
if ( 'list' === $args [ 'style' ] ) {
2007-06-01 07:43:24 +02:00
$return .= '<li>' ;
2010-09-15 21:52:25 +02:00
}
2017-12-01 00:11:00 +01:00
$link = sprintf (
'<a href="%1$s" title="%2$s">%3$s</a>' ,
2021-06-21 08:06:57 +02:00
esc_url ( get_author_posts_url ( $author -> ID , $author -> user_nicename ) ),
2019-09-03 02:41:05 +02:00
/* translators: %s: Author's display name. */
2016-08-24 01:18:29 +02:00
esc_attr ( sprintf ( __ ( 'Posts by %s' ), $author -> display_name ) ),
$name
);
2010-09-15 21:52:25 +02:00
2014-05-13 08:02:14 +02:00
if ( ! empty ( $args [ 'feed_image' ] ) || ! empty ( $args [ 'feed' ] ) ) {
2010-09-15 21:52:25 +02:00
$link .= ' ' ;
2014-05-13 08:02:14 +02:00
if ( empty ( $args [ 'feed_image' ] ) ) {
2010-09-15 21:52:25 +02:00
$link .= '(' ;
}
2014-05-13 08:02:14 +02:00
$link .= '<a href="' . get_author_feed_link ( $author -> ID , $args [ 'feed_type' ] ) . '"' ;
2010-09-15 21:52:25 +02:00
2014-03-18 23:02:15 +01:00
$alt = '' ;
2014-05-13 08:02:14 +02:00
if ( ! empty ( $args [ 'feed' ] ) ) {
2017-12-01 00:11:00 +01:00
$alt = ' alt="' . esc_attr ( $args [ 'feed' ] ) . '"' ;
2014-05-13 08:02:14 +02:00
$name = $args [ 'feed' ];
2005-10-12 19:01:50 +02:00
}
2004-03-23 05:45:27 +01:00
2010-09-15 21:52:25 +02:00
$link .= '>' ;
2014-05-13 08:02:14 +02:00
if ( ! empty ( $args [ 'feed_image' ] ) ) {
$link .= '<img src="' . esc_url ( $args [ 'feed_image' ] ) . '" style="border: none;"' . $alt . ' />' ;
} else {
2010-09-15 21:52:25 +02:00
$link .= $name ;
2014-05-13 08:02:14 +02:00
}
2010-09-15 21:52:25 +02:00
$link .= '</a>' ;
2004-03-23 05:45:27 +01:00
2014-05-13 08:02:14 +02:00
if ( empty ( $args [ 'feed_image' ] ) ) {
2010-09-15 21:52:25 +02:00
$link .= ')' ;
2014-05-13 08:02:14 +02:00
}
2005-10-12 19:01:50 +02:00
}
2004-03-23 05:45:27 +01:00
2014-05-13 08:02:14 +02:00
if ( $args [ 'optioncount' ] ) {
2017-12-01 00:11:00 +01:00
$link .= ' (' . $posts . ')' ;
2014-05-13 08:02:14 +02:00
}
2010-09-15 21:52:25 +02:00
$return .= $link ;
2020-05-16 20:42:12 +02:00
$return .= ( 'list' === $args [ 'style' ] ) ? '</li>' : ', ' ;
2005-10-12 19:01:50 +02:00
}
2009-02-15 10:06:24 +01:00
2014-05-13 08:02:14 +02:00
$return = rtrim ( $return , ', ' );
2009-02-15 10:06:24 +01:00
2020-01-11 19:32:05 +01:00
if ( $args [ 'echo' ] ) {
echo $return ;
} else {
2007-06-01 07:43:24 +02:00
return $return ;
2014-05-13 08:02:14 +02:00
}
2004-03-19 17:20:49 +01:00
}
2011-05-12 09:14:44 +02:00
/**
2018-02-13 17:54:31 +01:00
* Determines whether this site has more than one author .
2011-06-11 01:01:45 +02:00
*
2011-05-12 09:14:44 +02:00
* Checks to see if more than one author has published posts .
2018-03-18 15:23:33 +01:00
*
2018-02-13 17:54:31 +01:00
* For more information on this and similar theme functions , check out
2018-03-18 15:23:33 +01:00
* the { @ link https :// developer . wordpress . org / themes / basics / conditional - tags /
2018-02-13 17:54:31 +01:00
* Conditional Tags } article in the Theme Developer Handbook .
2018-03-18 15:23:33 +01:00
*
2011-06-11 06:40:18 +02:00
* @ since 3.2 . 0
2015-05-22 06:14:24 +02:00
*
2015-10-15 01:44:25 +02:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-22 06:14:24 +02:00
*
2011-05-12 09:14:44 +02:00
* @ return bool Whether or not we have more than one author
*/
function is_multi_author () {
global $wpdb ;
2011-06-11 01:01:45 +02:00
2019-07-03 01:42:58 +02:00
$is_multi_author = get_transient ( 'is_multi_author' );
if ( false === $is_multi_author ) {
2017-12-01 00:11:00 +01:00
$rows = ( array ) $wpdb -> get_col ( " SELECT DISTINCT post_author FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 2 " );
2011-05-12 09:14:44 +02:00
$is_multi_author = 1 < count ( $rows ) ? 1 : 0 ;
2013-07-10 06:20:41 +02:00
set_transient ( 'is_multi_author' , $is_multi_author );
2011-05-12 09:14:44 +02:00
}
2013-09-13 21:25:10 +02:00
/**
2016-05-22 20:25:26 +02:00
* Filters whether the site has more than one author with published posts .
2013-09-13 21:25:10 +02:00
*
* @ since 3.2 . 0
*
* @ param bool $is_multi_author Whether $is_multi_author should evaluate as true .
*/
2011-09-07 15:53:53 +02:00
return apply_filters ( 'is_multi_author' , ( bool ) $is_multi_author );
2011-05-12 09:14:44 +02:00
}
2011-06-11 01:01:45 +02:00
/**
2011-05-12 09:14:44 +02:00
* Helper function to clear the cache for number of authors .
2011-06-11 01:01:45 +02:00
*
2016-12-27 10:21:44 +01:00
* @ since 3.2 . 0
2017-03-25 16:47:42 +01:00
* @ access private
2011-05-12 09:14:44 +02:00
*/
2020-01-29 01:45:18 +01:00
function __clear_multi_author_cache () { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore
2013-07-10 06:20:41 +02:00
delete_transient ( 'is_multi_author' );
2011-05-12 09:14:44 +02:00
}