WordPress.org
Get WordPress

Make WordPress Core

Opened 8 months ago

Closed 8 months ago

#63742 closed enhancement (fixed)

Docs: Improve type annotation for global $tax parameter in WP_Terms_List_Table constructor

Reported by: yashjawale's profile yashjawale Owned by: yashjawale's profile yashjawale
Milestone: 6.9 Priority: normal
Severity: trivial Version: 6.9
Component: Taxonomy Keywords: has-patch
Focuses: docs, administration, coding-standards Cc:

Description

The @global parameter documentation in the WP_Terms_List_Table constructor currently uses a generic object type for the $tax variable, but it should be more specific as WP_Taxonomy

Wherever the value of $tax is set in the codebase, it is set using get_taxonomy() function which returns WP_Taxonomy type

This is the only place where the global parameter comment annotation is present

Change History (3)

This ticket was mentioned in ​PR #9310 on ​WordPress/wordpress-develop by ​@yashjawale.
8 months ago #1

  • Keywords has-patch added

Trac ticket: https://core.trac.wordpress.org/ticket/63742

#2 @SergeyBiryukov
8 months ago

  • Component changed from Administration to Taxonomy
  • Focuses administration added
  • Milestone changed from Awaiting Review to 6.9

#3 @SergeyBiryukov
8 months ago

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

In 60498:

Docs: Correct the type for $tax global in WP_Terms_List_Table::__construct().

Follow-up to [32642].

Props yashjawale.
Fixes #63742.

Note: See TracTickets for help on using tickets.