Changeset 12531

Timestamp:

12/24/2009 08:21:16 AM (15 years ago)

Author:

westi

Message:

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

File:

• trunk/wp-includes/functions.wp-styles.php (modified) (5 diffs)

trunk/wp-includes/functions.wp-styles.php

@@ -14 +14 @@
  * @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.
  */
@@ -37 +38 @@
  *
  * @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' ) {
@@ -51 +63 @@
  *
  * @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 ) {
@@ -66 +81 @@
  * @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 ) {
@@ -82 +108 @@
  * 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' ) {