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

[cmmarslender]

Inline Docs

[DrewAPicture]

Chris: Welcome to Trac, and thanks for the patch. I'll review it and get back to you with any notes.

[DrewAPicture]

Thanks for the patch. Here are some notes on export.diff​:

Overall:

• All short descriptions and parameter descriptions need periods at the end.

export_wp hook:

• I'd probably explicitly mention 'WXR export' in the description instead of just 'export'
• The $args parameter description isn't really accurate since you don't "filter" anything -- and it doesn't help that the parameter description for the function is wrong. Just be more direct with the description, as it's passed to the action. Maybe something like: "An array of export arguments."

the_content_export,
the_excerpt_export filters:

• Rather than denote filtering the value "during" an export, perhaps we should go with "used for exports" or something

wxr_export_skip_postmeta filter:

• Again "used for exports" instead of "during"
• The $skip parameter should specify the default.
• All parameter descriptions should end with periods.

[cmmarslender]

Thanks for the feedback. I've uploaded a new version of the patch!

[DrewAPicture]

3rd pass

[DrewAPicture]

Looks pretty good. I made a few adjustments to export.2.diff in 26894.diff​ -- including that the $meta parameter in the wxr_export_skip_postmeta filter is an object not a string.

Thanks for the effort. This needs a secondary review and recommendation.

[kpdesign]

Fourth pass

[kpdesign]

26894.1.diff​ contains a few minor changes for consistency.

This one's ready to go in. Recommend commit.

[DrewAPicture]

In 27048:

Inline documentation for hooks in wp-admin/includes/export.php.

Props cmmarslender, kpdesign.
Fixes #26894.