<!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>[54958] trunk/src/wp-includes/comment-template.php: Docs: Mark some optional parameters as such in `wp-includes/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 { white-space: pre-line; 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/54958">54958</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/54958","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-12-12 11:49:40 +0000 (Mon, 12 Dec 2022)</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'>Docs: Mark some optional parameters as such in `wp-includes/comment-template.php`.
This affects:
* `get_comment_class()`
* `comment_class()`
* `get_comment_excerpt()`
* `comment_excerpt()`
* `get_comment_link()`
* `get_comment_text()`
* `comment_text()`
* `comments_open()`
* `pings_open()`
* `get_comment_reply_link()`
* `comment_reply_link()`
* `post_reply_link()`
* `comment_form()`
Follow-up to <a href="https://core.trac.wordpress.org/changeset/25567">[25567]</a>, <a href="https://core.trac.wordpress.org/changeset/27156">[27156]</a>, <a href="https://core.trac.wordpress.org/changeset/33961">[33961]</a>.
See <a href="https://core.trac.wordpress.org/ticket/56792">#56792</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 2022-12-12 11:15:12 UTC (rev 54957)
+++ trunk/src/wp-includes/comment-template.php 2022-12-12 11:49:40 UTC (rev 54958)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -425,8 +425,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|string[] $css_class Optional. One or more classes to add to the class list.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Comment $comment Comment ID or WP_Comment object. Default current comment.
- * @param int|WP_Post $post Post ID or WP_Post object. Default current post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default current comment.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param bool $display Optional. Whether to print or return the output.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default true.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void|string Void if `$display` argument is true, comment classes if `$display` is false.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -452,9 +452,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global int $comment_depth
</span><span class="cx" style="display: block; padding: 0 10px"> * @global int $comment_thread_alt
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|string[] $css_class Optional. One or more classes to add to the class list. Default empty.
- * @param int|WP_Comment $comment_id Comment ID or WP_Comment object. Default current comment.
- * @param int|WP_Post $post Post ID or WP_Post object. Default current post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|string[] $css_class Optional. One or more classes to add to the class list.
+ * Default empty.
+ * @param int|WP_Comment $comment_id Optional. Comment ID or WP_Comment object. Default current comment.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string[] An array of classes.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_comment_class( $css_class = '', $comment_id = null, $post = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -591,8 +592,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the excerpt.
- * Default current comment.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the excerpt.
+ * Default current comment.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The possibly truncated comment excerpt.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_comment_excerpt( $comment_ID = 0 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -637,8 +638,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the excerpt.
- * Default current comment.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to print the excerpt.
+ * Default current comment.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function comment_excerpt( $comment_ID = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $comment = get_comment( $comment_ID );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -699,7 +700,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
</span><span class="cx" style="display: block; padding: 0 10px"> * @global bool $in_comment_loop
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Comment|int|null $comment Comment to retrieve. Default current comment.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Comment|int|null $comment Optional. Comment to retrieve. Default current comment.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * An array of optional arguments to override the defaults.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -958,7 +959,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see Walker_Comment::comment()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the text.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the text.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default current comment.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. An array of arguments. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The comment content.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1004,7 +1005,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see Walker_Comment::comment()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the text.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to print the text.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default current comment.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. An array of arguments. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1231,7 +1232,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post Post ID or WP_Post object. Default current post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the comments are open.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function comments_open( $post = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1260,7 +1261,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post Post ID or WP_Post object. Default current post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if pings are accepted
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function pings_open( $post = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1661,8 +1662,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $before The text or HTML to add before the reply link. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $after The text or HTML to add after the reply link. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Comment $comment Comment being replied to. Default current comment.
- * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Comment $comment Optional. Comment being replied to. Default current comment.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default current post.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string|false|null 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="lines" style="display: block; padding: 0 10px; color: #888">@@ -1782,8 +1783,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_comment_reply_link()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Override default options. Default empty array.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Comment $comment Comment being replied to. Default current comment.
- * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Comment $comment Optional. Comment being replied to. Default current comment.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default current post.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function comment_reply_link( $args = array(), $comment = null, $post = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1873,7 +1874,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_post_reply_link()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Override default options. Default empty array.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default current post.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function post_reply_link( $args = array(), $post = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2319,7 +2320,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * submit button markup and %2$s is the comment hidden fields.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post Post ID or WP_Post object to generate the form for. Default current post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post Optional. Post ID or WP_Post object to generate the form for. Default current post.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function comment_form( $args = array(), $post = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post = get_post( $post );
</span></span></pre>
</div>
</div>
</body>
</html>