Fixes for inline documentation for hooks in wp-comments-post.php.

Adds missing `@since` versions, spacing, and language tweaks.

See #26869, #25229, [25249].

Built from https://develop.svn.wordpress.org/trunk@27144


git-svn-id: http://core.svn.wordpress.org/trunk@27011 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-02-09 20:12:12 +00:00
parent 025ea220c5
commit 3f6ef530ce
1 changed files with 13 additions and 7 deletions

View File

@ -25,7 +25,8 @@ if ( empty( $post->comment_status ) ) {
/** /**
* Fires when a comment is attempted on a post that does not exist. * Fires when a comment is attempted on a post that does not exist.
* *
* @since unknown * @since 1.5.0
*
* @param int $comment_post_ID Post ID. * @param int $comment_post_ID Post ID.
*/ */
do_action( 'comment_id_not_found', $comment_post_ID ); do_action( 'comment_id_not_found', $comment_post_ID );
@ -41,7 +42,8 @@ if ( ! comments_open( $comment_post_ID ) ) {
/** /**
* Fires when a comment is attempted on a post that has comments closed. * Fires when a comment is attempted on a post that has comments closed.
* *
* @since unknown * @since 1.5.0
*
* @param int $comment_post_ID Post ID. * @param int $comment_post_ID Post ID.
*/ */
do_action( 'comment_closed', $comment_post_ID ); do_action( 'comment_closed', $comment_post_ID );
@ -51,6 +53,7 @@ if ( ! comments_open( $comment_post_ID ) ) {
* Fires when a comment is attempted on a trashed post. * Fires when a comment is attempted on a trashed post.
* *
* @since 2.9.0 * @since 2.9.0
*
* @param int $comment_post_ID Post ID. * @param int $comment_post_ID Post ID.
*/ */
do_action( 'comment_on_trash', $comment_post_ID ); do_action( 'comment_on_trash', $comment_post_ID );
@ -59,7 +62,8 @@ if ( ! comments_open( $comment_post_ID ) ) {
/** /**
* Fires when a comment is attempted on a post in draft mode. * Fires when a comment is attempted on a post in draft mode.
* *
* @since unknown * @since 1.5.2
*
* @param int $comment_post_ID Post ID. * @param int $comment_post_ID Post ID.
*/ */
do_action( 'comment_on_draft', $comment_post_ID ); do_action( 'comment_on_draft', $comment_post_ID );
@ -68,7 +72,8 @@ if ( ! comments_open( $comment_post_ID ) ) {
/** /**
* Fires when a comment is attempted on a password-protected post. * Fires when a comment is attempted on a password-protected post.
* *
* @since unknown * @since 2.9.0
*
* @param int $comment_post_ID Post ID. * @param int $comment_post_ID Post ID.
*/ */
do_action( 'comment_on_password_protected', $comment_post_ID ); do_action( 'comment_on_password_protected', $comment_post_ID );
@ -77,7 +82,8 @@ if ( ! comments_open( $comment_post_ID ) ) {
/** /**
* Fires before a comment is posted. * Fires before a comment is posted.
* *
* @since unknown * @since 2.8.0
*
* @param int $comment_post_ID Post ID. * @param int $comment_post_ID Post ID.
*/ */
do_action( 'pre_comment_on_post', $comment_post_ID ); do_action( 'pre_comment_on_post', $comment_post_ID );
@ -141,9 +147,9 @@ do_action( 'set_comment_cookies', $comment, $user );
$location = empty($_POST['redirect_to']) ? get_comment_link($comment_id) : $_POST['redirect_to'] . '#comment-' . $comment_id; $location = empty($_POST['redirect_to']) ? get_comment_link($comment_id) : $_POST['redirect_to'] . '#comment-' . $comment_id;
/** /**
* The location URI to send commenter after posting. * Filter the location URI to send the commenter after posting.
* *
* @since unknown * @since 2.0.5
* *
* @param string $location The 'redirect_to' URI sent via $_POST. * @param string $location The 'redirect_to' URI sent via $_POST.
* @param object $comment Comment object. * @param object $comment Comment object.