Changeset 58237 for trunk/src/wp-content/themes/twentyseventeen/functions.php

Timestamp:

05/29/2024 07:41:03 PM (3 months ago)

Author:

karmatosed

Message:

Twenty Seventeen: Updates docblock for function.

The new function twentyseventeen_should_show_featured_image was missing documentation for the custom filter. This brings that in.

Props poena.
Fixes #39281.

File:

• trunk/src/wp-content/themes/twentyseventeen/functions.php (modified) (1 diff)

trunk/src/wp-content/themes/twentyseventeen/functions.php

@@ -691 +691 @@
 
 /**
- * If a regular post or page, and not the front page, show the featured image below the header.
- * Using get_queried_object_id() here since the $post global may not be set before a call to the_post().
+ * Show the featured image below the header on single posts and pages, unless the
+ * page is the front page.
+ *
+ * Use the filter `twentyseventeen_should_show_featured_image` in a child theme or
+ * plugin to change when the image is shown. This example prevents the image
+ * from showing:
+ *
+ *     add_filter(
+ *         'twentyseventeen_should_show_featured_image',
+ *         '__return_false'
+ *     );
  *
  * @since Twenty Seventeen 3.7