<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59045] trunk/src/wp-includes/post.php: Docs: Add possible filter names to the hook docs for the following filters in `sanitize_post_field()`:</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59045">59045</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59045","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-09-18 00:00:08 +0000 (Wed, 18 Sep 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/50654">#50654</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2024-09-17 23:56:10 UTC (rev 59044)
+++ trunk/src/wp-includes/post.php 2024-09-18 00:00:08 UTC (rev 59045)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2896,8 +2896,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the value of a specific post field to edit.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$field`, refers to the post
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * field name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * field name. Possible filter names include:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - `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`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Value of the post field.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2908,9 +2924,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the value of a specific post field to edit.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook name, `$field_no_prefix`, refers to
- * the post field name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Only applied to post fields with a name which is prefixed with `post_`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Value of the post field.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2918,6 +2952,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $value = apply_filters( "{$field_no_prefix}_edit_pre", $value, $post_id );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $value = apply_filters( "edit_post_{$field}", $value, $post_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2936,9 +2988,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the value of a specific post field before saving.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Only applied to post fields with a name which is prefixed with `post_`.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$field`, refers to the post
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * field name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * field name. Possible filter names include:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - `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`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Value of the post field.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2948,9 +3018,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the value of a specific field before saving.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook name, `$field_no_prefix`, refers
- * to the post field name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Only applied to post fields with a name which is prefixed with `post_`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Value of the post field.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2957,14 +3045,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $value = apply_filters( "{$field_no_prefix}_save_pre", $value );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $value = apply_filters( "pre_post_{$field}", $value );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the value of a specific post field before saving.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Only applied to post fields with a name which is *not* prefixed with `post_`.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$field`, refers to the post
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * field name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * field name. Possible filter names include:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - `ID_pre`
+ * - `comment_status_pre`
+ * - `ping_status_pre`
+ * - `to_ping_pre`
+ * - `pinged_pre`
+ * - `guid_pre`
+ * - `menu_order_pre`
+ * - `comment_count_pre`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Value of the post field.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2979,9 +3099,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the value of a specific post field for display.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Only applied to post fields with a name which is prefixed with `post_`.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$field`, refers to the post
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * field name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * field name. Possible filter names include:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - `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`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Value of the prefixed post field.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2992,6 +3130,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $value = apply_filters( "{$field}", $value, $post_id, $context );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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'.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $value = apply_filters( "post_{$field}", $value, $post_id, $context );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3006,7 +3169,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( $field, $int_fields, true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = (int) $value;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> return $value;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>