Changeset 51322 for trunk/src/wp-content/themes/twentytwenty/functions.php

Timestamp:

07/03/2021 09:13:48 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Twenty Twenty: Add missing documentation for some filters.

Add missing @since tags for some functions.

Correct alignment of some @param tags.

Follow-up to [46271], [46278], [51304].

See #52628, #53461.

File:

• trunk/src/wp-content/themes/twentytwenty/functions.php (modified) (16 diffs)

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

@@ -31 +31 @@
  * runs before the init hook. The init hook is too late for some features, such
  * as indicating support for post thumbnails.
+ *
+ * @since Twenty Twenty 1.0
  */
 function twentytwenty_theme_support() {
@@ -184 +186 @@
 /**
  * Register and Enqueue Styles.
+ *
+ * @since Twenty Twenty 1.0
  */
 function twentytwenty_register_styles() {
@@ -204 +208 @@
 /**
  * Register and Enqueue Scripts.
+ *
+ * @since Twenty Twenty 1.0
  */
 function twentytwenty_register_scripts() {
@@ -225 +231 @@
  * This does not enqueue the script because it is tiny and because it is only for IE11,
  * thus it does not warrant having an entire dedicated blocking script being loaded.
+ *
+ * @since Twenty Twenty 1.0
  *
  * @link https://git.io/vWdr2
@@ -238 +246 @@
 add_action( 'wp_print_footer_scripts', 'twentytwenty_skip_link_focus_fix' );
 
-/** Enqueue non-latin language styles
+/**
+ * Enqueue non-latin language styles.
  *
  * @since Twenty Twenty 1.0
@@ -256 +265 @@
 /**
  * Register navigation menus uses wp_nav_menu in five places.
+ *
+ * @since Twenty Twenty 1.0
  */
 function twentytwenty_menus() {
@@ -274 +285 @@
 /**
  * Get the information about the logo.
+ *
+ * @since Twenty Twenty 1.0
  *
  * @param string $html The HTML output from get_custom_logo (core function).
@@ -332 +345 @@
     /**
      * Shim for wp_body_open, ensuring backward compatibility with versions of WordPress older than 5.2.
+     *
+     * @since Twenty Twenty 1.0
      */
     function wp_body_open() {
+        /** This action is documented in wp-includes/general-template.php */
         do_action( 'wp_body_open' );
     }
@@ -340 +356 @@
 /**
  * Include a skip to content link at the top of the page so that users can bypass the menu.
+ *
+ * @since Twenty Twenty 1.0
  */
 function twentytwenty_skip_link() {
@@ -349 +367 @@
 /**
  * Register widget areas.
+ *
+ * @since Twenty Twenty 1.0
  *
  * @link https://developer.wordpress.org/themes/functionality/sidebars/#registering-a-sidebar
@@ -392 +412 @@
 /**
  * Enqueue supplemental block editor styles.
+ *
+ * @since Twenty Twenty 1.0
  */
 function twentytwenty_block_editor_styles() {
@@ -413 +435 @@
 /**
  * Enqueue classic editor styles.
+ *
+ * @since Twenty Twenty 1.0
  */
 function twentytwenty_classic_editor_styles() {
@@ -429 +453 @@
  * Output Customizer settings in the classic editor.
  * Adds styles to the head of the TinyMCE iframe. Kudos to @Otto42 for the original solution.
+ *
+ * @since Twenty Twenty 1.0
  *
  * @param array $mce_init TinyMCE styles.
@@ -480 +506 @@
  * Block Editor Settings.
  * Add custom colors and font sizes to the block editor.
+ *
+ * @since Twenty Twenty 1.0
  */
 function twentytwenty_block_editor_settings() {
@@ -633 +661 @@
  * @since Twenty Twenty 1.0
  *
- * @param string $area The area we want to get the colors for.
+ * @param string $area    The area we want to get the colors for.
  * @param string $context Can be 'text' or 'accent'.
  * @return string Returns a HEX color.
@@ -751 +779 @@
 
     /**
-    * Filters Twenty Twenty theme elements
-    *
-    * @since Twenty Twenty 1.0
-    *
-    * @param array Array of elements
-    */
+     * Filters Twenty Twenty theme elements.
+     *
+     * @since Twenty Twenty 1.0
+     *
+     * @param array Array of elements.
+     */
     return apply_filters( 'twentytwenty_get_elements_array', $elements );
 }