sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

phpDoc updates for functions.wp-styles.php. Merge from BackPress props CharlesClarkson. 

git-svn-id: https://develop.svn.wordpress.org/trunk@12531 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Peter Westwood 2009-12-24 08:21:16 +00:00
parent 4bad636a1a
commit b6669a3c9d
1 changed files with 34 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
wp-includes/functions.wp-styles.php
View File

@ -13,7 +13,8 @@
* @uses do_action() Calls 'wp_print_styles' hook.
* @global object $wp_styles The WP_Styles object for printing styles.
*
* @param array $handles (optional) Styles to be printed. (void) prints queue, (string) prints that style, (array of strings) prints those styles.
* @param array|bool $handles Styles to be printed. An empty array prints the queue,
* an array with one string prints that style, and an array of strings prints those styles.
* @return bool True on success, false on failure.
*/
function wp_print_styles( $handles = false ) {
@ -36,7 +37,18 @@ function wp_print_styles( $handles = false ) {
* Register CSS style file.
*
* @since r79
* @see WP_Styles::add() For parameter and additional information.
* @see WP_Styles::add() For additional information.
* @global object $wp_styles The WP_Styles object for printing styles.
* @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
*
* @param string $handle Name of the stylesheet.
* @param string|bool $src Path to the stylesheet from the root directory of WordPress. Example: '/css/mystyle.css'.
* @param array $deps Array of handles of any stylesheet that this stylesheet depends on.
* (Stylesheets that must be loaded before this stylesheet.) Pass an empty array if there are no dependencies.
* @param string|bool $ver String specifying the stylesheet version number, if it has one. This parameter
* is used to ensure that the correct version is sent to the client regardless of caching, and so should be included
* if a version number is available and makes sense for the stylesheet.
* @param string $media The media for which this stylesheet has been defined.
*/
function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
global $wp_styles;
@ -50,7 +62,10 @@ function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media
* Remove a registered CSS file.
*
* @since r79
* @see WP_Styles::remove() For parameter and additional information.
* @see WP_Styles::remove() For additional information.
* @global object $wp_styles The WP_Styles object for printing styles.
*
* @param string $handle Name of the stylesheet.
*/
function wp_deregister_style( $handle ) {
global $wp_styles;
@ -65,6 +80,17 @@ function wp_deregister_style( $handle ) {
*
* @since r79
* @see WP_Styles::add(), WP_Styles::enqueue()
* @global object $wp_styles The WP_Styles object for printing styles.
* @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
*
* @param string $handle Name of the stylesheet.
* @param string|bool $src Path to the stylesheet from the root directory of WordPress. Example: '/css/mystyle.css'.
* @param array $deps Array of handles (names) of any stylesheet that this stylesheet depends on.
* (Stylesheets that must be loaded before this stylesheet.) Pass an empty array if there are no dependencies.
* @param string|bool $ver String specifying the stylesheet version number, if it has one. This parameter
* is used to ensure that the correct version is sent to the client regardless of caching, and so should be included
* if a version number is available and makes sense for the stylesheet.
* @param string $media The media for which this stylesheet has been defined.
*/
function wp_enqueue_style( $handle, $src = false, $deps = array(), $ver = false, $media = false ) {
global $wp_styles;
@ -81,14 +107,14 @@ function wp_enqueue_style( $handle, $src = false, $deps = array(), $ver = false,
/**
* Check whether style has been added to WordPress Styles.
*
* The values for list defaults to 'queue', which is the same as enqueue for
* styles.
* The values for list defaults to 'queue', which is the same as wp_enqueue_style().
*
* @since WP unknown; BP unknown
* @global object $wp_styles The WP_Styles object for printing styles.
*
* @param string $handle Handle used to add style.
* @param string $list Optional, defaults to 'queue'. Others values are 'registered', 'queue', 'done', 'to_do'
* @return bool
* @param string $handle Name of the stylesheet.
* @param string $list Values are 'registered', 'done', 'queue' and 'to_do'.
* @return bool True on success, false on failure.
*/
function wp_style_is( $handle, $list = 'queue' ) {
global $wp_styles;