Changeset 49955 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Timestamp:

01/10/2021 10:21:39 PM (4 years ago)

Author:

johnbillion

Message:

REST API: Corrections and improvements to docblocks for REST API filters.

See #51800

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (4 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -450 +450 @@
 
             /**
-             * Filters whether comments can be created without authentication.
+             * Filters whether comments can be created via the REST API without authentication.
              *
              * Enables creating comments for anonymous users.
@@ -956 +956 @@
 
         /**
-         * Filters whether a comment can be trashed.
-         *
-         * Return false to disable Trash support for the post.
+         * Filters whether a comment can be trashed via the REST API.
+         *
+         * Return false to disable trash support for the comment.
          *
          * @since 4.7.0
          *
-         * @param bool    $supports_trash Whether the post type support trashing.
-         * @param WP_Post $comment        The comment object being considered for trashing support.
+         * @param bool       $supports_trash Whether the comment supports trashing.
+         * @param WP_Comment $comment        The comment object being considered for trashing support.
          */
         $supports_trash = apply_filters( 'rest_comment_trashable', ( EMPTY_TRASH_DAYS > 0 ), $comment );
@@ -1352 +1352 @@
 
         /**
-         * Filters a comment after it is prepared for the database.
+         * Filters a comment added via the REST API after it is prepared for insertion into the database.
          *
          * Allows modification of the comment right after it is prepared for the database.
@@ -1675 +1675 @@
 
         /**
-         * Filters collection parameters for the comments controller.
+         * Filters REST API collection parameters for the comments controller.
          *
          * This filter registers the collection parameter, but does not map the