Wordpress 3.5
[autoinstalls/wordpress.git] / wp-includes / functions.wp-styles.php
index 44e362c023337df7bd627abbc0f64ab1f9edbef4..49095f3b7ae16a90f22f80678789e01a63e757c6 100644 (file)
  * @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 ) {
-       do_action( 'wp_print_styles' );
        if ( '' === $handles ) // for wp_head
                $handles = false;
 
+       if ( ! $handles )
+               do_action( 'wp_print_styles' );
+
        global $wp_styles;
-       if ( !is_a($wp_styles, 'WP_Styles') ) {
+       if ( ! is_a( $wp_styles, 'WP_Styles' ) ) {
+               if ( ! did_action( 'init' ) )
+                       _doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+                               '<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>init</code>' ), '3.3' );
+
                if ( !$handles )
-                       return array(); // No need to instantiate if nothing's there.
+                       return array(); // No need to instantiate if nothing is there.
                else
                        $wp_styles = new WP_Styles();
        }
@@ -32,16 +39,53 @@ function wp_print_styles( $handles = false ) {
        return $wp_styles->do_items( $handles );
 }
 
+/**
+ * Adds extra CSS.
+ *
+ * Works only if the stylesheet has already been added.
+ * Accepts a string $data containing the CSS. If two or more CSS code blocks are
+ * added to the same stylesheet $handle, they will be printed in the order
+ * they were added, i.e. the latter added styles can redeclare the previous.
+ *
+ * @since 3.3.0
+ * @see WP_Scripts::add_inline_style()
+ */
+function wp_add_inline_style( $handle, $data ) {
+       global $wp_styles;
+       if ( ! is_a( $wp_styles, 'WP_Styles' ) ) {
+               if ( ! did_action( 'init' ) )
+                       _doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+                               '<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>init</code>' ), '3.3' );
+               $wp_styles = new WP_Styles();
+       }
+
+       return $wp_styles->add_inline_style( $handle, $data );
+}
+
 /**
  * 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. Set to null to disable.
+ *  Used to ensure that the correct version is sent to the client regardless of caching.
+ * @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;
-       if ( !is_a($wp_styles, 'WP_Styles') )
+       if ( ! is_a( $wp_styles, 'WP_Styles' ) ) {
+               if ( ! did_action( 'init' ) )
+                       _doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+                               '<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>init</code>' ), '3.3' );
                $wp_styles = new WP_Styles();
+       }
 
        $wp_styles->add( $handle, $src, $deps, $ver, $media );
 }
@@ -50,12 +94,19 @@ 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;
-       if ( !is_a($wp_styles, 'WP_Styles') )
+       if ( ! is_a( $wp_styles, 'WP_Styles' ) ) {
+               if ( ! did_action( 'init' ) )
+                       _doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+                               '<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>init</code>' ), '3.3' );
                $wp_styles = new WP_Styles();
+       }
 
        $wp_styles->remove( $handle );
 }
@@ -63,13 +114,30 @@ function wp_deregister_style( $handle ) {
 /**
  * Enqueue a CSS style file.
  *
+ * Registers the style if src provided (does NOT overwrite) and enqueues.
+ *
  * @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 ) {
+function wp_enqueue_style( $handle, $src = false, $deps = array(), $ver = false, $media = 'all' ) {
        global $wp_styles;
-       if ( !is_a($wp_styles, 'WP_Styles') )
+       if ( ! is_a( $wp_styles, 'WP_Styles' ) ) {
+               if ( ! did_action( 'init' ) )
+                       _doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+                               '<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>init</code>' ), '3.3' );
                $wp_styles = new WP_Styles();
+       }
 
        if ( $src ) {
                $_handle = explode('?', $handle);
@@ -77,3 +145,48 @@ function wp_enqueue_style( $handle, $src = false, $deps = array(), $ver = false,
        }
        $wp_styles->enqueue( $handle );
 }
+
+/**
+ * Remove an enqueued style.
+ *
+ * @since WP 3.1
+ * @see WP_Styles::dequeue() For parameter information.
+ */
+function wp_dequeue_style( $handle ) {
+       global $wp_styles;
+       if ( ! is_a( $wp_styles, 'WP_Styles' ) ) {
+               if ( ! did_action( 'init' ) )
+                       _doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+                               '<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>init</code>' ), '3.3' );
+               $wp_styles = new WP_Styles();
+       }
+
+       $wp_styles->dequeue( $handle );
+}
+
+/**
+ * Check whether style has been added to WordPress Styles.
+ *
+ * By default, checks if the style has been enqueued. You can also
+ * pass 'registered' to $list, to see if the style is registered,
+ * and you can check processing statuses with 'to_do' and 'done'.
+ *
+ * @since WP unknown; BP unknown
+ * @global object $wp_styles The WP_Styles object for printing styles.
+ *
+ * @param string $handle Name of the stylesheet.
+ * @param string $list Optional. Defaults to 'enqueued'. Values are
+ *     'registered', 'enqueued' (or 'queue'), 'to_do', and 'done'.
+ * @return bool Whether style is in the list.
+ */
+function wp_style_is( $handle, $list = 'enqueued' ) {
+       global $wp_styles;
+       if ( ! is_a( $wp_styles, 'WP_Styles' ) ) {
+               if ( ! did_action( 'init' ) )
+                       _doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+                               '<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>init</code>' ), '3.3' );
+               $wp_styles = new WP_Styles();
+       }
+
+       return (bool) $wp_styles->query( $handle, $list );
+}