Add missing doc blocks to `comment-template.php`.
See #32444. Built from https://develop.svn.wordpress.org/trunk@32567 git-svn-id: http://core.svn.wordpress.org/trunk@32537 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor
parent
451914addb
commit
876918dc53
|
|
@ -63,8 +63,7 @@ function comment_author( $comment_ID = 0 ) {
|
|||
* @param string $author The comment author's username.
|
||||
* @param int $comment_ID The comment ID.
|
||||
*/
|
||||
$author = apply_filters( 'comment_author', $author, $comment_ID );
|
||||
echo $author;
|
||||
echo apply_filters( 'comment_author', $author, $comment_ID );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -157,6 +156,7 @@ function comment_author_email_link( $linktext = '', $before = '', $after = '' )
|
|||
* Default empty.
|
||||
* @param string $before Optional. Text or HTML to display before the email link. Default empty.
|
||||
* @param string $after Optional. Text or HTML to display after the email link. Default empty.
|
||||
* @return string
|
||||
*/
|
||||
function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
|
||||
global $comment;
|
||||
|
|
@ -225,8 +225,6 @@ function get_comment_author_link( $comment_ID = 0 ) {
|
|||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @see get_comment_author_link() Echoes result
|
||||
*
|
||||
* @param int $comment_ID ID of the comment for which to print the author's
|
||||
* link. Default current comment.
|
||||
*/
|
||||
|
|
@ -390,6 +388,7 @@ function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
|
|||
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
|
||||
* @param bool $echo Optional. Whether to cho or return the output.
|
||||
* Default true.
|
||||
* @return string|null
|
||||
*/
|
||||
function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
|
||||
// Separates classes with a single space, collates classes for comment DIV
|
||||
|
|
@ -405,6 +404,10 @@ function comment_class( $class = '', $comment_id = null, $post_id = null, $echo
|
|||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @global int $comment_alt
|
||||
* @global int $comment_depth
|
||||
* @global int $comment_thread_alt
|
||||
*
|
||||
* @param string|array $class Optional. One or more classes to add to the class list. Default empty.
|
||||
* @param int $comment_id Comment ID. Default current comment.
|
||||
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
|
||||
|
|
@ -595,6 +598,8 @@ function comment_excerpt( $comment_ID = 0 ) {
|
|||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @global object $comment
|
||||
*
|
||||
* @return int The comment ID.
|
||||
*/
|
||||
function get_comment_ID() {
|
||||
|
|
@ -628,6 +633,9 @@ function comment_ID() {
|
|||
*
|
||||
* @see get_page_of_comment()
|
||||
*
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
* @global bool $in_comment_loop
|
||||
*
|
||||
* @param mixed $comment Comment to retrieve. Default current comment.
|
||||
* @param array $args Optional. An array of arguments to override the defaults.
|
||||
* @return string The permalink to the given comment.
|
||||
|
|
@ -857,6 +865,8 @@ function comment_text( $comment_ID = 0, $args = array() ) {
|
|||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @global object $comment
|
||||
*
|
||||
* @param string $d Optional. The format of the time. Default user's settings.
|
||||
* @param bool $gmt Optional. Whether to use the GMT date. Default false.
|
||||
* @param bool $translate Optional. Whether to translate the time (for use in feeds).
|
||||
|
|
@ -1115,11 +1125,20 @@ function wp_comment_form_unfiltered_html_nonce() {
|
|||
* default theme. If either does not exist, then the WordPress process will be
|
||||
* halted. It is advised for that reason, that the default theme is not deleted.
|
||||
*
|
||||
* @todo Document globals
|
||||
* @uses $withcomments Will not try to get the comments if the post has none.
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @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
|
||||
*
|
||||
* @param string $file Optional. The file to load. Default '/comments.php'.
|
||||
* @param bool $separate_comments Optional. Whether to separate the comments by comment type.
|
||||
* Default false.
|
||||
|
|
@ -1370,7 +1389,6 @@ function comments_popup_link( $zero = false, $one = false, $more = false, $css_c
|
|||
* @return null|false|string Link to show comment form, if successful. False, if comments are closed.
|
||||
*/
|
||||
function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {
|
||||
|
||||
$defaults = array(
|
||||
'add_below' => 'comment',
|
||||
'respond_id' => 'respond',
|
||||
|
|
@ -1550,6 +1568,7 @@ function post_reply_link($args = array(), $post = null) {
|
|||
* @since 2.7.0
|
||||
*
|
||||
* @param string $text Optional. Text to display for cancel reply link. Default empty.
|
||||
* @return string
|
||||
*/
|
||||
function get_cancel_comment_reply_link( $text = '' ) {
|
||||
if ( empty($text) )
|
||||
|
|
@ -1628,6 +1647,8 @@ function comment_id_fields( $id = 0 ) {
|
|||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @global object $comment
|
||||
*
|
||||
* @param string $noreplytext Optional. Text to display when not replying to a comment.
|
||||
* Default false.
|
||||
* @param string $replytext Optional. Text to display when replying to a comment.
|
||||
|
|
@ -1687,6 +1708,8 @@ class Walker_Comment extends Walker {
|
|||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @global int $comment_depth
|
||||
*
|
||||
* @param string $output Passed by reference. Used to append additional content.
|
||||
* @param int $depth Depth of comment.
|
||||
* @param array $args Uses 'style' argument for type of HTML list.
|
||||
|
|
@ -1714,6 +1737,8 @@ class Walker_Comment extends Walker {
|
|||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @global int $comment_depth
|
||||
*
|
||||
* @param string $output Passed by reference. Used to append additional content.
|
||||
* @param int $depth Depth of comment.
|
||||
* @param array $args Will only append content if style argument value is 'ol' or 'ul'.
|
||||
|
|
@ -1795,6 +1820,9 @@ class Walker_Comment extends Walker {
|
|||
* @see Walker::start_el()
|
||||
* @see wp_list_comments()
|
||||
*
|
||||
* @global int $comment_depth
|
||||
* @global object $comment
|
||||
*
|
||||
* @param string $output Passed by reference. Used to append additional content.
|
||||
* @param object $comment Comment data object.
|
||||
* @param int $depth Depth of comment in reference to parents.
|
||||
|
|
@ -1998,6 +2026,13 @@ class Walker_Comment extends Walker {
|
|||
*
|
||||
* @see WP_Query->comments
|
||||
*
|
||||
* @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
|
||||
*
|
||||
* @param string|array $args {
|
||||
* Optional. Formatting options.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '4.3-alpha-32566';
|
||||
$wp_version = '4.3-alpha-32567';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
|
|||
Loading…
Reference in New Issue