Changeset 50505 for trunk/src/wp-admin/includes/revision.php

Timestamp:

03/07/2021 12:30:38 PM (5 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-admin/includes/revision.php (modified) (1 diff)

trunk/src/wp-admin/includes/revision.php

@@ -69 +69 @@
          * Contextually filter a post revision field.
          *
-         * The dynamic portion of the hook name, `$field`, corresponds to each of the post
-         * fields of the revision object being iterated over in a foreach statement.
+         * The dynamic portion of the hook name, `$field`, corresponds to a name of a
+         * field of the revision object.
+         *
+         * Possible hook names include:
+         *
+         *  - `_wp_post_revision_field_post_title`
+         *  - `_wp_post_revision_field_post_content`
+         *  - `_wp_post_revision_field_post_excerpt`
          *
          * @since 3.6.0