Changeset 51320 for branches/5.8/src/wp-content/themes/twentytwentyone/inc/template-functions.php

Timestamp:

07/02/2021 07:07:01 PM (4 years ago)

Author:

desrosj

Message:

Twenty Twenty-One: Add missing documentation for some filters.

Add missing @since tags for some functions.

Follow-up to [49216], [49220], [49854], [51294].

Props SergeyBiryukov.
Merges [51304] to the 5.8 branch.
See #52628, #53461.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-content/themes/twentytwentyone/inc/template-functions.php (modified) (10 diffs)

branches/5.8/src/wp-content/themes/twentytwentyone/inc/template-functions.php

@@ -104 +104 @@
  */
 function twenty_twenty_one_can_show_post_thumbnail() {
+    /**
+     * Filters whether post thumbnail can be displayed.
+     *
+     * @since Twenty Twenty-One 1.0
+     *
+     * @param bool $show_post_thumbnail Whether to show post thumbnail.
+     */
     return apply_filters(
         'twenty_twenty_one_can_show_post_thumbnail',
@@ -122 +129 @@
 
 /**
- * Creates continue reading text
+ * Creates continue reading text.
+ *
+ * @since Twenty Twenty-One 1.0
  */
 function twenty_twenty_one_continue_reading_text() {
@@ -135 +144 @@
 
 /**
- * Create the continue reading link for excerpt.
+ * Creates the continue reading link for excerpt.
+ *
+ * @since Twenty Twenty-One 1.0
  */
 function twenty_twenty_one_continue_reading_link_excerpt() {
@@ -147 +158 @@
 
 /**
- * Create the continue reading link.
+ * Creates the continue reading link.
+ *
+ * @since Twenty Twenty-One 1.0
  */
 function twenty_twenty_one_continue_reading_link() {
@@ -160 +173 @@
 if ( ! function_exists( 'twenty_twenty_one_post_title' ) ) {
     /**
-     * Add a title to posts and pages that are missing titles.
+     * Adds a title to posts and pages that are missing titles.
      *
      * @since Twenty Twenty-One 1.0
@@ -190 +203 @@
  * Changes the default navigation arrows to svg icons
  *
+ * @since Twenty Twenty-One 1.0
+ *
  * @param string $calendar_output The generated HTML of the calendar.
  * @return string
@@ -205 +220 @@
  * Return CSS for non-latin language, if available, or null
  *
- * @param string $type Whether to return CSS for the "front-end", "block-editor" or "classic-editor".
+ * @since Twenty Twenty-One 1.0
+ *
+ * @param string $type Whether to return CSS for the "front-end", "block-editor", or "classic-editor".
  * @return string
  */
@@ -213 +230 @@
     $locale = get_bloginfo( 'language' );
 
-    // Define fallback fonts for non-latin languages.
+    /**
+     * Filters the fallback fonts for non-latin languages.
+     *
+     * @since Twenty Twenty-One 1.0
+     *
+     * @param array $font_family An array of locales and font families.
+     */
     $font_family = apply_filters(
         'twenty_twenty_one_get_localized_font_family_types',
@@ -283 +306 @@
     }
 
-    // Define elements to apply fallback fonts to.
+    /**
+     * Filters the elements to apply fallback fonts to.
+     *
+     * @since Twenty Twenty-One 1.0
+     *
+     * @param array $elements An array of elements for "front-end", "block-editor", or "classic-editor".
+     */
     $elements = apply_filters(
         'twenty_twenty_one_get_localized_font_family_elements',
@@ -369 +398 @@
 
     if ( $blocks_content ) {
+        /** This filter is documented in wp-includes/post-template.php */
         echo apply_filters( 'the_content', $blocks_content ); // phpcs:ignore WordPress.Security.EscapeOutput
         return true;