Changeset 28042 for trunk/src/wp-includes/post.php

Timestamp:

04/08/2014 07:40:30 AM (11 years ago)

Author:

DrewAPicture

Message:

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 [28041].

See #25376.

File:

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

trunk/src/wp-includes/post.php

@@ -2012 +2012 @@
              * Filter the value of a specific post field to edit.
              *
-             * The dynamic portion of the hook name, $field, refers to the prefixed
-             * post field name. For example, 'post_title'.
+             * The dynamic portion of the hook name, $field, refers to the post field name.
              *
              * @since 2.3.0
@@ -2026 +2025 @@
              *
              * The dynamic portion of the hook name, $field_no_prefix, refers to
-             * the post field name with no prefix. For example, 'title' instead
-             * of 'post_title'.
+             * the post field name.
              *
              * @since 2.3.0
-             * @deprecated 2.3.0 Use "edit_post_$field" instead.
              *
              * @param mixed $value   Value of the post field.
@@ -2037 +2034 @@
             $value = apply_filters( "{$field_no_prefix}_edit_pre", $value, $post_id );
         } else {
-
-            /**
-             * 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.
-             */
             $value = apply_filters( "edit_post_{$field}", $value, $post_id );
         }
@@ -2064 +2049 @@
 
             /**
-             * Filter the value of a specific field before saving.
+             * Filter the value of a specific post field before saving.
              *
-             * The dynamic portion of the hook name, $field, refers to the
-             * prefixed post field name. For example, 'post_title'.
+             * The dynamic portion of the hook name, $field, refers to the post field name.
              *
              * @since 2.3.0
@@ -2079 +2063 @@
              *
              * The dynamic portion of the hook name, $field_no_prefix, refers
-             * to the un-prefixed post field name. For example, 'title' instead
-             * of 'post_title'.
+             * to the post field name.
              *
              * @since 2.3.0
-             * @deprecated 2.3.0 Use "pre_post_{$field}" instead.
              *
              * @param mixed $value Value of the post field.
@@ -2089 +2071 @@
             $value = apply_filters( "{$field_no_prefix}_save_pre", $value );
         } else {
+            $value = apply_filters( "pre_post_{$field}", $value );
 
             /**
-             * Filter the value of a specific field before saving.
+             * Filter the value of a specific post 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'.
+             * The dynamic portion of the hook name, $field, refers to the post field name.
              *
              * @since 2.3.0
@@ -2100 +2082 @@
              * @param mixed $value Value of the post field.
              */
-            $value = apply_filters( "pre_post_{$field}", $value );
-
-            /**
-             * 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
-             * @deprecated 2.3.0 Use "pre_post_{$field}" instead.
-             *
-             * @param mixed $value Value of the post field.
-             */
             $value = apply_filters( "{$field}_pre", $value );
         }
@@ -2123 +2092 @@
              * Filter the value of a specific post field for display.
              *
-             * The dynamic hook name, $field, refers to the prefixed post field
-             * name. For example, 'post_title'.
+             * The dynamic portion of the hook name, $field, refers to the post field name.
              *
-             * @since
+             * @since 2.3.0
              *
              * @param mixed  $value   Value of the prefixed post field.
@@ -2136 +2104 @@
             $value = apply_filters( $field, $value, $post_id, $context );
         } else {
-
-            /**
-             * 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'.
-             */
             $value = apply_filters( "post_{$field}", $value, $post_id, $context );
         }