Changeset 26556 for trunk/src/wp-content/themes/twentyfourteen/inc/custom-header.php

Timestamp:

12/03/2013 05:05:53 PM (11 years ago)

Author:

lancewillett

Message:

Twenty Fourteen: update comment blocks to match inline docs standards. Props DrewAPicture, see #25837.

File:

• trunk/src/wp-content/themes/twentyfourteen/inc/custom-header.php (modified) (3 diffs)

trunk/src/wp-content/themes/twentyfourteen/inc/custom-header.php

@@ -18 +18 @@
  */
 function twentyfourteen_custom_header_setup() {
+    /**
+     * Filter Twenty Fourteen custom-header support arguments.
+     *
+     * @since Twenty Fourteen 1.0
+     *
+     * @param array $args {
+     *     An array of custom-header support arguments.
+     *
+     *     @type bool   $header_text            Whether to display custom header text. Default false.
+     *     @type int    $width                  Width in pixels of the custom header image. Default 1260.
+     *     @type int    $height                 Height in pixels of the custom header image. Default 240.
+     *     @type bool   $flex_height            Whether to allow flexible-height header images. Default true.
+     *     @type string $admin_head_callback    Callback function used to style the image displayed in
+     *                                          the Appearance > Header screen.
+     *     @type string $admin_preview_callback Callback function used to create the custom header markup in
+     *                                          the Appearance > Header screen.
+     * }
+     */
     add_theme_support( 'custom-header', apply_filters( 'twentyfourteen_custom_header_args', array(
         'header-text'            => false,
@@ -31 +49 @@
 if ( ! function_exists( 'twentyfourteen_admin_header_style' ) ) :
 /**
- * Style the header image displayed on the Appearance > Header admin panel.
+ * Style the header image displayed on the Appearance > Header screen.
  *
- * @link twentyfourteen_custom_header_setup().
+ * @see twentyfourteen_custom_header_setup()
  *
  * @since Twenty Fourteen 1.0
@@ -66 +84 @@
 if ( ! function_exists( 'twentyfourteen_admin_header_image' ) ) :
 /**
- * Create the custom header image markup displayed on the Appearance > Header admin panel.
+ * Create the custom header image markup displayed on the Appearance > Header screen.
  *
- * @link twentyfourteen_custom_header_setup().
+ * @see twentyfourteen_custom_header_setup()
  *
  * @since Twenty Fourteen 1.0