Changeset 50505 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Timestamp:

03/07/2021 12:30:38 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Add examples of possible names for various hooks whose name contains a dynamic portion.

This provides greater discoverability of such hooks in search results on the Code Reference site as well as increased clarity when reading the source.

See #50734, #52628

File:

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

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

@@ -291 +291 @@
          * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
          *
-         * Possible filter names include:
+         * Possible hook names include:
          *
          *  - `rest_post_query`
@@ -611 +611 @@
          * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
          *
+         * Possible hook names include:
+         *
+         *  - `rest_insert_post`
+         *  - `rest_insert_page`
+         *  - `rest_insert_attachment`
+         *
          * @since 4.7.0
          *
@@ -669 +675 @@
          * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
          *
+         * Possible hook names include:
+         *
+         *  - `rest_after_insert_post`
+         *  - `rest_after_insert_page`
+         *  - `rest_after_insert_attachment`
+         *
          * @since 5.0.0
          *
@@ -890 +902 @@
          *
          * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
+         *
+         * Possible hook names include:
+         *
+         *  - `rest_post_trashable`
+         *  - `rest_page_trashable`
+         *  - `rest_attachment_trashable`
          *
          * Pass false to disable Trash support for the post.
@@ -1251 +1269 @@
          *
          * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
+         *
+         * Possible hook names include:
+         *
+         *  - `rest_pre_insert_post`
+         *  - `rest_pre_insert_page`
+         *  - `rest_pre_insert_attachment`
          *
          * @since 4.7.0
@@ -1855 +1879 @@
          * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
          *
-         * Possible filter names include:
+         * Possible hook names include:
          *
          *  - `rest_prepare_post`