Wordpress 4.6
[autoinstalls/wordpress.git] / wp-admin / includes / comment.php
1 <?php
2 /**
3  * WordPress Comment Administration API.
4  *
5  * @package WordPress
6  * @subpackage Administration
7  * @since 2.3.0
8  */
9
10 /**
11  * Determine if a comment exists based on author and date.
12  *
13  * For best performance, use `$timezone = 'gmt'`, which queries a field that is properly indexed. The default value
14  * for `$timezone` is 'blog' for legacy reasons.
15  *
16  * @since 2.0.0
17  * @since 4.4.0 Added the `$timezone` parameter.
18  *
19  * @global wpdb $wpdb WordPress database abstraction object.
20  *
21  * @param string $comment_author Author of the comment.
22  * @param string $comment_date   Date of the comment.
23  * @param string $timezone       Timezone. Accepts 'blog' or 'gmt'. Default 'blog'.
24  *
25  * @return mixed Comment post ID on success.
26  */
27 function comment_exists( $comment_author, $comment_date, $timezone = 'blog' ) {
28         global $wpdb;
29
30         $date_field = 'comment_date';
31         if ( 'gmt' === $timezone ) {
32                 $date_field = 'comment_date_gmt';
33         }
34
35         return $wpdb->get_var( $wpdb->prepare("SELECT comment_post_ID FROM $wpdb->comments
36                         WHERE comment_author = %s AND $date_field = %s",
37                         stripslashes( $comment_author ),
38                         stripslashes( $comment_date )
39         ) );
40 }
41
42 /**
43  * Update a comment with values provided in $_POST.
44  *
45  * @since 2.0.0
46  */
47 function edit_comment() {
48         if ( ! current_user_can( 'edit_comment', (int) $_POST['comment_ID'] ) )
49                 wp_die ( __( 'Sorry, you are not allowed to edit comments on this post.' ) );
50
51         if ( isset( $_POST['newcomment_author'] ) )
52                 $_POST['comment_author'] = $_POST['newcomment_author'];
53         if ( isset( $_POST['newcomment_author_email'] ) )
54                 $_POST['comment_author_email'] = $_POST['newcomment_author_email'];
55         if ( isset( $_POST['newcomment_author_url'] ) )
56                 $_POST['comment_author_url'] = $_POST['newcomment_author_url'];
57         if ( isset( $_POST['comment_status'] ) )
58                 $_POST['comment_approved'] = $_POST['comment_status'];
59         if ( isset( $_POST['content'] ) )
60                 $_POST['comment_content'] = $_POST['content'];
61         if ( isset( $_POST['comment_ID'] ) )
62                 $_POST['comment_ID'] = (int) $_POST['comment_ID'];
63
64         foreach ( array ('aa', 'mm', 'jj', 'hh', 'mn') as $timeunit ) {
65                 if ( !empty( $_POST['hidden_' . $timeunit] ) && $_POST['hidden_' . $timeunit] != $_POST[$timeunit] ) {
66                         $_POST['edit_date'] = '1';
67                         break;
68                 }
69         }
70
71         if ( !empty ( $_POST['edit_date'] ) ) {
72                 $aa = $_POST['aa'];
73                 $mm = $_POST['mm'];
74                 $jj = $_POST['jj'];
75                 $hh = $_POST['hh'];
76                 $mn = $_POST['mn'];
77                 $ss = $_POST['ss'];
78                 $jj = ($jj > 31 ) ? 31 : $jj;
79                 $hh = ($hh > 23 ) ? $hh -24 : $hh;
80                 $mn = ($mn > 59 ) ? $mn -60 : $mn;
81                 $ss = ($ss > 59 ) ? $ss -60 : $ss;
82                 $_POST['comment_date'] = "$aa-$mm-$jj $hh:$mn:$ss";
83         }
84
85         wp_update_comment( $_POST );
86 }
87
88 /**
89  * Returns a WP_Comment object based on comment ID.
90  *
91  * @since 2.0.0
92  *
93  * @param int $id ID of comment to retrieve.
94  * @return WP_Comment|false Comment if found. False on failure.
95  */
96 function get_comment_to_edit( $id ) {
97         if ( !$comment = get_comment($id) )
98                 return false;
99
100         $comment->comment_ID = (int) $comment->comment_ID;
101         $comment->comment_post_ID = (int) $comment->comment_post_ID;
102
103         $comment->comment_content = format_to_edit( $comment->comment_content );
104         /**
105          * Filters the comment content before editing.
106          *
107          * @since 2.0.0
108          *
109          * @param string $comment->comment_content Comment content.
110          */
111         $comment->comment_content = apply_filters( 'comment_edit_pre', $comment->comment_content );
112
113         $comment->comment_author = format_to_edit( $comment->comment_author );
114         $comment->comment_author_email = format_to_edit( $comment->comment_author_email );
115         $comment->comment_author_url = format_to_edit( $comment->comment_author_url );
116         $comment->comment_author_url = esc_url($comment->comment_author_url);
117
118         return $comment;
119 }
120
121 /**
122  * Get the number of pending comments on a post or posts
123  *
124  * @since 2.3.0
125  *
126  * @global wpdb $wpdb WordPress database abstraction object.
127  *
128  * @param int|array $post_id Either a single Post ID or an array of Post IDs
129  * @return int|array Either a single Posts pending comments as an int or an array of ints keyed on the Post IDs
130  */
131 function get_pending_comments_num( $post_id ) {
132         global $wpdb;
133
134         $single = false;
135         if ( !is_array($post_id) ) {
136                 $post_id_array = (array) $post_id;
137                 $single = true;
138         } else {
139                 $post_id_array = $post_id;
140         }
141         $post_id_array = array_map('intval', $post_id_array);
142         $post_id_in = "'" . implode("', '", $post_id_array) . "'";
143
144         $pending = $wpdb->get_results( "SELECT comment_post_ID, COUNT(comment_ID) as num_comments FROM $wpdb->comments WHERE comment_post_ID IN ( $post_id_in ) AND comment_approved = '0' GROUP BY comment_post_ID", ARRAY_A );
145
146         if ( $single ) {
147                 if ( empty($pending) )
148                         return 0;
149                 else
150                         return absint($pending[0]['num_comments']);
151         }
152
153         $pending_keyed = array();
154
155         // Default to zero pending for all posts in request
156         foreach ( $post_id_array as $id )
157                 $pending_keyed[$id] = 0;
158
159         if ( !empty($pending) )
160                 foreach ( $pending as $pend )
161                         $pending_keyed[$pend['comment_post_ID']] = absint($pend['num_comments']);
162
163         return $pending_keyed;
164 }
165
166 /**
167  * Add avatars to relevant places in admin, or try to.
168  *
169  * @since 2.5.0
170  *
171  * @param string $name User name.
172  * @return string Avatar with Admin name.
173  */
174 function floated_admin_avatar( $name ) {
175         $avatar = get_avatar( get_comment(), 32, 'mystery' );
176         return "$avatar $name";
177 }
178
179 /**
180  * @since 2.7.0
181  */
182 function enqueue_comment_hotkeys_js() {
183         if ( 'true' == get_user_option( 'comment_shortcuts' ) )
184                 wp_enqueue_script( 'jquery-table-hotkeys' );
185 }
186
187 /**
188  * Display error message at bottom of comments.
189  *
190  * @param string $msg Error Message. Assumed to contain HTML and be sanitized.
191  */
192 function comment_footer_die( $msg ) {
193         echo "<div class='wrap'><p>$msg</p></div>";
194         include( ABSPATH . 'wp-admin/admin-footer.php' );
195         die;
196 }