Changeset 34791

Timestamp:

10/03/2015 01:09:20 AM (9 years ago)

Author:

SergeyBiryukov

Message:

Twenty Fifteen: Document the 'twentyfifteen_color_schemes' filter.

Props DrewAPicture.
Fixes #34119.

File:

• trunk/src/wp-content/themes/twentyfifteen/inc/customizer.php (modified) (1 diff)

trunk/src/wp-content/themes/twentyfifteen/inc/customizer.php

@@ -88 +88 @@
  */
 function twentyfifteen_get_color_schemes() {
+    /**
+     * Filter the color schemes registered for use with Twenty Fifteen.
+     *
+     * The default schemes include 'default', 'dark', 'yellow', 'pink', 'purple', and 'blue'.
+     *
+     * @since Twenty Fifteen 1.0
+     *
+     * @param array $schemes {
+     *     Associative array of color schemes data.
+     *
+     *     @type array $slug {
+     *         Associative array of information for setting up the color scheme.
+     *
+     *         @type string $label  Color scheme label.
+     *         @type array  $colors HEX codes for default colors prepended with a hash symbol ('#').
+     *                              Colors are defined in the following order: Main background, sidebar
+     *                              background, box background, main text and link, sidebar text and link,
+     *                              meta box background.
+     *     }
+     * }
+     */
     return apply_filters( 'twentyfifteen_color_schemes', array(
         'default' => array(