#33912 closed defect (bug) (fixed)
Document the various optional parameter permutations of add_query_arg()
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 4.4 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
As we did in #32694 for current_user_can()
, we should also attempt to document the various optional parameter permutations possible with add_query_arg()
.
add_query_arg()
, however, is a tougher nut to crack because unlike current_user_can()
and some others, it has no default signature, just an interesting mix of possible uses.
I would also like to look at improving the naming of the parameters for the existing documentation. $param1
, $param2
, and $param3
is pretty terrible.
Attachments (2)
Change History (9)
#3
@
8 years ago
- Keywords has-patch added; needs-patch removed
I briefly discussed variadic function documentation with @DrewAPicture, but it turns out that it's not at all helpful when describing a function such as this, which isn't so much variadic as it's just got multiple call signatures.
33912.patch is an attempt at improving the parameter names and descriptions, and adding example uses. Feedback appreciated.
In 34264: