Context Navigation

Changeset 38846

Timestamp:

10/20/2016 08:33:38 PM (10 years ago)

Author:

davidakennedy

Message:

Twenty Fifteen, Twenty Seventeen: Add documentation to filters in themes.

Documents a missing one Twenty Fifteen and all four missing ones in Twenty Seventeen.

Props brainstormforce.

Fixes #38382.

Location:

trunk/src/wp-content/themes

Files:

-              r38093
+              r38846
         // Setup the WordPress core custom background feature.
+        /**
+         * Filter Twenty Fifteen custom-header support arguments.
+         *
+         * @since Twenty Fifteen 1.0
+         *
+         * @param array $args {
+         *     An array of custom-header support arguments.
+         *
+         *     @type string $default-color              Default color of the header.
+         *     @type string $default-attachment     Default attachment of the header.
+         * }
+         */
         add_theme_support( 'custom-background', apply_filters( 'twentyfifteen_custom_background_args', array(
                 'default-color'      => $default_color,

-              r38833
+              r38846
+        }
+        /**
+         * Filter Twenty Seventeen content width of the theme.
+         *
+         * @since Twenty Seventeen 1.0
+         *
+         * @param $content_width integer
+         */
         $GLOBALS['content_width'] = apply_filters( 'twentyseventeen_content_width', $content_width );
+}

-              r38833
+              r38846
 function twentyseventeen_custom_colors_css() {
         $hue = get_theme_mod( 'colorscheme_hue', 250 );
+        /**
+         * Filter Twenty Seventeen default saturation level.
+         *
+         * @since Twenty Seventeen 1.0
+         *
+         * @param $saturation integer
+         */
         $saturation = apply_filters( 'twentyseventeen_custom_colors_saturation', 50 );
         $reduced_saturation = ( .8 * $saturation ) . '%';

-              r38833
+              r38846
  */
 function twentyseventeen_custom_header_setup() {
+        /**
+         * Filter Twenty Seventeen custom-header support arguments.
+         *
+         * @since Twenty Seventeen 1.0
+         *
+         * @param array $args {
+         *     An array of custom-header support arguments.
+         *
+         *     @type string $default-image              Default image of the header.
+         *     @type string $default_text_color     Default color of the header text.
+         *     @type int    $width                  Width in pixels of the custom header image. Default 954.
+         *     @type int    $height                 Height in pixels of the custom header image. Default 1300.
+         *     @type string $wp-head-callback       Callback function used to styles the header image and text
+         *                                          displayed on the blog.
+         *     @type string $flex-height                Flex support for height of header.
+         * }
+         */
         add_theme_support( 'custom-header', apply_filters( 'twentyseventeen_custom_header_args', array(
                 'default-image'      => get_parent_theme_file_uri( '/assets/images/header.jpg' ),

-              r38833
+              r38846
         );
+        /**
+         * Filter Twenty Seventeen social links icons.
+         *
+         * @since Twenty Seventeen 1.0
+         *
+         * @param array $social_links_icons
+         */
         return apply_filters( 'twentyseventeen_social_links_icons', $social_links_icons );
+}

Note: See TracChangeset for help on using the changeset viewer.