<!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>[28042] trunk/src/wp-includes/post.php: Clarify documentation for hooks 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 { 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/28042">28042</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-04-08 07:40:30 +0000 (Tue, 08 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Clarify documentation for hooks in `sanitize_post_field()`.
* `edit_post_{$field}` pairs with `edit_{$field}`
* `pre_post_{$field}` pairs with `pre_{$field}`
* `post_{$field}` pairs with `{$field}`
As the above pairs' docs are unnecessarily duplicative, the second sets of docs have been removed. Also, the "duplicates" are purposely not marked as such in this case as the hook names differ. Also remove `@deprecated` tags mistakenly left in in <a href="http://core.trac.wordpress.org/changeset/28041">[28041]</a>.
See <a href="http://core.trac.wordpress.org/ticket/25376">#25376</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>Modified: trunk/src/wp-includes/post.php (28041 => 28042)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/post.php 2014-04-08 06:48:32 UTC (rev 28041)
+++ trunk/src/wp-includes/post.php 2014-04-08 07:40:30 UTC (rev 28042)
</span><span class="lines">@@ -2011,8 +2011,7 @@
</span><span class="cx"> /**
</span><span class="cx"> * Filter the value of a specific post field to edit.
</span><span class="cx"> *
</span><del>- * The dynamic portion of the hook name, $field, refers to the prefixed
- * post field name. For example, 'post_title'.
</del><ins>+ * The dynamic portion of the hook name, $field, refers to the post field name.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.3.0
</span><span class="cx"> *
</span><span class="lines">@@ -2025,29 +2024,15 @@
</span><span class="cx"> * Filter the value of a specific post field to edit.
</span><span class="cx"> *
</span><span class="cx"> * The dynamic portion of the hook name, $field_no_prefix, refers to
</span><del>- * the post field name with no prefix. For example, 'title' instead
- * of 'post_title'.
</del><ins>+ * the post field name.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.3.0
</span><del>- * @deprecated 2.3.0 Use "edit_post_$field" instead.
</del><span class="cx"> *
</span><span class="cx"> * @param mixed $value Value of the post field.
</span><span class="cx"> * @param int $post_id Post ID.
</span><span class="cx"> */
</span><span class="cx"> $value = apply_filters( "{$field_no_prefix}_edit_pre", $value, $post_id );
</span><span class="cx"> } else {
</span><del>-
- /**
- * Filter the value of a specific post field to edit.
- *
- * The dynamic portion of the hook name, $field, refers to the un-prefixed
- * post field. For example, 'title' instead of 'post_title'.
- *
- * @since 2.3.0
- *
- * @param mixed $value Value of the un-prefixed post field.
- * @param int $post_id Post ID.
- */
</del><span class="cx"> $value = apply_filters( "edit_post_{$field}", $value, $post_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2063,10 +2048,9 @@
</span><span class="cx"> if ( $prefixed ) {
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filter the value of a specific field before saving.
</del><ins>+ * Filter the value of a specific post field before saving.
</ins><span class="cx"> *
</span><del>- * The dynamic portion of the hook name, $field, refers to the
- * prefixed post field name. For example, 'post_title'.
</del><ins>+ * The dynamic portion of the hook name, $field, refers to the post field name.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.3.0
</span><span class="cx"> *
</span><span class="lines">@@ -2078,37 +2062,22 @@
</span><span class="cx"> * Filter the value of a specific field before saving.
</span><span class="cx"> *
</span><span class="cx"> * The dynamic portion of the hook name, $field_no_prefix, refers
</span><del>- * to the un-prefixed post field name. For example, 'title' instead
- * of 'post_title'.
</del><ins>+ * to the post field name.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.3.0
</span><del>- * @deprecated 2.3.0 Use "pre_post_{$field}" instead.
</del><span class="cx"> *
</span><span class="cx"> * @param mixed $value Value of the post field.
</span><span class="cx"> */
</span><span class="cx"> $value = apply_filters( "{$field_no_prefix}_save_pre", $value );
</span><span class="cx"> } else {
</span><del>-
- /**
- * Filter the value of a specific field before saving.
- *
- * The dynamic portion of the hook name, $field, refers to the un-prefixed
- * post field name. For example, 'title' instead of 'post_title'.
- *
- * @since 2.3.0
- *
- * @param mixed $value Value of the post field.
- */
</del><span class="cx"> $value = apply_filters( "pre_post_{$field}", $value );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filter the value of a specific field before saving.
</del><ins>+ * Filter the value of a specific post field before saving.
</ins><span class="cx"> *
</span><del>- * The dynamic portion of the hook name, $field, refers to the un-prefixed
- * post field name. For example, 'title' instead of 'post_title'.
</del><ins>+ * The dynamic portion of the hook name, $field, refers to the post field name.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.3.0
</span><del>- * @deprecated 2.3.0 Use "pre_post_{$field}" instead.
</del><span class="cx"> *
</span><span class="cx"> * @param mixed $value Value of the post field.
</span><span class="cx"> */
</span><span class="lines">@@ -2122,10 +2091,9 @@
</span><span class="cx"> /**
</span><span class="cx"> * Filter the value of a specific post field for display.
</span><span class="cx"> *
</span><del>- * The dynamic hook name, $field, refers to the prefixed post field
- * name. For example, 'post_title'.
</del><ins>+ * The dynamic portion of the hook name, $field, refers to the post field name.
</ins><span class="cx"> *
</span><del>- * @since
</del><ins>+ * @since 2.3.0
</ins><span class="cx"> *
</span><span class="cx"> * @param mixed $value Value of the prefixed post field.
</span><span class="cx"> * @param int $post_id Post ID.
</span><span class="lines">@@ -2135,21 +2103,6 @@
</span><span class="cx"> */
</span><span class="cx"> $value = apply_filters( $field, $value, $post_id, $context );
</span><span class="cx"> } else {
</span><del>-
- /**
- * Filter the value of a specific post field for display.
- *
- * The dynamic portion of the hook name, $field, refers to the un-prefixed
- * post field name. For example, 'title' instead of 'post_title'.'
- *
- * @since
- *
- * @param mixed $value Value of the un-prefixed post field.
- * @param int $post_id Post ID.
- * @param string $context Context for how to sanitize the field. Possible
- * values include 'raw', 'edit', 'db', 'display',
- * 'attribute' and 'js'.
- */
</del><span class="cx"> $value = apply_filters( "post_{$field}", $value, $post_id, $context );
</span><span class="cx"> }
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>