sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Update @return tag for wp_allow_comment() with trash as a possible return value.

Browse Source 
Props oakesjosh, jeremyfelt.
Fixes #49206.

git-svn-id: https://develop.svn.wordpress.org/trunk@47286 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-02-13 17:48:50 +00:00
parent 3dd39ffece
commit a41b2d93d3
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/wp-includes/comment.php
View File

@ -651,7 +651,7 @@ function sanitize_comment_cookies() {
* @param bool $avoid_die When true, a disallowed comment will result in the function * @param bool $avoid_die When true, a disallowed comment will result in the function
* returning a WP_Error object, rather than executing wp_die(). * returning a WP_Error object, rather than executing wp_die().
* Default false. * Default false.
* @return int|string|WP_Error Allowed comments return the approval status (0|1|'spam'). * @return int|string|WP_Error Allowed comments return the approval status (0|1|'spam'|'trash').
* If `$avoid_die` is true, disallowed comments return a WP_Error. * If `$avoid_die` is true, disallowed comments return a WP_Error.
*/ */
function wp_allow_comment( $commentdata, $avoid_die = false ) { function wp_allow_comment( $commentdata, $avoid_die = false ) {
@ -817,14 +817,14 @@ function wp_allow_comment( $commentdata, $avoid_die = false ) {
* Filters a comment's approval status before it is set. * Filters a comment's approval status before it is set.
* *
* @since 2.1.0 * @since 2.1.0
* @since 4.9.0 Returning a WP_Error value from the filter will shortcircuit comment insertion and * @since 4.9.0 Returning a WP_Error value from the filter will shortcircuit comment insertion
* allow skipping further processing. * and allow skipping further processing.
* *
* @param int|string|WP_Error $approved The approval status. Accepts 1, 0, 'spam' or WP_Error. * @param int|string|WP_Error $approved The approval status. Accepts 1, 0, 'spam', 'trash',
* or WP_Error.
* @param array $commentdata Comment data. * @param array $commentdata Comment data.
*/ */
$approved = apply_filters( 'pre_comment_approved', $approved, $commentdata ); return apply_filters( 'pre_comment_approved', $approved, $commentdata );
return $approved;
} }
/** /**