Changeset 28083 for trunk/src/wp-includes/comment-template.php

Timestamp:

04/12/2014 12:00:32 AM (13 years ago)

Author:

DrewAPicture

Message:

Priority fixes for various existing hook documentation.

Props kpdesign.
See #26869

File:

• trunk/src/wp-includes/comment-template.php (modified) (5 diffs)

trunk/src/wp-includes/comment-template.php

@@ -519 +519 @@
         }
         $excerpt .= ($use_dotdotdot) ? '…' : '';
-        return apply_filters('get_comment_excerpt', $excerpt);
+
+        /**
+         * Filter the retrieved comment excerpt.
+         *
+         * @since 1.5.0
+         *
+         * @param string $excerpt The comment excerpt text.
+         */
+        return apply_filters( 'get_comment_excerpt', $excerpt );
 }
 
@@ -642 +650 @@
          * Filter the returned post comments permalink.
          *
-         * @since
+         * @since 3.6.0
          *
          * @param string      $comments_link Post comments permalink with '#comments' appended.
@@ -977 +985 @@
          * Filter whether the current post is open for comments.
          *
-         * @since
+         * @since 2.5.0
          *
          * @param bool        $open    Whether the current post is open for comments.
@@ -998 +1006 @@
 
         $open = ( 'open' == $_post->ping_status );
+
+        /**
+         * Filter whether the current post is open for pings.
+         *
+         * @since 2.5.0
+         *
+         * @param bool        $open    Whether the current post is open for pings.
+         * @param int|WP_Post $post_id The post ID or WP_Post object.
+         */
         return apply_filters( 'pings_open', $open, $post_id );
 }
@@ -2056 +2073 @@
                 'fields'               => $fields,
                 'comment_field'        => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label> <textarea id="comment" name="comment" cols="45" rows="8" aria-required="true"></textarea></p>',
+                /** This filter is documented in wp-includes/link-template.php */
                 'must_log_in'          => '<p class="must-log-in">' . sprintf( __( 'You must be <a href="%s">logged in</a> to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
+                /** This filter is documented in wp-includes/link-template.php */
                 'logged_in_as'         => '<p class="logged-in-as">' . sprintf( __( 'Logged in as <a href="%1$s">%2$s</a>. <a href="%3$s" title="Log out of this account">Log out?</a>' ), get_edit_user_link(), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
                 'comment_notes_before' => '<p class="comment-notes">' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '</p>',