Make WordPress Core

Opened 3 months ago

Closed 3 months ago

Last modified 3 months ago

#60262 closed defect (bug) (fixed)

Documentation for new_admin_email_content hook should contain a list instead of headings

Reported by: dd32's profile dd32 Owned by: peterwilsoncc's profile peterwilsoncc
Milestone: 6.5 Priority: low
Severity: normal Version:
Component: Networks and Sites Keywords: has-patch
Focuses: docs, multisite Cc:

Description

As reported in https://github.com/WordPress/Documentation-Issue-Tracker/issues/1208 and then https://github.com/WordPress/phpdoc-parser/issues/236 the PHPdoc for the new_admin_email_content filter includes some markdown headers.

While an argument could be made that this should be handled on the parser side, I think support for headings is valuable for some code such as used in WP_HTML_Tag_Processor.

Change History (4)

This ticket was mentioned in PR #5876 on WordPress/wordpress-develop by @dd32.


3 months ago
#1

  • Keywords has-patch added

#2 @peterwilsoncc
3 months ago

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

In 57289:

Docs: Format new_admin_email_content placeholders as a list.

Format the email placeholders for the new_admin_email_content hook as a list for clarity and to avoid parsing errors in docblock consumers.

Props dd32, shooper, stevenlinx.
Fixes #60262.

#4 @peterwilsoncc
3 months ago

  • Milestone changed from Awaiting Review to 6.5
Note: See TracTickets for help on using tickets.