Changeset 59045

Timestamp:

09/18/2024 12:00:08 AM (3 days ago)

Author:

DrewAPicture

Message:

Docs: Add possible filter names to the hook docs for the following filters in sanitize_post_field():

• edit_{$field}
• {$field_no_prefix}_edit_pre
• edit_post_{$field}
• pre_{$field}
• {$field_no_prefix}_save_pre
• pre_post_{$field}
• {$field}_pre
• {$field}
• post_{$field}

Props johnbillion, DrewAPicture.
Fixes #50654

File:

• trunk/src/wp-includes/post.php (modified) (10 diffs)

trunk/src/wp-includes/post.php

@@ -2897 +2897 @@
              *
              * The dynamic portion of the hook name, `$field`, refers to the post
-             * field name.
+             * field name. Possible filter names include:
+             *
+             *  - `edit_post_author`
+             *  - `edit_post_date`
+             *  - `edit_post_date_gmt`
+             *  - `edit_post_content`
+             *  - `edit_post_title`
+             *  - `edit_post_excerpt`
+             *  - `edit_post_status`
+             *  - `edit_post_password`
+             *  - `edit_post_name`
+             *  - `edit_post_modified`
+             *  - `edit_post_modified_gmt`
+             *  - `edit_post_content_filtered`
+             *  - `edit_post_parent`
+             *  - `edit_post_type`
+             *  - `edit_post_mime_type`
              *
              * @since 2.3.0
@@ -2909 +2925 @@
              * Filters the value of a specific post field to edit.
              *
-             * The dynamic portion of the hook name, `$field_no_prefix`, refers to
-             * the post field name.
+             * Only applied to post fields with a name which is prefixed with `post_`.
+             *
+             * The dynamic portion of the hook name, `$field_no_prefix`, refers to the
+             * post field name minus the `post_` prefix. Possible filter names include:
+             *
+             *  - `author_edit_pre`
+             *  - `date_edit_pre`
+             *  - `date_gmt_edit_pre`
+             *  - `content_edit_pre`
+             *  - `title_edit_pre`
+             *  - `excerpt_edit_pre`
+             *  - `status_edit_pre`
+             *  - `password_edit_pre`
+             *  - `name_edit_pre`
+             *  - `modified_edit_pre`
+             *  - `modified_gmt_edit_pre`
+             *  - `content_filtered_edit_pre`
+             *  - `parent_edit_pre`
+             *  - `type_edit_pre`
+             *  - `mime_type_edit_pre`
              *
              * @since 2.3.0
@@ -2919 +2953 @@
             $value = apply_filters( "{$field_no_prefix}_edit_pre", $value, $post_id );
         } else {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
             $value = apply_filters( "edit_post_{$field}", $value, $post_id );
         }
@@ -2937 +2989 @@
              * Filters the value of a specific post field before saving.
              *
+
+
              * The dynamic portion of the hook name, `$field`, refers to the post
-             * field name.
+             * field name. Possible filter names include:
+             *
+             *  - `pre_post_author`
+             *  - `pre_post_date`
+             *  - `pre_post_date_gmt`
+             *  - `pre_post_content`
+             *  - `pre_post_title`
+             *  - `pre_post_excerpt`
+             *  - `pre_post_status`
+             *  - `pre_post_password`
+             *  - `pre_post_name`
+             *  - `pre_post_modified`
+             *  - `pre_post_modified_gmt`
+             *  - `pre_post_content_filtered`
+             *  - `pre_post_parent`
+             *  - `pre_post_type`
+             *  - `pre_post_mime_type`
              *
              * @since 2.3.0
@@ -2949 +3019 @@
              * Filters the value of a specific field before saving.
              *
-             * The dynamic portion of the hook name, `$field_no_prefix`, refers
-             * to the post field name.
+             * Only applied to post fields with a name which is prefixed with `post_`.
+             *
+             * The dynamic portion of the hook name, `$field_no_prefix`, refers to the
+             * post field name minus the `post_` prefix. Possible filter names include:
+             *
+             *  - `author_save_pre`
+             *  - `date_save_pre`
+             *  - `date_gmt_save_pre`
+             *  - `content_save_pre`
+             *  - `title_save_pre`
+             *  - `excerpt_save_pre`
+             *  - `status_save_pre`
+             *  - `password_save_pre`
+             *  - `name_save_pre`
+             *  - `modified_save_pre`
+             *  - `modified_gmt_save_pre`
+             *  - `content_filtered_save_pre`
+             *  - `parent_save_pre`
+             *  - `type_save_pre`
+             *  - `mime_type_save_pre`
              *
              * @since 2.3.0
@@ -2958 +3046 @@
             $value = apply_filters( "{$field_no_prefix}_save_pre", $value );
         } else {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
             $value = apply_filters( "pre_post_{$field}", $value );
 
@@ -2963 +3072 @@
              * Filters the value of a specific post field before saving.
              *
+
+
              * The dynamic portion of the hook name, `$field`, refers to the post
-             * field name.
+             * field name. Possible filter names include:
+             *
+             *  - `ID_pre`
+             *  - `comment_status_pre`
+             *  - `ping_status_pre`
+             *  - `to_ping_pre`
+             *  - `pinged_pre`
+             *  - `guid_pre`
+             *  - `menu_order_pre`
+             *  - `comment_count_pre`
              *
              * @since 2.3.0
@@ -2980 +3100 @@
              * Filters the value of a specific post field for display.
              *
+
+
              * The dynamic portion of the hook name, `$field`, refers to the post
-             * field name.
+             * field name. Possible filter names include:
+             *
+             *  - `post_author`
+             *  - `post_date`
+             *  - `post_date_gmt`
+             *  - `post_content`
+             *  - `post_title`
+             *  - `post_excerpt`
+             *  - `post_status`
+             *  - `post_password`
+             *  - `post_name`
+             *  - `post_modified`
+             *  - `post_modified_gmt`
+             *  - `post_content_filtered`
+             *  - `post_parent`
+             *  - `post_type`
+             *  - `post_mime_type`
              *
              * @since 2.3.0
@@ -2993 +3131 @@
             $value = apply_filters( "{$field}", $value, $post_id, $context );
         } else {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
             $value = apply_filters( "post_{$field}", $value, $post_id, $context );
         }
@@ -3007 +3170 @@
         $value = (int) $value;
     }
-
     return $value;
 }