Docs: Improve documentation for `wp_admin_css_color()`.

Props kiranpotphode.
Fixes #34857.

git-svn-id: https://develop.svn.wordpress.org/trunk@36107 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2015-12-27 16:32:00 +00:00
parent 5502d59fb9
commit 7e3d2c3e4c
1 changed files with 10 additions and 5 deletions

View File

@ -3078,15 +3078,20 @@ function paginate_links( $args = '' ) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @todo Properly document optional arguments as such
*
* @global array $_wp_admin_css_colors * @global array $_wp_admin_css_colors
* *
* @param string $key The unique key for this theme. * @param string $key The unique key for this theme.
* @param string $name The name of the theme. * @param string $name The name of the theme.
* @param string $url The url of the css file containing the colour scheme. * @param string $url The URL of the CSS file containing the color scheme.
* @param array $colors Optional An array of CSS color definitions which are used to give the user a feel for the theme. * @param array $colors Optional. An array of CSS color definition strings which are used
* @param array $icons Optional An array of CSS color definitions used to color any SVG icons * to give the user a feel for the theme.
* @param array $icons {
* Optional. CSS color definitions used to color any SVG icons.
*
* @type string $base SVG icon base color.
* @type string $focus SVG icon color on focus.
* @type string $current SVG icon color of current admin menu link.
* }
*/ */
function wp_admin_css_color( $key, $name, $url, $colors = array(), $icons = array() ) { function wp_admin_css_color( $key, $name, $url, $colors = array(), $icons = array() ) {
global $_wp_admin_css_colors; global $_wp_admin_css_colors;