WordPress 4.5
[autoinstalls/wordpress.git] / wp-includes / functions.wp-styles.php
index 76ca28fac0114aeb6bb6e1a28b1585ab4ba27867..3c9d64939d9943bf8619dae13f1f98a7fb586c30 100644 (file)
@@ -1,11 +1,11 @@
 <?php
 /**
- * BackPress Styles Procedural API
+ * Dependencies API: Styles functions
  *
  * @since 2.6.0
  *
  * @package WordPress
- * @subpackage BackPress
+ * @subpackage Dependencies
  */
 
 /**
@@ -76,7 +76,7 @@ function wp_print_styles( $handles = false ) {
  *
  * @since 3.3.0
  *
- * @param string $handle Name of the stylesheet to add the extra styles to. Must be lowercase.
+ * @param string $handle Name of the stylesheet to add the extra styles to.
  * @param string $data   String containing the CSS styles to be added.
  * @return bool True on success, false on failure.
  */
@@ -98,20 +98,24 @@ function wp_add_inline_style( $handle, $data ) {
  * @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
  *
  * @since 2.6.0
- *
- * @param string      $handle Name of the stylesheet.
- * @param string|bool $src    Path to the stylesheet from the WordPress root directory. Example: '/css/mystyle.css'.
- * @param array       $deps   An array of registered style handles this stylesheet depends on. Default empty array.
- * @param string|bool $ver    String specifying the stylesheet version number. Used to ensure that the correct version
- *                            is sent to the client regardless of caching. Default 'false'. Accepts 'false', 'null', or 'string'.
- * @param string      $media  Optional. The media for which this stylesheet has been defined.
- *                            Default 'all'. Accepts 'all', 'aural', 'braille', 'handheld', 'projection', 'print',
- *                            'screen', 'tty', or 'tv'.
+ * @since 4.3.0 A return value was added.
+ *
+ * @param string           $handle Name of the stylesheet. Should be unique.
+ * @param string           $src    Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
+ * @param array            $deps   Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
+ * @param string|bool|null $ver    Optional. String specifying stylesheet version number, if it has one, which is added to the URL
+ *                                 as a query string for cache busting purposes. If version is set to false, a version
+ *                                 number is automatically added equal to current installed WordPress version.
+ *                                 If set to null, no version is added.
+ * @param string           $media  Optional. The media for which this stylesheet has been defined.
+ *                                 Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like
+ *                                 '(orientation: portrait)' and '(max-width: 640px)'.
+ * @return bool Whether the style has been registered. True on success, false on failure.
  */
 function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
        _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 
-       wp_styles()->add( $handle, $src, $deps, $ver, $media );
+       return wp_styles()->add( $handle, $src, $deps, $ver, $media );
 }
 
 /**
@@ -134,23 +138,24 @@ function wp_deregister_style( $handle ) {
  *
  * Registers the style if source provided (does NOT overwrite) and enqueues.
  *
- * @see WP_Dependencies::add(), WP_Dependencies::enqueue()
+ * @see WP_Dependencies::add()
+ * @see WP_Dependencies::enqueue()
  * @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
  *
  * @since 2.6.0
  *
- * @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   An array of registered style handles this stylesheet depends on. Default empty array.
- * @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  Optional. The media for which this stylesheet has been defined.
- *                            Default 'all'. Accepts 'all', 'aural', 'braille', 'handheld', 'projection', 'print',
- *                            'screen', 'tty', or 'tv'.
+ * @param string           $handle Name of the stylesheet. Should be unique.
+ * @param string           $src    Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
+ * @param array            $deps   Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
+ * @param string|bool|null $ver    Optional. String specifying stylesheet version number, if it has one, which is added to the URL
+ *                                 as a query string for cache busting purposes. If version is set to false, a version
+ *                                 number is automatically added equal to current installed WordPress version.
+ *                                 If set to null, no version is added.
+ * @param string           $media  Optional. The media for which this stylesheet has been defined.
+ *                                 Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like
+ *                                 '(orientation: portrait)' and '(max-width: 640px)'.
  */
 function wp_enqueue_style( $handle, $src = false, $deps = array(), $ver = false, $media = 'all' ) {
-       global $wp_styles;
        _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 
        $wp_styles = wp_styles();
@@ -180,8 +185,6 @@ function wp_dequeue_style( $handle ) {
 /**
  * Check whether a CSS stylesheet has been added to the queue.
  *
- * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
- *
  * @since 2.8.0
  *
  * @param string $handle Name of the stylesheet.