WordPress.org
Get WordPress

Make WordPress Core

Opened 7 months ago

Closed 7 months ago

#63637 closed defect (bug) (fixed)

Twenty Seventeen: PHPDoc block are missing for the_content filter hooks

Reported by: pmbaldha's profile pmbaldha Owned by: peterwilsoncc's profile peterwilsoncc
Milestone: 6.9 Priority: normal
Severity: normal Version:
Component: Bundled Theme Keywords: has-patch commit
Focuses: docs, coding-standards Cc:

Description

PHPDoc blocks are missing in the following places:

Please add PHPDoc blocks for them.

Change History (7)

#1 @mukesh27
7 months ago

  • Component changed from Themes to Bundled Theme
  • Focuses docs added
  • Keywords needs-patch added
  • Summary changed from PHPDoc block are missing for the_content filter hooks in the Twenty Seventeen theme to Twenty Seventeen: PHPDoc block are missing for the_content filter hooks

This ticket was mentioned in ​PR #9132 on ​WordPress/wordpress-develop by ​@pmbaldha.
7 months ago #2

  • Keywords has-patch added; needs-patch removed

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

#4 @mukesh27
7 months ago

  • Keywords commit added
  • Milestone changed from Awaiting Review to 6.9
  • Type changed from enhancement to defect (bug)

​@peterwilsoncc commented on ​PR #9132:
7 months ago #5

While reviewing the hooks in 2017, I noticed that a docblock was missing for the twentyseventeen_should_show_featured_image filter.

​https://github.com/WordPress/wordpress-develop/blob/a8b9dc1df086370f1a64f4951a0815be1e712e62/src/wp-content/themes/twentyseventeen/functions.php#L709-L712

While fixing the docblock for the other hook, it would be great to fix this one too. Are you able to assist? The hook was introduced in version 3.7 of the theme.

​@sabernhardt commented on ​PR #9132:
7 months ago #6

@peterwilsoncc The twentyseventeen_should_show_featured_image filter's docblock (currently) has its own ticket (63644) and PR #9167.

#7 @peterwilsoncc
7 months ago

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

In 60430:

Twenty Seventeen: Document the the_content filter.

Adds documentation references to the filter's docblock in wp-includes/post-template.php.

Follow-up to [38833].

Props pmbaldha, mukesh27, sabernhardt.
Fixes #63637.

Note: See TracTickets for help on using tickets.