<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[25429] trunk/src/wp-includes/author-template.php: Inline documentation for hooks in wp-includes/author-template.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25429">25429</a></dd>
<dt>Author</dt> <dd>SergeyBiryukov</dd>
<dt>Date</dt> <dd>2013-09-13 19:24:26 +0000 (Fri, 13 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-includes/author-template.php.
props Frank Klein.
see <a href="http://core.trac.wordpress.org/ticket/25229">#25229</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesauthortemplatephp">trunk/src/wp-includes/author-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesauthortemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/author-template.php (25428 => 25429)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/author-template.php 2013-09-13 19:19:45 UTC (rev 25428)
+++ trunk/src/wp-includes/author-template.php 2013-09-13 19:24:26 UTC (rev 25429)
</span><span class="lines">@@ -26,6 +26,13 @@
</span><span class="cx"> if ( !empty( $deprecated ) )
</span><span class="cx"> _deprecated_argument( __FUNCTION__, '2.1' );
</span><span class="cx">
</span><ins>+ /**
+ * Filter the display name of the current post's author.
+ *
+ * @since 2.9.0
+ *
+ * @param string $authordata->display_name The author's display name.
+ */
</ins><span class="cx"> return apply_filters('the_author', is_object($authordata) ? $authordata->display_name : null);
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -71,6 +78,14 @@
</span><span class="cx"> function get_the_modified_author() {
</span><span class="cx"> if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) {
</span><span class="cx"> $last_user = get_userdata($last_id);
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters('the_modified_author', $last_user->display_name);
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="lines">@@ -108,6 +123,16 @@
</span><span class="cx">
</span><span class="cx"> $value = isset( $authordata->$field ) ? $authordata->$field : '';
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'get_the_author_' . $field, $value, $user_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -119,8 +144,20 @@
</span><span class="cx"> * @param int $user_id Optional. User ID.
</span><span class="cx"> * @echo string The author's field from the current author's DB object.
</span><span class="cx"> */
</span><del>-function the_author_meta($field = '', $user_id = false) {
- echo apply_filters('the_author_' . $field, get_the_author_meta($field, $user_id), $user_id);
</del><ins>+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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -204,6 +241,14 @@
</span><span class="cx"> esc_attr( sprintf( __( 'Posts by %s' ), get_the_author() ) ),
</span><span class="cx"> get_the_author()
</span><span class="cx"> );
</span><ins>+
+ /**
+ * Filter the link to the author page of the author of the current post.
+ *
+ * @since 2.9.0
+ *
+ * @param string $link HTML link.
+ */
</ins><span class="cx"> echo apply_filters( 'the_author_posts_link', $link );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -232,7 +277,16 @@
</span><span class="cx"> $link = home_url( user_trailingslashit( $link ) );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $link = apply_filters('author_link', $link, $author_id, $author_nicename);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx">
</span><span class="cx"> return $link;
</span><span class="cx"> }
</span><span class="lines">@@ -378,6 +432,13 @@
</span><span class="cx"> set_transient( 'is_multi_author', $is_multi_author );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'is_multi_author', (bool) $is_multi_author );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>