WordPress.org
Get WordPress

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#44398 closed defect (bug) (fixed)

`list_pages` filter docblock improvement

Reported by: desrosj's profile desrosj Owned by: ianbelanger's profile ianbelanger
Milestone: 5.1 Priority: normal
Severity: normal Version: 3.9
Component: General Keywords: good-first-bug has-patch commit
Focuses: docs Cc:

Description

The $page parameter of Walker_PageDropdown->start_el() is a WP_Post object. No modifications are performed in the function to the $page variable.

When $page is passed to the list_pages filter at the end of the function, it is noted as an object. This could be more specific and indicate $page is a WP_Post.

Related: #36300/r37056.

Attachments (1)

44398.diff​ (542 bytes) - added by ianbelanger 6 years ago.
Updated doc block to note that $page is a WP_Post Object

Download all attachments as: .zip

Change History (11)

@ianbelanger
6 years ago

Updated doc block to note that $page is a WP_Post Object

#1 @ianbelanger
6 years ago

  • Keywords has-patch added; needs-patch removed

#2 @netweb
6 years ago

  • Milestone changed from Awaiting Review to 5.0

#3 @desrosj
6 years ago

  • Keywords commit added
  • Owner set to ianbelanger
  • Status changed from new to assigned

Assigning to mark good-first-bug claimed.

Thanks, @ianbelanger. Patch looks good!

#4 @desrosj
6 years ago

  • Milestone changed from 5.0 to 5.0.1

Punting to 5.0.1.

#5 @pento
6 years ago

  • Milestone changed from 5.0.1 to 5.0.2

#6 @pento
6 years ago

  • Milestone changed from 5.0.2 to 5.0.3

#7 @desrosj
6 years ago

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

In 44355:

Docs: Correctly specify the $page parameter of list_pages filter as a WP_Post.

Props ianbelanger.
Fixes #44398.

#8 @desrosj
6 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Reopening for backport.

#9 @audrasjb
6 years ago

  • Milestone changed from 5.0.3 to 5.1

Hi,

Per today's bug scrub, we are going to address Docs enhancements in 5.1, coming next month.

#10 @pento
6 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed
Note: See TracTickets for help on using tickets.