[wp-trac] [WordPress Trac] #26894: Hook Docs (6): wp-admin/includes/export.php

[WordPress Trac]

#26894: Hook Docs (6): wp-admin/includes/export.php
--------------------------+------------------------------
 Reporter:  cmmarslender  |       Owner:  DrewAPicture
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |
--------------------------+------------------------------
Changes (by DrewAPicture):

 * keywords:  has-patch => needs-patch


Comment:

 Thanks for the patch. Here are some notes on [attachment: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.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/26894#comment:6>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform