Changeset 7994

Timestamp:

05/25/2008 09:23:22 PM (17 years ago)

Author:

ryan

Message:

inline docs for wp_admin_css(). Props mdawaffe. see #7033

File:

• trunk/wp-includes/general-template.php (modified) (3 diffs)

trunk/wp-includes/general-template.php

@@ -1128 +1128 @@
 }
 
+/**
+ * wp_admin_css_uri() - Outputs the URL of a WordPress admin CSS file
+ *
+ * @see WP_Styles::_css_href and its style_loader_src filter.
+ *
+ * @param string $file file relative to wp-admin/ without its ".css" extension.
+ */
+
 function wp_admin_css_uri( $file = 'wp-admin' ) {
     if ( defined('WP_INSTALLING') ) {
@@ -1139 +1147 @@
 }
 
+/**
+ * wp_admin_css() - Enqueues or directly prints a stylesheet link to the specified CSS file.
+ *
+ * "Intelligently" decides to enqueue or to print the CSS file.
+ * If the wp_print_styles action has *not* yet been called, the CSS file will be enqueued.
+ * If the wp_print_styles action *has* been called, the CSS link will be printed.
+ * Printing may be forced by passing TRUE as the $force_echo (second) parameter.
+ *
+ * For backward compatibility with WordPress 2.3 calling method:
+ * If the $file (first) parameter does not correspond to a registered CSS file, we assume $file is a
+ * file relative to wp-admin/ without its ".css" extension.  A stylesheet link to that generated URL is printed.
+ *
+ * @package WordPress
+ * @since 2.3
+ *
+ * @uses $wp_styles WordPress Styles Object
+ *
+ * @param string $file Style handle name or file name (without ".css" extension) relative to wp-admin/
+ * @param bool $force_echo Optional.  Force the stylesheet link to be printed rather than enqueued.
+ */
+
 function wp_admin_css( $file = 'wp-admin', $force_echo = false ) {
     global $wp_styles;
@@ -1144 +1173 @@
         $wp_styles = new WP_Styles();
 
+    // For backward compatibility
     $handle = 0 === strpos( $file, 'css/' ) ? substr( $file, 4 ) : $file;