WordPress.org

Make WordPress Core

Opened 4 months ago

Closed 4 months ago

#43158 closed defect (bug) (fixed)

Incorrect classes referenced in @see tags for a few functions

Reported by: coffee2code Owned by: SergeyBiryukov
Milestone: 5.0 Priority: low
Severity: trivial Version:
Component: General Keywords: has-patch
Focuses: docs Cc:

Description

There are a number of functions that have DocBlock @see tags referencing functions in classes that don't exist. Most likely these classes had been renamed/finalized since the tags were first written. Now that the Code Reference exposes these associations, they should be fixed so they can link to the proper related resource.

The ones I've found so far:

  • In WP_Customize_Nav_Menus::filter_wp_nav_menu_args():
    • WP_Customize_Nav_Menus_Partial_Refresh should be WP_Customize_Nav_Menus
  • In WP_Customize_Widgets::filter_dynamic_sidebar_params():
    • WP_Customize_Widgets_Partial_Refresh should be WP_Customize_Widgets
  • In WP_Widget_Text::form():
    • WP_Widget_Visual_Text should be WP_Widget_Text

Additionally, the wp_editor_settings filter and a @param description for _WP_Editors::editor() incorrectly reference a class function by unnecessarily adding parentheses after the class name.

  • _WP_Editors()::parse_settings() should be _WP_Editors::parse_settings()

Patch attached.

Attachments (1)

43158.diff (2.8 KB) - added by coffee2code 4 months ago.
Patch mentioned in ticket.

Download all attachments as: .zip

Change History (3)

@coffee2code
4 months ago

Patch mentioned in ticket.

#1 @SergeyBiryukov
4 months ago

  • Milestone changed from Awaiting Review to 5.0

#2 @SergeyBiryukov
4 months ago

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

In 42630:

Docs: Correct erroneous class references in @see tags.

Props coffee2code.
Fixes #43158.

Note: See TracTickets for help on using tickets.