Make WordPress Core

Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#50569 closed defect (bug) (fixed)

$context parameter description for sanitize_title_with_dashes()

Reported by: stevenlinx Owned by: SergeyBiryukov
Priority: normal Milestone: 5.6
Component: Formatting Version:
Severity: normal Keywords: has-patch commit
Cc: Focuses: docs

Description

The description for $context should be migrated:
"The context for the sanitation. When set to 'save', additional entities are converted to hyphens or stripped entirely."

Codex:
https://codex.wordpress.org/Function_Reference/sanitize_title_with_dashes

DevHub:
https://developer.wordpress.org/reference/functions/sanitize_title_with_dashes/

Attachments (2)

50569.2.diff (743 bytes ) - added by stevenlinx 6 years ago.
50569.3.diff (720 bytes ) - added by audrasjb 6 years ago.
Replace "sanitation" with "sanitization" for consistency with core

Download all attachments as: .zip

Change History (8)

@stevenlinx
6 years ago

#1 @stevenlinx
6 years ago

  • Keywords has-patch added; needs-patch removed

#2 @SergeyBiryukov
6 years ago

  • Milestone Awaiting Review5.6
  • Owner set to SergeyBiryukov
  • Status newreviewing

@audrasjb
6 years ago

Replace "sanitation" with "sanitization" for consistency with core

#3 @audrasjb
6 years ago

The previous patch looks like a nice documentation enhancement, except I think we should replace "sanitation" with "sanitization" for better consistency. Fixed in 50569.3.diff.

#4 @hellofromTonya
6 years ago

  • Keywords commit added

Marking for commit.

#5 @helen
6 years ago

  • Resolutionfixed
  • Status reviewingclosed

In 49482:

Formatting: Update docs for $context in sanitize_title_with_dashes().

Props stevenlinx, audrasjb.
Fixes #50569.

#6 @SergeyBiryukov
6 years ago

In 49484:

Docs: Update description for the $context parameter of sanitize_title() and sanitize_title_with_dashes().

This brings some consistency between the two DocBlocks and adjusts the latter one per the documentation standards.

Follow-up to [49482].

See #50569.

Note: See TracTickets for help on using tickets.