Docs: Improve the DocBlocks for get_header_textcolor() and header_textcolor() to mention that they both retrieve color values in the HEX format.

Props theMikeD.
Fixes #36336.


git-svn-id: https://develop.svn.wordpress.org/trunk@37083 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-03-25 23:05:42 +00:00
parent 859d40bd24
commit 0b6af900f1

View File

@ -949,18 +949,18 @@ function remove_theme_mods() {
} }
/** /**
* Retrieve text color for custom header. * Retrieves the custom header text color in HEX format.
* *
* @since 2.1.0 * @since 2.1.0
* *
* @return string * @return string Header text color in HEX format (minus the hash symbol).
*/ */
function get_header_textcolor() { function get_header_textcolor() {
return get_theme_mod('header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) ); return get_theme_mod('header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) );
} }
/** /**
* Display text color for custom header. * Displays the custom header text color in HEX format (minus the hash symbol).
* *
* @since 2.1.0 * @since 2.1.0
*/ */