Make WordPress Core

Opened 20 months ago

Closed 20 months ago

Last modified 20 months ago

#56806 closed defect (bug) (fixed)

Docs: Incorrect parameter name in `deleted_{$meta_type}meta` action docblock.

Reported by: costdev's profile costdev Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 6.1 Priority: normal
Severity: normal Version: 4.4
Component: Options, Meta APIs Keywords: good-first-bug has-patch commit
Focuses: docs Cc:

Description (last modified by costdev)

A good first bug for new contributors to get comfortable with contributing to Core.

In src/wp-includes/meta.php, at around line 1081, the deleted_{$meta_type}meta action's docblock shows:

* @param int $meta_ids Deleted metadata entry ID.

However, the parameter is actually called $meta_id:

do_action( "deleted_{$meta_type}meta", $meta_id );

The parameter name should be changed from $meta_ids to $meta_id in the docblock.

Introduced in [35718].

Change History (7)

#1 @costdev
20 months ago

  • Description modified (diff)
  • Summary changed from Docs: Incorrect parameter name in `deleted_{$meta_type}meta` filter docblock. to Docs: Incorrect parameter name in `deleted_{$meta_type}meta` action docblock.

This ticket was mentioned in PR #3454 on WordPress/wordpress-develop by divyeshgodhani44.


20 months ago
#2

  • Keywords has-patch added; needs-patch removed

Correct Parameter name in docs.
Ticket Ref:- https://core.trac.wordpress.org/ticket/56806

#3 @costdev
20 months ago

  • Keywords commit added

The PR looks good to me. Adding for commit consideration.

@divyeshgodhani commented on PR #3454:


20 months ago
#4

Hi @costdev,
Thank you. I'll Update github username with wp.org.

#5 in reply to: ↑ description @SergeyBiryukov
20 months ago

  • Milestone changed from Future Release to 6.1

Thanks for the ticket!

Replying to costdev:

Introduced in [35718].

Just noting that [27698] appears to be the correct changeset here.

#6 @SergeyBiryukov
20 months ago

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

In 54510:

Docs: Correct parameter name for deleted_{$meta_type}meta action.

Follow-up to [27698].

Props divyeshgodhani, costdev.
Fixes #56806.

@SergeyBiryukov commented on PR #3454:


20 months ago
#7

Thanks for the PR! Merged in r54510.

Note: See TracTickets for help on using tickets.