Hook Docs (82): wp-includes/post.php

[DrewAPicture]

Attached patch documents the following hooks (all):

Actions:

• registered_post_type
• before_delete_post
• delete_post
• deleted_post
• after_delete_post
• wp_trash_post
• trashed_post
• untrash_post
• untrashed_post
• trash_post_comments
• trashed_post_comments
• untrash_post_comments
• untrashed_post_comments
• pre_post_update
• edit_post
• post_updated
• save_post_$post_type
• save_post
• wp_insert_post
• edit_post
• save_post_$post_type (duplicate)
• save_post (duplicate)
• wp_insert_post (duplicate)
• transition_post_status
• $old_status_to_$new_status
• $new_status_to_$post_type
• edit_attachment
• add_attachment
• delete_attachment
• delete_post
• deleted_post
• clean_post_cache
• clean_page_cache
• clean_attachment_cache
• private_to_published
• xmlrpc_publish_post

Filters:

• get_attached_file
• update_attached_file
• _wp_relative_upload_path
• post_type_labels_$post_type
• 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
• wp_count_posts (existing)
• wp_count_attachments (existing)
• post_mime_types
• wp_insert_post_empty_content
• wp_insert_post_parent
• wp_insert_post_data
• wp_unique_post_slug_is_bad_attachment_slug
• wp_unique_post_slug_is_bad_hierarchical_slug
• wp_unique_post_slug_is_bad_flat_slug
• wp_unique_post_slug
• add_ping
• get_enclosed
• get_pung
• get_to_ping
• get_pages
• get_pages (duplicate)
• get_pages (duplicate)
• wp_delete_file
• wp_delete_file (duplicate)
• wp_delete_file (duplicate)
• wp_delete_file (duplicate)
• wp_get_attachment_metadata
• wp_update_attachment_metadata
• wp_get_attachment_url
• wp_get_attachment_thumb_file
• wp_get_attachment_thumb_url
• icon_dir
• icon_dir_uri
• icon_dirs
• wp_mime_type_icon
• get_lastpostdate
• get_lastpostmodified

[DrewAPicture]

First pass (all hooks)

[DrewAPicture]

25376.diff​ documents all actions and filters in the file.

TODO:

• @since versions for all of the above
• Clarify 'enclosure'-related hook docs

[DrewAPicture]

w/ @since + 'enclosure' clarifications

[DrewAPicture]

typo

[DrewAPicture]

This needs some work yet following feedback from nacin and adamsilverstein. Backing off the milestone for the time being.

[kpdesign]

#25505 was marked as a duplicate.

[DrewAPicture]

Second pass: Part I.

[DrewAPicture]

In 28041:

Part I of inline documenation for hooks in wp-includes/post.php.

Adds docs for the following hooks:

• get_attached_file
• update_attached_file
• _wp_relative_upload_path
• post_type_labels_{$post_type}
• 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}
• wp_count_posts
• wp_count_attachments
• post_mime_types
• wp_insert_post_empty_content

See #25376.

[DrewAPicture]

In 28042:

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.

[DrewAPicture]

Second pass: Part II.

[DrewAPicture]

25376.5.diff​ should cover the rest of wpinc/post.php.

[DrewAPicture]

Third pass: Part II.

[DrewAPicture]

25376.6.diff​ incorporates feedback from nacin ​in IRC

untrash_post_comments and untrashed_post_comments filters:

• Comments are being restored for *a post*

wp_unique_post_slug_is_bad_attachment_slug, wp_unique_post_slug_is_bad_hierarchical_slug, and wp_unique_post_slug_is_bad_flat_slug filters:

• Standardizes on "bad" terminology instead of "poor"

[DrewAPicture]

In 28106:

Part II of inline documentation for hooks in wp-includes/post.php.

Documents all remaining hooks following [28041] and [28042]. Also updates the hash notation style for wp_insert_post().

Props nacin for several hook descriptions.

Fixes #25376.