Make WordPress Core

Opened 10 years ago

Closed 10 years ago

#36862 closed defect (bug) (fixed)

Inccorrect @since tags in WP_Plugins_List_Table::single_row()

Reported by: tfrommen Owned by: johnbillion
Priority: normal Milestone: 4.7
Component: Plugins Version: 4.4
Severity: normal Keywords: has-patch commit
Cc: Focuses: docs

Description

For the (network_admin_)plugin_action_links_{$plugin_file} filters, the individual @since tag indicating the introduction of the filters is incorrect. The old $prefix included a trailing underscore. In case of the network_admin_* filters, also the version is incorrect (see the according/general plugin_* filters).

Attachments (2)

36862.patch (1.9 KB ) - added by tfrommen 10 years ago.
36862.2.patch (2.0 KB ) - added by SergeyBiryukov 10 years ago.

Download all attachments as: .zip

Change History (13)

@tfrommen
10 years ago

#1 @tfrommen
10 years ago

  • Keywords has-patch added

#2 in reply to: ↑ description @SergeyBiryukov
10 years ago

  • Milestone Awaiting Review4.7

Some history:

  • plugin_action_links was introduced in [7517] (2.5.0).
  • The $context parameter was added [8049] (2.6.0).
  • plugin_action_links_$plugin_file was added in [9124] (2.7.0).
  • network_admin_* versions were added in [17004] (3.1.0).
  • Current docs were added in [34786] (4.4.0).

Replying to tfrommen:

In case of the network_admin_* filters, also the version is incorrect (see the according/general plugin_* filters).

I think the version is correct, as those were introduced in [17004].

I'm not sure the "As hook_name" notation is needed here. We use that for renamed hooks, but these ones were not renamed, just explicitly written out. Using it for the last two hooks is also incorrect, because they were introduced without $prefix.

36862.2.patch is my take on the corrections.

Last edited 10 years ago by SergeyBiryukov (previous) (diff)

This ticket was mentioned in Slack in #core by stevenkword. View the logs.


10 years ago

#4 @stevenkword
10 years ago

@DrewAPicture Would you mind putting some eyes on this?

This ticket was mentioned in Slack in #core by jeffpaul. View the logs.


10 years ago

This ticket was mentioned in Slack in #core by jeffpaul. View the logs.


10 years ago

This ticket was mentioned in Slack in #core by jeffpaul. View the logs.


10 years ago

#8 @DrewAPicture
10 years ago

  • Keywords 2nd-opinion added

I think I'd be interested in @johnbillion's take here, since he introduced the docs. I do agree that the underscore wasn't there before so if we keep the initial introduce changelog entries, that at least should be fixed.

#9 @johnbillion
10 years ago

  • Owner set to johnbillion
  • Status newreviewing

#10 @johnbillion
10 years ago

  • Keywords commit added; 2nd-opinion removed

I agree with Sergey, there's actually no need for the @since docs to be split into the prefix and post-prefix entries as the change was actually just to remove the dynamic portion of the hook name. The name itself didn't change.

#11 @johnbillion
10 years ago

  • Resolutionfixed
  • Status reviewingclosed

Fixed in [39063].

Note: See TracTickets for help on using tickets.