WordPress.org

Make WordPress Core

Opened 8 months ago

Closed 6 months ago

#45308 closed defect (bug) (fixed)

Use duplicate hook reference syntax for duplicates of 'link_category' and `pre_user_login`

Reported by: coffee2code Owned by: pento
Milestone: 5.1 Priority: normal
Severity: minor Version: 2.2
Component: General Keywords: has-patch
Focuses: docs Cc:

Description

link_category and pre_user_login appear to be the last remaining hooks that are defined in more than one place and still uniquely documented in each place. The convention for duplicated hooks is for one instance of the hook to be considered canonical with full documentation while all subsequent instances get documented with a special comment referencing that canonical documentation.

See attached patch for fix.

Related: the hook user_confirmed_action_email_content is also duplicated, but each instance's documentation differs in meaningful ways. See #44314 for discussion on the matter (particularly my pertinent comment).

Attachments (1)

45308.diff (2.0 KB) - added by coffee2code 8 months ago.
Patch mentioned in ticket.

Download all attachments as: .zip

Change History (8)

@coffee2code
8 months ago

Patch mentioned in ticket.

#1 @SergeyBiryukov
8 months ago

  • Milestone changed from Awaiting Review to 5.0.1
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

#2 @pento
7 months ago

  • Milestone changed from 5.0.1 to 5.0.2

#3 @pento
7 months ago

  • Milestone changed from 5.0.2 to 5.0.3

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


6 months ago

#5 @desrosj
6 months ago

  • Milestone changed from 5.0.3 to 5.1

Per today's bug scrub, documentation enhancements will be addressed in 5.1, coming next month.

#6 @pento
6 months ago

  • Owner changed from SergeyBiryukov to pento
  • Status changed from reviewing to accepted

#7 @pento
6 months ago

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

In 44612:

Docs: Remove duplicate docblocks for the pre_user_login and link_category filters.

Props coffee2code.
Fixes #45308.

Note: See TracTickets for help on using tickets.