Commit c9c2f41ab4 for wordpress.org
commit c9c2f41ab4c2ce7ced49b09764e00da32951288b
Author: Drew Jaynes <info@drewapicture.com>
Date: Wed Sep 18 00:02:13 2024 +0000
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
Built from https://develop.svn.wordpress.org/trunk@59045
git-svn-id: http://core.svn.wordpress.org/trunk@58441 1a063a9b-81f0-0310-95a4-ce76da25c4cd
diff --git a/wp-includes/post.php b/wp-includes/post.php
index 725433939e..8812957bf2 100644
--- a/wp-includes/post.php
+++ b/wp-includes/post.php
@@ -2896,7 +2896,23 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
* Filters the value of a specific post field to edit.
*
* 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
*
@@ -2908,8 +2924,26 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
/**
* 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
*
@@ -2918,6 +2952,24 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
*/
$value = apply_filters( "{$field_no_prefix}_edit_pre", $value, $post_id );
} else {
+ /**
+ * Filters the value of a specific post field to edit.
+ *
+ * Only applied to post fields not prefixed with `post_`.
+ *
+ * The dynamic portion of the hook name, `$field`, refers to the
+ * post field name. Possible filter names include:
+ *
+ * - `edit_post_ID`
+ * - `edit_post_ping_status`
+ * - `edit_post_pinged`
+ * - `edit_post_to_ping`
+ * - `edit_post_comment_count`
+ * - `edit_post_comment_status`
+ * - `edit_post_guid`
+ * - `edit_post_menu_order`
+ * @since
+ */
$value = apply_filters( "edit_post_{$field}", $value, $post_id );
}
@@ -2936,8 +2988,26 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
/**
* Filters the value of a specific post field before saving.
*
+ * Only applied to post fields with a name which is prefixed with `post_`.
+ *
* 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
*
@@ -2948,8 +3018,26 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
/**
* 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
*
@@ -2957,13 +3045,45 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
*/
$value = apply_filters( "{$field_no_prefix}_save_pre", $value );
} else {
+ /**
+ * Filters the value of a specific field before saving.
+ *
+ * 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:
+ *
+ * - `pre_post_ID`
+ * - `pre_post_comment_status`
+ * - `pre_post_ping_status`
+ * - `pre_post_to_ping`
+ * - `pre_post_pinged`
+ * - `pre_post_guid`
+ * - `pre_post_menu_order`
+ * - `pre_post_comment_count`
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the post field.
+ */
$value = apply_filters( "pre_post_{$field}", $value );
/**
* Filters the value of a specific post field before saving.
*
+ * Only applied to post fields with a name which is *not* prefixed with `post_`.
+ *
* 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
*
@@ -2979,8 +3099,26 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
/**
* Filters the value of a specific post field for display.
*
+ * Only applied to post fields with a name which is prefixed with `post_`.
+ *
* 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
*
@@ -2992,6 +3130,31 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
*/
$value = apply_filters( "{$field}", $value, $post_id, $context );
} else {
+ /**
+ * Filters the value of a specific post field for display.
+ *
+ * Only applied to post fields name which is *not* prefixed with `post_`.
+ *
+ * The dynamic portion of the hook name, `$field`, refers to the post
+ * field name. Possible filter names include:
+ *
+ * - `post_ID`
+ * - `post_comment_status`
+ * - `post_ping_status`
+ * - `post_to_ping`
+ * - `post_pinged`
+ * - `post_guid`
+ * - `post_menu_order`
+ * - `post_comment_count`
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the unprefixed post field.
+ * @param int $post_id Post ID
+ * @param string $context Context for how to sanitize the field.
+ * Accepts 'raw', 'edit', 'db', 'display',
+ * 'attribute', or 'js'. Default 'display'.
+ */
$value = apply_filters( "post_{$field}", $value, $post_id, $context );
}
@@ -3006,7 +3169,6 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
if ( in_array( $field, $int_fields, true ) ) {
$value = (int) $value;
}
-
return $value;
}
diff --git a/wp-includes/version.php b/wp-includes/version.php
index 156116d50c..e3a566efcf 100644
--- a/wp-includes/version.php
+++ b/wp-includes/version.php
@@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
-$wp_version = '6.7-alpha-59044';
+$wp_version = '6.7-alpha-59045';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.