WordPress.org

Make WordPress Core

Opened 3 months ago

Closed 3 months ago

#39527 closed defect (bug) (fixed)

Remove @param tags in DocBlocks for actions without parameters

Reported by: keesiemeijer Owned by: SergeyBiryukov
Milestone: 4.8 Priority: normal
Severity: normal Version:
Component: Administration Keywords: has-patch
Focuses: docs Cc:

Description

In wp-admin/admin-footer.php the following actions without parameters have a @param tag in their DocBlock

  • admin_print_footer_scripts-{$hook_suffix}
  • admin_footer-{$hook_suffix}

Attachments (1)

39527.patch (704 bytes) - added by keesiemeijer 3 months ago.
Remove @params

Download all attachments as: .zip

Change History (4)

@keesiemeijer
3 months ago

Remove @params

#1 @keesiemeijer
3 months ago

  • Keywords has-patch added

In 39527.patch I've removed the @global tags as well as they are not really suited to describe a function parameter.

They are is documented in the description of the actions:

The dynamic portion of the hook name, $hook_suffix, refers to the global hook suffix of the current page.

#2 @SergeyBiryukov
3 months ago

  • Component changed from General to Administration
  • Milestone changed from Awaiting Review to 4.8

#3 @SergeyBiryukov
3 months ago

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

In 39755:

Docs: Remove incorrect @param tags for admin_print_footer_scripts-{$hook_suffix} and admin_footer-{$hook_suffix} dynamic actiona.

Remove @global tags as well as they are not suited to describe a function parameter and are documented in the description of the actions.

Props keesiemeijer.
Fixes #39527.

Note: See TracTickets for help on using tickets.