WordPress.org

Make WordPress Core

Changeset 25249


Ignore:
Timestamp:
09/05/2013 04:04:17 PM (5 years ago)
Author:
nacin
Message:

Inline documentation for hooks in wp-comments-post.php.

props rzen.
see #25229.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-comments-post.php

    r25137 r25249  
    2222$post = get_post($comment_post_ID);
    2323
    24 if ( empty($post->comment_status) ) {
    25     do_action('comment_id_not_found', $comment_post_ID);
     24if ( empty( $post->comment_status ) ) {
     25    /**
     26     * Fires when a comment is attempted on a post that does not exist
     27     *
     28     * @since unknown
     29     * @param int $comment_post_ID Post ID
     30     */
     31    do_action( 'comment_id_not_found', $comment_post_ID );
    2632    exit;
    2733}
     
    3238$status_obj = get_post_status_object($status);
    3339
    34 if ( !comments_open($comment_post_ID) ) {
    35     do_action('comment_closed', $comment_post_ID);
     40if ( ! comments_open( $comment_post_ID ) ) {
     41    /**
     42     * Fires when a comment is attempted on a post that has comments closed
     43     *
     44     * @since unknown
     45     * @param int $comment_post_ID Post ID
     46     */
     47    do_action( 'comment_closed', $comment_post_ID );
    3648    wp_die( __('Sorry, comments are closed for this item.') );
    3749} elseif ( 'trash' == $status ) {
    38     do_action('comment_on_trash', $comment_post_ID);
     50    /**
     51     * Fires when a comment is attempted on a trashed post
     52     *
     53     * @since 2.9.0
     54     * @param int $comment_post_ID Post ID
     55     */
     56    do_action( 'comment_on_trash', $comment_post_ID );
    3957    exit;
    40 } elseif ( !$status_obj->public && !$status_obj->private ) {
    41     do_action('comment_on_draft', $comment_post_ID);
     58} elseif ( ! $status_obj->public && ! $status_obj->private ) {
     59    /**
     60     * Fires when a comment is attempted on a post in draft mode
     61     *
     62     * @since unknown
     63     * @param int $comment_post_ID Post ID
     64     */
     65    do_action( 'comment_on_draft', $comment_post_ID );
    4266    exit;
    43 } elseif ( post_password_required($comment_post_ID) ) {
    44     do_action('comment_on_password_protected', $comment_post_ID);
     67} elseif ( post_password_required( $comment_post_ID ) ) {
     68    /**
     69     * Fires when a comment is attempted on a password-protected post
     70     *
     71     * @since unknown
     72     * @param int $comment_post_ID Post ID
     73     */
     74    do_action( 'comment_on_password_protected', $comment_post_ID );
    4575    exit;
    4676} else {
    47     do_action('pre_comment_on_post', $comment_post_ID);
     77    /**
     78     * Fires before a comment is posted
     79     *
     80     * @since unknown
     81     * @param int $comment_post_ID Post ID
     82     */
     83    do_action( 'pre_comment_on_post', $comment_post_ID );
    4884}
    4985
     
    91127
    92128$comment_id = wp_new_comment( $commentdata );
     129$comment = get_comment($comment_id);
    93130
    94 $comment = get_comment($comment_id);
    95 do_action('set_comment_cookies', $comment, $user);
     131/**
     132 * Perform other actions when comment cookies are set
     133 *
     134 * @since 3.4.0
     135 *
     136 * @param object $comment Comment object
     137 * @param object $user    WP_User object
     138 */
     139do_action( 'set_comment_cookies', $comment, $user );
    96140
    97141$location = empty($_POST['redirect_to']) ? get_comment_link($comment_id) : $_POST['redirect_to'] . '#comment-' . $comment_id;
    98 $location = apply_filters('comment_post_redirect', $location, $comment);
     142
     143/**
     144 * The location URI to send commenter after posting
     145 *
     146 * @since unknown
     147 *
     148 * @param string $location The 'redirect_to' URI sent via $_POST
     149 * @param object $comment  Comment object
     150 */
     151$location = apply_filters( 'comment_post_redirect', $location, $comment );
    99152
    100153wp_safe_redirect( $location );
Note: See TracChangeset for help on using the changeset viewer.