Added PHPDoc block for the_content filter hooks in the Twenty Seventeen theme

[pmbaldha]

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

---

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props pmbaldha, peterwilsoncc, mukesh27, sabernhardt.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[mukeshpanchal27]

Nice!

TT1 have similar comment

wordpress-develop/src/wp-content/themes/twentytwentyone/inc/template-functions.php

Line 400 in c08537d

/** This filter is documented in wp-includes/post-template.php */

[github-actions]

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

• The Plugin and Theme Directories cannot be accessed within Playground.
• All changes will be lost when closing a tab with a Playground instance.
• All changes will be lost when refreshing the page.
• A fresh instance is created each time the link below is clicked.
• Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
  it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

[peterwilsoncc]

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

wordpress-develop/src/wp-content/themes/twentyseventeen/functions.php

Lines 709 to 712 in a8b9dc1

	function twentyseventeen_should_show_featured_image() {
	$show_featured_image = ( is_single() || ( is_page() && ! twentyseventeen_is_frontpage() ) ) && has_post_thumbnail( get_queried_object_id() );
	return apply_filters( 'twentyseventeen_should_show_featured_image', $show_featured_image );
	}

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]

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

[peterwilsoncc]

@sabernhardt Thanks Stephen, I appreciate the pointer.

[github-actions]

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 60430
GitHub commit: 6b57942

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.