WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#32421 closed defect (bug) (fixed)

The default list of protocols should be documented in wp_allowed_protocols()

Reported by: DrewAPicture Owned by: GunGeekATX
Milestone: 4.3 Priority: normal
Severity: normal Version:
Component: General Keywords: good-first-bug has-patch
Focuses: docs Cc:

Description

As suggested by @emiluzelac in #meta1029, we should include the full list of protocols in the documentation for esc_url().

I think the best approach would be to simply document the default list in the DocBlock for wp_allowed_protocols() and cross-reference to the DocBlocks for esc_url() and the kses_allowed_protocols filter.

Attachments (1)

ticket-32421.patch (1.2 KB) - added by GunGeekATX 5 years ago.
Updated DocBlocks of wp_allowed_protocols() and esc_url()

Download all attachments as: .zip

Change History (6)

#1 @emiluzelac
5 years ago

Thank you :)

@GunGeekATX
5 years ago

Updated DocBlocks of wp_allowed_protocols() and esc_url()

#2 @McGuive7
5 years ago

  • Keywords has-patch added; needs-patch removed

#3 @obenland
5 years ago

  • Owner set to GunGeekATX
  • Status changed from new to assigned

#4 @wonderboymusic
5 years ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 32797:

Document the default list of allowed protocols in the doc block for wp_allowed_protocols() and cross-reference in esc_url() and the kses_allowed_protocols filter.

Props GunGeekATX.
Fixes #32421.

#5 @DrewAPicture
5 years ago

In 32810:

Add line-wrapping to a long return description because readability in documentation is important.

See [32797]. See #32421.

Note: See TracTickets for help on using tickets.