/**
* 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.
*
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);
}
/**
* 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.
function get_the_modified_author() {
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);
}
}
/**
* 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().
*/
$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 );
}
* @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 );
}
/**
* 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() {
/**
* 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.
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 );
}
$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;
}
* or as a string.</li>
* <li>html (bool) (true): Whether to list the items in html form or plaintext.
* </li>
+ * <li>exclude (array): Array of user IDs to explicitly exclude.</li>
+ * <li>include (array): Array of user IDs to explicitly include.</li>
* </ul>
*
* @link http://codex.wordpress.org/Template_Tags/wp_list_authors
'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 );
$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 );
$link .= '(';
}
- $link .= '<a href="' . get_author_feed_link( $author->ID ) . '"';
+ $link .= '<a href="' . get_author_feed_link( $author->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 .= '<img src="' . esc_url( $feed_image ) . '" style="border: none;"' . $alt . $title . ' />';
+ $link .= '<img src="' . esc_url( $feed_image ) . '" style="border: none;"' . $alt . ' />';
else
$link .= $name;
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 );
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff