WordPress.org

Make WordPress Core

Opened 3 months ago

Closed 3 months ago

Last modified 3 months ago

#51050 closed defect (bug) (fixed)

Docs: Add docblock for get_the_archive_title() filter

Reported by: justinahinon Owned by: SergeyBiryukov
Milestone: 5.5.1 Priority: normal
Severity: minor Version: 5.5
Component: Themes Keywords: has-patch 2nd-opinion
Focuses: docs Cc:

Description

In [48294] a span element was introduced to wrap around the get_the_archive_title() filter. Details for this changes is needed in the filter docblock.

Attachments (1)

51050.diff (471 bytes) - added by audrasjb 3 months ago.

Download all attachments as: .zip

Change History (8)

@audrasjb
3 months ago

#1 @johnbillion
3 months ago

  • Focuses docs added
  • Keywords has-patch added
  • Milestone changed from Awaiting Review to 5.5.1

#2 follow-up: @audrasjb
3 months ago

  • Focuses template removed
  • Keywords 2nd-opinion added
  • Milestone changed from 5.5.1 to Awaiting Review

Thanks for opening the ticket, @justinahinon,

By the way, this filter is actually properly documented: https://developer.wordpress.org/reference/hooks/get_the_archive_title/

"@since 5.5.0 Added the $prefix and $original_title parameters."

I guess you're rather talking about get_the_archive_title function.

In 51050.diff, I added an @since mention, but not completely sure it's necessary as the filter is already documented. I'd defer on @SergeyBiryukov ’s judgement for that :)

#3 @audrasjb
3 months ago

  • Milestone changed from Awaiting Review to 5.5.1

#4 @audrasjb
3 months ago

  • Type changed from enhancement to defect (bug)

#5 in reply to: ↑ 2 @justinahinon
3 months ago

Replying to audrasjb:

I guess you're rather talking about get_the_archive_title function.

Yes Jb. I was referring to the function https://developer.wordpress.org/reference/functions/get_the_archive_title.

Thanks for the patch.

#6 @SergeyBiryukov
3 months ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from new to closed

In 48814:

Docs: Add a @since note to get_the_archive_title() about the title part being wrapped in a <span> element.

Follow-up to [48294].

Props justinahinon, audrasjb.
Fixes #51050.

#7 @SergeyBiryukov
3 months ago

In 48815:

Docs: Add a @since note to get_the_archive_title() about the title part being wrapped in a <span> element.

Follow-up to [48294].

Props justinahinon, audrasjb.
Merges [48814] to the 5.5 branch.
Fixes #51050.

Note: See TracTickets for help on using tickets.