[wp-trac] [WordPress Trac] #38721: Remove introduced uses of unescaped HTML from function/parameter/hook descriptions.

Tue Nov 8 23:19:38 UTC 2016

#38721: Remove introduced uses of unescaped HTML from function/parameter/hook
descriptions.
--------------------------+-----------------------------
 Reporter:  coffee2code   |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:  4.6.1
 Severity:  trivial       |   Keywords:  has-patch
  Focuses:  docs          |
--------------------------+-----------------------------
 #30473 culminated in [30546] for 4.1 to remove use of unescaped HTML tags
 (ideally referring to them by name, otherwise escaping them if they should
 be shown literally as an example) in function and parameter and hook
 descriptions. A few commits since then have introduced HTML tags that
 should be removed.

 * [25584] introduced documentation for the 'comment_form' action and
 introduced `</form>` in the hook description.
 * [31699] added `$title_reply_before` and `$title_reply_after` as accepts
 `$args` values to `comment_form()` with default values containing HTML
 that is not marked as code in backticks.
 * [34243] added `<ul>` and `</ul>` as defaults for `$before` and `$after`
 (respectively) to `$args` of `wp_page_menu()`.
 * [34308] added `$submit_button` and `$submit_field` as accepts `$args`
 values to `comment_form()` with default values containing HTML that is not
 marked as code in backticks.
 * [34903] added `<head>` to function summary for
 `wp_oembed_add_discovery_links()`.
 * [34903] also added `<head>` to the description for the new `embed_head`
 hook.
 * [36135] introduced the param documentation for the `$separator` option
 of `$args` for `wp_list_categories()` with an unescapted HTML default
 value of `<br />`.
 * [36993] added ‘</body>’ and ‘<head>’ to @param description for
 `$in_footer` arg for `wp_register_script()` and `wp_enqueue_script()`.
 * [37465] introduced the `$required` hash param to
 `wp_dropdown_categories()` with `<select>` in the description.
 * [38829] introduced the ‘wp_get_custom_css’ filter with `<head>` in its
 description.
 * `wp_list_bookmarks()` has long had multiple `$args` items that have
 unescaped HTML defined as default values.

 Unescaped HTML can cause (minor) display issues in many such cases for the
 code reference on developer.wordpress.org.

 Patch attached to remove use of these unescaped HTML tags.

 Related #37770.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/38721>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform