wp-includes/functions.wp-styles.php

   1 <?php
   2 /**
   3  * BackPress Styles Procedural API
   4  *
   5  * @since 2.6.0
   6  *
   7  * @package WordPress
   8  * @subpackage BackPress
   9  */
  10
  11 /**
  12  * Initialize $wp_styles if it has not been set.
  13  *
  14  * @global WP_Styles $wp_styles
  15  *
  16  * @since 4.2.0
  17  *
  18  * @return WP_Styles WP_Styles instance.
  19  */
  20 function wp_styles() {
  21         global $wp_styles;
  22         if ( ! ( $wp_styles instanceof WP_Styles ) ) {
  23                 $wp_styles = new WP_Styles();
  24         }
  25         return $wp_styles;
  26 }
  27
  28 /**
  29  * Display styles that are in the $handles queue.
  30  *
  31  * Passing an empty array to $handles prints the queue,
  32  * passing an array with one string prints that style,
  33  * and passing an array of strings prints those styles.
  34  *
  35  * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
  36  *
  37  * @since 2.6.0
  38  *
  39  * @param string|bool|array $handles Styles to be printed. Default 'false'.
  40  * @return array On success, a processed array of WP_Dependencies items; otherwise, an empty array.
  41  */
  42 function wp_print_styles( $handles = false ) {
  43         if ( '' === $handles ) { // for wp_head
  44                 $handles = false;
  45         }
  46         /**
  47          * Fires before styles in the $handles queue are printed.
  48          *
  49          * @since 2.6.0
  50          */
  51         if ( ! $handles ) {
  52                 do_action( 'wp_print_styles' );
  53         }
  54
  55         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
  56
  57         global $wp_styles;
  58         if ( ! ( $wp_styles instanceof WP_Styles ) ) {
  59                 if ( ! $handles ) {
  60                         return array(); // No need to instantiate if nothing is there.
  61                 }
  62         }
  63
  64         return wp_styles()->do_items( $handles );
  65 }
  66
  67 /**
  68  * Add extra CSS styles to a registered stylesheet.
  69  *
  70  * Styles will only be added if the stylesheet in already in the queue.
  71  * Accepts a string $data containing the CSS. If two or more CSS code blocks
  72  * are added to the same stylesheet $handle, they will be printed in the order
  73  * they were added, i.e. the latter added styles can redeclare the previous.
  74  *
  75  * @see WP_Styles::add_inline_style()
  76  *
  77  * @since 3.3.0
  78  *
  79  * @param string $handle Name of the stylesheet to add the extra styles to. Must be lowercase.
  80  * @param string $data   String containing the CSS styles to be added.
  81  * @return bool True on success, false on failure.
  82  */
  83 function wp_add_inline_style( $handle, $data ) {
  84         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
  85
  86         if ( false !== stripos( $data, '</style>' ) ) {
  87                 _doing_it_wrong( __FUNCTION__, __( 'Do not pass style tags to wp_add_inline_style().' ), '3.7' );
  88                 $data = trim( preg_replace( '#<style[^>]*>(.*)</style>#is', '$1', $data ) );
  89         }
  90
  91         return wp_styles()->add_inline_style( $handle, $data );
  92 }
  93
  94 /**
  95  * Register a CSS stylesheet.
  96  *
  97  * @see WP_Dependencies::add()
  98  * @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
  99  *
 100  * @since 2.6.0
 101  *
 102  * @param string      $handle Name of the stylesheet.
 103  * @param string|bool $src    Path to the stylesheet from the WordPress root directory. Example: '/css/mystyle.css'.
 104  * @param array       $deps   An array of registered style handles this stylesheet depends on. Default empty array.
 105  * @param string|bool $ver    String specifying the stylesheet version number. Used to ensure that the correct version
 106  *                            is sent to the client regardless of caching. Default 'false'. Accepts 'false', 'null', or 'string'.
 107  * @param string      $media  Optional. The media for which this stylesheet has been defined.
 108  *                            Default 'all'. Accepts 'all', 'aural', 'braille', 'handheld', 'projection', 'print',
 109  *                            'screen', 'tty', or 'tv'.
 110  */
 111 function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
 112         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 113
 114         wp_styles()->add( $handle, $src, $deps, $ver, $media );
 115 }
 116
 117 /**
 118  * Remove a registered stylesheet.
 119  *
 120  * @see WP_Dependencies::remove()
 121  *
 122  * @since 2.1.0
 123  *
 124  * @param string $handle Name of the stylesheet to be removed.
 125  */
 126 function wp_deregister_style( $handle ) {
 127         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 128
 129         wp_styles()->remove( $handle );
 130 }
 131
 132 /**
 133  * Enqueue a CSS stylesheet.
 134  *
 135  * Registers the style if source provided (does NOT overwrite) and enqueues.
 136  *
 137  * @see WP_Dependencies::add(), WP_Dependencies::enqueue()
 138  * @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
 139  *
 140  * @since 2.6.0
 141  *
 142  * @param string      $handle Name of the stylesheet.
 143  * @param string|bool $src    Path to the stylesheet from the root directory of WordPress. Example: '/css/mystyle.css'.
 144  * @param array       $deps   An array of registered style handles this stylesheet depends on. Default empty array.
 145  * @param string|bool $ver    String specifying the stylesheet version number, if it has one. This parameter is used
 146  *                            to ensure that the correct version is sent to the client regardless of caching, and so
 147  *                            should be included if a version number is available and makes sense for the stylesheet.
 148  * @param string      $media  Optional. The media for which this stylesheet has been defined.
 149  *                            Default 'all'. Accepts 'all', 'aural', 'braille', 'handheld', 'projection', 'print',
 150  *                            'screen', 'tty', or 'tv'.
 151  */
 152 function wp_enqueue_style( $handle, $src = false, $deps = array(), $ver = false, $media = 'all' ) {
 153         global $wp_styles;
 154         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 155
 156         $wp_styles = wp_styles();
 157
 158         if ( $src ) {
 159                 $_handle = explode('?', $handle);
 160                 $wp_styles->add( $_handle[0], $src, $deps, $ver, $media );
 161         }
 162         $wp_styles->enqueue( $handle );
 163 }
 164
 165 /**
 166  * Remove a previously enqueued CSS stylesheet.
 167  *
 168  * @see WP_Dependencies::dequeue()
 169  *
 170  * @since 3.1.0
 171  *
 172  * @param string $handle Name of the stylesheet to be removed.
 173  */
 174 function wp_dequeue_style( $handle ) {
 175         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 176
 177         wp_styles()->dequeue( $handle );
 178 }
 179
 180 /**
 181  * Check whether a CSS stylesheet has been added to the queue.
 182  *
 183  * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
 184  *
 185  * @since 2.8.0
 186  *
 187  * @param string $handle Name of the stylesheet.
 188  * @param string $list   Optional. Status of the stylesheet to check. Default 'enqueued'.
 189  *                       Accepts 'enqueued', 'registered', 'queue', 'to_do', and 'done'.
 190  * @return bool Whether style is queued.
 191  */
 192 function wp_style_is( $handle, $list = 'enqueued' ) {
 193         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 194
 195         return (bool) wp_styles()->query( $handle, $list );
 196 }
 197
 198 /**
 199  * Add metadata to a CSS stylesheet.
 200  *
 201  * Works only if the stylesheet has already been added.
 202  *
 203  * Possible values for $key and $value:
 204  * 'conditional' string      Comments for IE 6, lte IE 7 etc.
 205  * 'rtl'         bool|string To declare an RTL stylesheet.
 206  * 'suffix'      string      Optional suffix, used in combination with RTL.
 207  * 'alt'         bool        For rel="alternate stylesheet".
 208  * 'title'       string      For preferred/alternate stylesheets.
 209  *
 210  * @see WP_Dependency::add_data()
 211  *
 212  * @since 3.6.0
 213  *
 214  * @param string $handle Name of the stylesheet.
 215  * @param string $key    Name of data point for which we're storing a value.
 216  *                       Accepts 'conditional', 'rtl' and 'suffix', 'alt' and 'title'.
 217  * @param mixed  $value  String containing the CSS data to be added.
 218  * @return bool True on success, false on failure.
 219  */
 220 function wp_style_add_data( $handle, $key, $value ) {
 221         return wp_styles()->add_data( $handle, $key, $value );
 222 }