X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/96bc8e88cf39086a9e0a883b8e2c311fe82a5e97..refs/tags/wordpress-3.9.1-scripts:/wp-includes/author-template.php diff --git a/wp-includes/author-template.php b/wp-includes/author-template.php index 4b21e446..dd225c0b 100644 --- a/wp-includes/author-template.php +++ b/wp-includes/author-template.php @@ -13,7 +13,8 @@ /** * Retrieve the author of the current post. * - * @since 1.5 + * @since 1.5.0 + * * @uses $authordata The current author's DB object. * @uses apply_filters() Calls 'the_author' hook on the author display name. * @@ -26,6 +27,13 @@ function get_the_author($deprecated = '') { if ( !empty( $deprecated ) ) _deprecated_argument( __FUNCTION__, '2.1' ); + /** + * Filter the display name of the current post's author. + * + * @since 2.9.0 + * + * @param string $authordata->display_name The author's display name. + */ return apply_filters('the_author', is_object($authordata) ? $authordata->display_name : null); } @@ -61,7 +69,8 @@ function the_author( $deprecated = '', $deprecated_echo = true ) { /** * Retrieve the author who last edited the current post. * - * @since 2.8 + * @since 2.8.0 + * * @uses $post The current post's DB object. * @uses get_post_meta() Retrieves the ID of the author who last edited the current post. * @uses get_userdata() Retrieves the author's DB object. @@ -69,9 +78,16 @@ function the_author( $deprecated = '', $deprecated_echo = true ) { * @return string The author's display name. */ function get_the_modified_author() { - global $post; - if ( $last_id = get_post_meta($post->ID, '_edit_last', true) ) { + if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) { $last_user = get_userdata($last_id); + + /** + * Filter the display name of the author who last edited the current post. + * + * @since 2.8.0 + * + * @param string $last_user->display_name The author's display name. + */ return apply_filters('the_modified_author', $last_user->display_name); } } @@ -79,7 +95,8 @@ function get_the_modified_author() { /** * Display the name of the author who last edited the current post. * - * @since 2.8 + * @since 2.8.0 + * * @see get_the_author() * @return string The author's display name, from get_the_modified_author(). */ @@ -96,25 +113,30 @@ function the_modified_author() { * @param int $user_id Optional. User ID. * @return string The author's field from the current author's DB object. */ -function get_the_author_meta($field = '', $user_id = false) { - if ( ! $user_id ) +function get_the_author_meta( $field = '', $user_id = false ) { + if ( ! $user_id ) { global $authordata; - else + $user_id = isset( $authordata->ID ) ? $authordata->ID : 0; + } else { $authordata = get_userdata( $user_id ); + } - // Keys used as object vars cannot have dashes. - $field = str_replace('-', '', $field); - $field = strtolower($field); - $user_field = "user_$field"; - - if ( 'id' == $field ) - $value = isset($authordata->ID) ? (int)$authordata->ID : 0; - elseif ( isset($authordata->$user_field) ) - $value = $authordata->$user_field; - else - $value = isset($authordata->$field) ? $authordata->$field : ''; - - return apply_filters('get_the_author_' . $field, $value, $user_id); + if ( in_array( $field, array( 'login', 'pass', 'nicename', 'email', 'url', 'registered', 'activation_key', 'status' ) ) ) + $field = 'user_' . $field; + + $value = isset( $authordata->$field ) ? $authordata->$field : ''; + + /** + * Filter the value of the requested user metadata. + * + * The filter name is dynamic and depends on the $field parameter of the function. + * + * @since 2.8.0 + * + * @param string $value The value of the metadata. + * @param int $user_id The user ID. + */ + return apply_filters( 'get_the_author_' . $field, $value, $user_id ); } /** @@ -125,8 +147,20 @@ function get_the_author_meta($field = '', $user_id = false) { * @param int $user_id Optional. User ID. * @echo string The author's field from the current author's DB object. */ -function the_author_meta($field = '', $user_id = false) { - echo apply_filters('the_author_' . $field, get_the_author_meta($field, $user_id), $user_id); +function the_author_meta( $field = '', $user_id = false ) { + $author_meta = get_the_author_meta( $field, $user_id ); + + /** + * The value of the requested user metadata. + * + * The filter name is dynamic and depends on the $field parameter of the function. + * + * @since 2.8.0 + * + * @param string $author_meta The value of the metadata. + * @param int $user_id The user ID. + */ + echo apply_filters( 'the_author_' . $field, $author_meta, $user_id ); } /** @@ -140,7 +174,7 @@ function the_author_meta($field = '', $user_id = false) { */ function get_the_author_link() { if ( get_the_author_meta('url') ) { - return '' . get_the_author() . ''; + return '' . get_the_author() . ''; } else { return get_the_author(); } @@ -153,7 +187,9 @@ function get_the_author_link() { * author's name. * * @link http://codex.wordpress.org/Template_Tags/the_author_link - * @since 2.1 + * + * @since 2.1.0 + * * @uses get_the_author_link() */ function the_author_link() { @@ -163,14 +199,14 @@ function the_author_link() { /** * Retrieve the number of posts by the author of the current post. * - * @since 1.5 + * @since 1.5.0 + * * @uses $post The current post in the Loop's DB object. * @uses count_user_posts() * @return int The number of posts by the author. */ function get_the_author_posts() { - global $post; - return count_user_posts($post->post_author); + return count_user_posts( get_post()->post_author ); } /** @@ -207,10 +243,18 @@ function the_author_posts_link($deprecated = '') { return false; $link = sprintf( '', - get_author_posts_url( $authordata->ID, $authordata->user_nicename ), + esc_url( get_author_posts_url( $authordata->ID, $authordata->user_nicename ) ), esc_attr( sprintf( __( 'Posts by %s' ), get_the_author() ) ), get_the_author() ); + + /** + * Filter the link to the author page of the author of the current post. + * + * @since 2.9.0 + * + * @param string $link HTML link. + */ echo apply_filters( 'the_author_posts_link', $link ); } @@ -239,7 +283,16 @@ function get_author_posts_url($author_id, $author_nicename = '') { $link = home_url( user_trailingslashit( $link ) ); } - $link = apply_filters('author_link', $link, $author_id, $author_nicename); + /** + * Filter the URL to the author's page. + * + * @since 2.1.0 + * + * @param string $link The URL to the author's page. + * @param int $author_id The author's id. + * @param string $author_nicename The author's nice name. + */ + $link = apply_filters( 'author_link', $link, $author_id, $author_nicename ); return $link; } @@ -251,7 +304,7 @@ function get_author_posts_url($author_id, $author_nicename = '') { *
  • optioncount (boolean) (false): Show the count in parenthesis next to the * author's name.
    • *
  • exclude_admin (boolean) (true): Exclude the 'admin' user that is - * installed bydefault.
    • + * installed by default. *
  • show_fullname (boolean) (false): Show their full names.
    • *
  • hide_empty (boolean) (true): Don't show authors without any posts.
    • *
  • feed (string) (''): If isn't empty, show links to author's feeds.
    • @@ -263,6 +316,8 @@ function get_author_posts_url($author_id, $author_nicename = '') { * or as a string. *
  • html (bool) (true): Whether to list the items in html form or plaintext. *
    • + *
  • exclude (array): Array of user IDs to explicitly exclude.
    • + *
  • include (array): Array of user IDs to explicitly include.
    • * * * @link http://codex.wordpress.org/Template_Tags/wp_list_authors @@ -278,7 +333,7 @@ function wp_list_authors($args = '') { 'optioncount' => false, 'exclude_admin' => true, 'show_fullname' => false, 'hide_empty' => true, 'feed' => '', 'feed_image' => '', 'feed_type' => '', 'echo' => true, - 'style' => 'list', 'html' => true + 'style' => 'list', 'html' => true, 'exclude' => '', 'include' => '' ); $args = wp_parse_args( $args, $defaults ); @@ -286,7 +341,7 @@ function wp_list_authors($args = '') { $return = ''; - $query_args = wp_array_slice_assoc( $args, array( 'orderby', 'order', 'number' ) ); + $query_args = wp_array_slice_assoc( $args, array( 'orderby', 'order', 'number', 'exclude', 'include' ) ); $query_args['fields'] = 'ids'; $authors = get_users( $query_args ); @@ -330,20 +385,18 @@ function wp_list_authors($args = '') { $link .= '('; } - $link .= 'ID, $feed_type ) . '"'; - $alt = $title = ''; + $alt = ''; if ( !empty( $feed ) ) { - $title = ' title="' . esc_attr( $feed ) . '"'; $alt = ' alt="' . esc_attr( $feed ) . '"'; $name = $feed; - $link .= $title; } $link .= '>'; if ( !empty( $feed_image ) ) - $link .= ''; + $link .= ''; else $link .= $name; @@ -379,12 +432,19 @@ function wp_list_authors($args = '') { function is_multi_author() { global $wpdb; - if ( false === ( $is_multi_author = wp_cache_get('is_multi_author', 'posts') ) ) { + if ( false === ( $is_multi_author = get_transient( 'is_multi_author' ) ) ) { $rows = (array) $wpdb->get_col("SELECT DISTINCT post_author FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 2"); $is_multi_author = 1 < count( $rows ) ? 1 : 0; - wp_cache_set('is_multi_author', $is_multi_author, 'posts'); + set_transient( 'is_multi_author', $is_multi_author ); } + /** + * Filter whether the site has more than one author with published posts. + * + * @since 3.2.0 + * + * @param bool $is_multi_author Whether $is_multi_author should evaluate as true. + */ return apply_filters( 'is_multi_author', (bool) $is_multi_author ); } @@ -394,8 +454,6 @@ function is_multi_author() { * @private */ function __clear_multi_author_cache() { - wp_cache_delete('is_multi_author', 'posts'); + delete_transient( 'is_multi_author' ); } add_action('transition_post_status', '__clear_multi_author_cache'); - -?>