Hook Docs (6): wp-includes/revision.php

[adamsilverstein]

Lets add some docs for the hooks in wp-includes/revision.php!

[DrewAPicture]

Thanks for the patch. I'll work up some notes and get back to you.

[DrewAPicture]

Here are some notes on 26979.diff​:

_wp_post_revision_fields filter:

• Don't need the hash notation here since it's really just an array of translatable strings. You can just say:

@param array $fields List of fields to revision. Contains 'post_title', 'post_content', and 'post_excerpt' by default.

• Should only be one space between the @since tag and version

wp_save_post_revision_check_for_changes filter:

• Need a docs-specific variable for the first parameter. Maybe $changes.
• s/id/ID in two places

With the above changes should be able to get this in shortly.

[adamsilverstein]

docs corrections, cleanup

[adamsilverstein]

Thanks for the review and feedback; I have (hopefully) addressed all these issues in 26979.2.diff​.

Replying to DrewAPicture:

Here are some notes on 26979.diff​:

_wp_post_revision_fields filter:

• Don't need the hash notation here since it's really just an array of translatable strings. You can just say:

@param array $fields List of fields to revision. Contains 'post_title', 'post_content', and 'post_excerpt' by default.

• Should only be one space between the @since tag and version

wp_save_post_revision_check_for_changes filter:

• Need a docs-specific variable for the first parameter. Maybe $changes.
• s/id/ID in two places

With the above changes should be able to get this in shortly.

[DrewAPicture]

Final pass.

[DrewAPicture]

26979.3.diff​ cleans up some of the wording on the filters in .2 and adds hook docs for all of the actions. Good to go.

[DrewAPicture]

In 27699:

Inline documentation for hooks in wp-includes/revision.php.

Props adamsilverstein, DrewAPicture.
Fixes #26979.