Changeset 48102 for trunk/src/wp-content/themes/twentytwenty/inc/template-tags.php

Timestamp:

06/20/2020 11:16:12 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Remove an empty line between @param and @return tags, per the documentation standards.

See #49572.

File:

• trunk/src/wp-content/themes/twentytwenty/inc/template-tags.php (modified) (21 diffs)

trunk/src/wp-content/themes/twentytwenty/inc/template-tags.php

@@ -22 +22 @@
  * Logo & Description
  */
+
 /**
  * Displays the site logo, either text or image.
@@ -27 +28 @@
  * @param array   $args Arguments for displaying the site logo either as an image or text.
  * @param boolean $echo Echo or return the HTML.
- *
- * @return string $html Compiled HTML based on our arguments.
+ * @return string Compiled HTML based on our arguments.
  */
 function twentytwenty_site_logo( $args = array(), $echo = true ) {
@@ -90 +90 @@
  *
  * @param boolean $echo Echo or return the html.
- *
- * @return string $html The HTML to display.
+ * @return string The HTML to display.
  */
 function twentytwenty_site_description( $echo = true ) {
@@ -125 +124 @@
  * Comments
  */
-/**
- * Check if the specified comment is written by the author of the post commented on.
+
+/**
+ * Checks if the specified comment is written by the author of the post commented on.
  *
  * @param object $comment Comment data.
- *
  * @return bool
  */
@@ -150 +149 @@
 
 /**
- * Filter comment reply link to not JS scroll.
+ * Filters comment reply link to not JS scroll.
+ *
  * Filter the comment reply link to add a class indicating it should not use JS slow-scroll, as it
  * makes it scroll to the wrong position on the page.
  *
  * @param string $link Link to the top of the page.
- *
- * @return string $link Link to the top of the page.
+ * @return string Link to the top of the page.
  */
 function twentytwenty_filter_comment_reply_link( $link ) {
@@ -170 +169 @@
  * Post Meta
  */
-/**
- * Get and Output Post Meta.
- * If it's a single post, output the post meta values specified in the Customizer settings.
- *
- * @param int    $post_id The ID of the post for which the post meta should be output.
+
+/**
+ * Retrieves and displays the post meta.
+ *
+ * If it's a single post, outputs the post meta values specified in the Customizer settings.
+ *
+ * @param int    $post_id  The ID of the post for which the post meta should be output.
  * @param string $location Which post meta location to output – single or preview.
  */
@@ -221 +222 @@
 
 /**
- * Get the post meta.
+ * Retrieves the post meta.
  *
  * @param int    $post_id The ID of the post.
@@ -234 +235 @@
 
     /**
-     * Filters post types array
-     *
-     * This filter can be used to hide post meta information of post, page or custom post type registerd by child themes or plugins
+     * Filters post types array.
+     *
+     * This filter can be used to hide post meta information of post, page or custom post type
+     * registered by child themes or plugins.
      *
      * @since Twenty Twenty 1.0
@@ -243 +245 @@
      */
     $disallowed_post_types = apply_filters( 'twentytwenty_disallowed_post_types_for_meta_output', array( 'page' ) );
+
     // Check whether the post type is allowed to output post meta.
     if ( in_array( get_post_type( $post_id ), $disallowed_post_types, true ) ) {
@@ -254 +257 @@
     if ( 'single-top' === $location ) {
         /**
-        * Filters post meta info visibility
-        *
-        * Use this filter to hide post meta information like Author, Post date, Comments, Is sticky status
-        *
-        * @since Twenty Twenty 1.0
-        *
-        * @param array $args {
-        *  @type string 'author'
-        *  @type string 'post-date'
-        *  @type string 'comments'
-        *  @type string 'sticky'
-        * }
-        */
+         * Filters post meta info visibility.
+         *
+         * Use this filter to hide post meta information like Author, Post date, Comments, Is sticky status.
+         *
+         * @since Twenty Twenty 1.0
+         *
+         * @param array $args {
+         *  @type string 'author'
+         *  @type string 'post-date'
+         *  @type string 'comments'
+         *  @type string 'sticky'
+         * }
+         */
         $post_meta = apply_filters(
             'twentytwenty_post_meta_location_single_top',
@@ -282 +285 @@
 
         /**
-        * Filters post tags visibility
-        *
-        * Use this filter to hide post tags
-        *
-        * @since Twenty Twenty 1.0
-        *
-        * @param array $args {
-        *   @type string 'tags'
-        * }
-        */
+         * Filters post tags visibility.
+         *
+         * Use this filter to hide post tags.
+         *
+         * @since Twenty Twenty 1.0
+         *
+         * @param array $args {
+         *   @type string 'tags'
+         * }
+         */
         $post_meta = apply_filters(
             'twentytwenty_post_meta_location_single_bottom',
@@ -490 +493 @@
  * Menus
  */
-/**
- * Filter Classes of wp_list_pages items to match menu items.
+
+/**
+ * Filters classes of wp_list_pages items to match menu items.
+ *
  * Filter the class applied to wp_list_pages() items with children to match the menu class, to simplify.
  * styling of sub levels in the fallback. Only applied if the match_menu_classes argument is set.
@@ -500 +505 @@
  * @param array  $args An array of arguments.
  * @param string $current_page Whether or not the item is the current item.
- *
  * @return array $css_class CSS Class names.
  */
@@ -529 +533 @@
 
 /**
- * Add a Sub Nav Toggle to the Expanded Menu and Mobile Menu.
+ * Adds a Sub Nav Toggle to the Expanded Menu and Mobile Menu.
  *
  * @param stdClass $args An array of arguments.
  * @param string   $item Menu item.
  * @param int      $depth Depth of the current menu item.
- *
  * @return stdClass $args An object of wp_nav_menu() arguments.
  */
@@ -576 +579 @@
 
 /**
- * Display SVG icons in social links menu.
+ * Displays SVG icons in social links menu.
  *
  * @param  string  $item_output The menu item output.
@@ -602 +605 @@
  * Classes
  */
-/**
- * Add No-JS Class.
- * If we're missing JavaScript support, the HTML element will have a no-js class.
+
+/**
+ * Adds 'no-js' class.
+ *
+ * If we're missing JavaScript support, the HTML element will have a 'no-js' class.
  */
 function twentytwenty_no_js_class() {
@@ -617 +622 @@
 
 /**
- * Add conditional body classes.
+ * Adds conditional body classes.
  *
  * @param array $classes Classes added to the body tag.
- *
- * @return array $classes Classes added to the body tag.
+ * @return array Classes added to the body tag.
  */
 function twentytwenty_body_classes( $classes ) {
@@ -717 +721 @@
  * Archives
  */
+
 /**
  * Filters the archive title and styles the word before the first colon.
  *
  * @param string $title Current archive title.
- *
- * @return string $title Current archive title.
+ * @return string Current archive title.
  */
 function twentytwenty_get_the_archive_title( $title ) {
@@ -749 +753 @@
  * Miscellaneous
  */
-/**
- * Toggle animation duration in milliseconds.
- *
- * @return integer Duration in milliseconds
+
+/**
+ * Toggles animation duration in milliseconds.
+ *
+ * @return int Duration in milliseconds
  */
 function twentytwenty_toggle_duration() {
@@ -760 +765 @@
      * @since Twenty Twenty 1.0
      *
-     * @param integer $duration Duration in milliseconds.
+     * @param int $duration Duration in milliseconds.
      */
     $duration = apply_filters( 'twentytwenty_toggle_duration', 250 );
@@ -768 +773 @@
 
 /**
- * Get unique ID.
+ * Gets unique ID.
  *
  * This is a PHP implementation of Underscore's uniqueId method. A static variable