Twenty Fifteen: Document the `'twentyfifteen_color_schemes'` filter.

Props DrewAPicture.
Fixes #34119.

git-svn-id: https://develop.svn.wordpress.org/trunk@34791 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2015-10-03 01:09:20 +00:00
parent 2212c0f858
commit 217d44bd60
1 changed files with 21 additions and 0 deletions

View File

@ -87,6 +87,27 @@ add_action( 'customize_register', 'twentyfifteen_customize_register', 11 );
* @return array An associative array of color scheme options. * @return array An associative array of color scheme options.
*/ */
function twentyfifteen_get_color_schemes() { 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( return apply_filters( 'twentyfifteen_color_schemes', array(
'default' => array( 'default' => array(
'label' => __( 'Default', 'twentyfifteen' ), 'label' => __( 'Default', 'twentyfifteen' ),