#25362 closed enhancement (fixed)
Improve documentation in wp-admin/admin-post.php
Reported by: | ericlewis | Owned by: | DrewAPicture |
---|---|---|---|
Milestone: | 3.7 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Inline Docs | Keywords: | |
Focuses: | Cc: |
Description
The description here is a bit vague, and the language is also specific to POST requests, where this is a general request handling file.
Also, I had never realized that WP has a built-in form handler file for this purpose, and actually thought this was a relic of bygone AJAX request handling from looking at it. We should probably add some documentation in the Codex for this somewhere.
Attachments (2)
Change History (10)
#3
follow-up:
↓ 4
@
11 years ago
- Keywords needs-patch added; has-patch removed
- Milestone changed from Awaiting Review to 3.7
Notes on 25362.diff:
- No period in the file header short description
- Use camel-casing in the file header, so "WordPress Generic Request (POST/GET) Handler"
#4
in reply to:
↑ 3
@
11 years ago
Replying to DrewAPicture:
- No period in the file header short description
Following-up to the IRC discussion, it actually looks like core is split pretty evenly in this regard - 276 of 544 PHP file headers have a period at the end of their short description.
Should we bring these inline to the new standard?
#5
@
11 years ago
attachment:25362.1.diff adds CamelCasing to the file-level header and removes the trailing period
#6
@
11 years ago
- Owner set to DrewAPicture
- Resolution set to fixed
- Status changed from new to closed
In 25561:
#7
@
11 years ago
- Keywords needs-codex removed
See new related Codex page: http://codex.wordpress.org/Plugin_API/Action_Reference/admin_post_%28action%29
attachment:25362.diff gives more detail in the file-level docblock.