Wordpress 2.8-scripts

[autoinstalls/wordpress.git] / wp-includes / functions.wp-styles.php

diff --git a/wp-includes/functions.wp-styles.php b/wp-includes/functions.wp-styles.php
index 8a3828265f7f988bd4b59bbd3a7713bae0a5624a..22d1e160d5d83827c99eed2142f5c0127f7318d0 100644 (file)
--- a/wp-includes/functions.wp-styles.php
+++ b/wp-includes/functions.wp-styles.php
@@ -1,5 +1,21 @@
 <?php
+/**
+ * BackPress styles procedural API.
+ *
+ * @package BackPress
+ * @since r79
+ */
 
+/**
+ * Display styles that are in the queue or part of $handles.
+ *
+ * @since r79
+ * @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.
+ * @return bool True on success, false on failure.
+ */
 function wp_print_styles( $handles = false ) {
        do_action( 'wp_print_styles' );
        if ( '' === $handles ) // for wp_head
@@ -16,7 +32,13 @@ function wp_print_styles( $handles = false ) {
        return $wp_styles->do_items( $handles );
 }
 
-function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = false ) {
+/**
+ * Register CSS style file.
+ *
+ * @since r79
+ * @see WP_Styles::add() For parameter and additional information.
+ */
+function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
        global $wp_styles;
        if ( !is_a($wp_styles, 'WP_Styles') )
                $wp_styles = new WP_Styles();
@@ -24,6 +46,12 @@ function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media
        $wp_styles->add( $handle, $src, $deps, $ver, $media );
 }
 
+/**
+ * Remove a registered CSS file.
+ *
+ * @since r79
+ * @see WP_Styles::remove() For parameter and additional information.
+ */
 function wp_deregister_style( $handle ) {
        global $wp_styles;
        if ( !is_a($wp_styles, 'WP_Styles') )
@@ -32,6 +60,12 @@ function wp_deregister_style( $handle ) {
        $wp_styles->remove( $handle );
 }
 
+/**
+ * Enqueue a CSS style file.
+ *
+ * @since r79
+ * @see WP_Styles::add(), WP_Styles::enqueue()
+ */
 function wp_enqueue_style( $handle, $src = false, $deps = array(), $ver = false, $media = false ) {
        global $wp_styles;
        if ( !is_a($wp_styles, 'WP_Styles') )
@@ -43,3 +77,28 @@ function wp_enqueue_style( $handle, $src = false, $deps = array(), $ver = false,
        }
        $wp_styles->enqueue( $handle );
 }
+
+/**
+ * Check whether style has been added to WordPress Styles.
+ *
+ * The values for list defaults to 'queue', which is the same as enqueue for
+ * styles.
+ *
+ * @since WP unknown; BP unknown
+ *
+ * @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
+ */
+function wp_style_is( $handle, $list = 'queue' ) {
+       global $wp_styles;
+       if ( !is_a($wp_styles, 'WP_Scripts') )
+               $wp_styles = new WP_Styles();
+
+       $query = $wp_styles->query( $handle, $list );
+
+       if ( is_object( $query ) )
+               return true;
+
+       return $query;
+}