<!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>[32567] trunk/src/wp-includes/comment-template.php: Add missing doc blocks to `comment-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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/32567">32567</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/32567","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-24 05:18:59 +0000 (Sun, 24 May 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Add missing doc blocks to `comment-template.php`.
See <a href="https://core.trac.wordpress.org/ticket/32444">#32444</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommenttemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/comment-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment-template.php 2015-05-24 05:04:39 UTC (rev 32566)
+++ trunk/src/wp-includes/comment-template.php 2015-05-24 05:18:59 UTC (rev 32567)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -63,8 +63,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $author The comment author's username.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $comment_ID The comment ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $author = apply_filters( 'comment_author', $author, $comment_ID );
- echo $author;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo apply_filters( 'comment_author', $author, $comment_ID );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -157,6 +156,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $before Optional. Text or HTML to display before the email link. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $after Optional. Text or HTML to display after the email link. Default empty.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $comment;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -225,8 +225,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 0.71
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see get_comment_author_link() Echoes result
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @param int $comment_ID ID of the comment for which to print the author's
</span><span class="cx" style="display: block; padding: 0 10px"> * link. Default current comment.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -390,6 +388,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $echo Optional. Whether to cho or return the output.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default true.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string|null
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Separates classes with a single space, collates classes for comment DIV
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -405,6 +404,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global int $comment_alt
+ * @global int $comment_depth
+ * @global int $comment_thread_alt
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $class Optional. One or more classes to add to the class list. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $comment_id Comment ID. Default current comment.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -595,6 +598,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global object $comment
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int The comment ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_comment_ID() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -628,6 +633,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_page_of_comment()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Rewrite $wp_rewrite
+ * @global bool $in_comment_loop
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $comment Comment to retrieve. Default current comment.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. An array of arguments to override the defaults.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The permalink to the given comment.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -857,6 +865,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global object $comment
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $d Optional. The format of the time. Default user's settings.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $gmt Optional. Whether to use the GMT date. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $translate Optional. Whether to translate the time (for use in feeds).
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1115,11 +1125,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * default theme. If either does not exist, then the WordPress process will be
</span><span class="cx" style="display: block; padding: 0 10px"> * halted. It is advised for that reason, that the default theme is not deleted.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @todo Document globals
</del><span class="cx" style="display: block; padding: 0 10px"> * @uses $withcomments Will not try to get the comments if the post has none.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Query $wp_query
+ * @global WP_Post $post
+ * @global wpdb $wpdb
+ * @global int $id
+ * @global object $comment
+ * @global string $user_login
+ * @global int $user_ID
+ * @global string $user_identity
+ * @global bool $overridden_cpage
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $file Optional. The file to load. Default '/comments.php'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $separate_comments Optional. Whether to separate the comments by comment type.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1370,7 +1389,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return null|false|string Link to show comment form, if successful. False, if comments are closed.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> $defaults = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'add_below' => 'comment',
</span><span class="cx" style="display: block; padding: 0 10px"> 'respond_id' => 'respond',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1550,6 +1568,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Optional. Text to display for cancel reply link. Default empty.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_cancel_comment_reply_link( $text = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty($text) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1628,6 +1647,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global object $comment
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $noreplytext Optional. Text to display when not replying to a comment.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $replytext Optional. Text to display when replying to a comment.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1687,6 +1708,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global int $comment_depth
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $output Passed by reference. Used to append additional content.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $depth Depth of comment.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Uses 'style' argument for type of HTML list.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1714,6 +1737,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global int $comment_depth
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $output Passed by reference. Used to append additional content.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $depth Depth of comment.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Will only append content if style argument value is 'ol' or 'ul'.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1795,6 +1820,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see Walker::start_el()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_list_comments()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global int $comment_depth
+ * @global object $comment
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $output Passed by reference. Used to append additional content.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $comment Comment data object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $depth Depth of comment in reference to parents.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1998,6 +2026,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Query->comments
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Query $wp_query
+ * @global int $comment_alt
+ * @global int $comment_depth
+ * @global int $comment_thread_alt
+ * @global bool $overridden_cpage
+ * @global bool $in_comment_loop
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Formatting options.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>