WordPress.org

Make WordPress Core

Opened 3 months ago

Closed 3 months ago

#48857 closed enhancement (fixed)

I found wrong variables in documentation of handle_bulk_actions-{$screen} filter.

Reported by: dilipbheda Owned by: SergeyBiryukov
Milestone: 5.4 Priority: normal
Severity: normal Version:
Component: Comments Keywords: has-patch 2nd-opinion
Focuses: docs Cc:

Description

I updated as per WordPress. guidelines/standard

I have added a patch for the same.

Attachments (1)

48857.patch (750 bytes) - added by dilipbheda 3 months ago.

Download all attachments as: .zip

Change History (4)

@dilipbheda
3 months ago

#1 @johnbillion
3 months ago

  • Keywords 2nd-opinion added
  • Version trunk deleted

Thanks for the patch @dilipbheda.

I believe this filter is a special case because this it's applied in several places in core with differing parameter names, hence the generic $items variable name rather than the more specific $comment_ids which only applies to the bulk management of comments.

That said, the inconsistency here isn't ideal. Some instances of the filter still use the non-interpolated version of the filter name.

#2 @SergeyBiryukov
3 months ago

  • Milestone changed from Awaiting Review to 5.4
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

#3 @SergeyBiryukov
3 months ago

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

In 46811:

Docs: Move the canonical DocBlock for handle_bulk_actions-{$screen} action to wp-admin/edit.php.

  • Document accepted values for the $items parameter.
  • Use interpolated syntax for the filter name.

Props dilipbheda, johnbillion, SergeyBiryukov.
Fixes #48857.

Note: See TracTickets for help on using tickets.