<?php
/**
- * BackPress Styles Procedural API
+ * Dependencies API: Styles functions
*
* @since 2.6.0
*
* @package WordPress
- * @subpackage BackPress
+ * @subpackage Dependencies
*/
+/**
+ * Initialize $wp_styles if it has not been set.
+ *
+ * @global WP_Styles $wp_styles
+ *
+ * @since 4.2.0
+ *
+ * @return WP_Styles WP_Styles instance.
+ */
+function wp_styles() {
+ global $wp_styles;
+ if ( ! ( $wp_styles instanceof WP_Styles ) ) {
+ $wp_styles = new WP_Styles();
+ }
+ return $wp_styles;
+}
+
/**
* Display styles that are in the $handles queue.
*
*
* @since 2.6.0
*
- * @param array|bool $handles Styles to be printed. Default 'false'.
+ * @param string|bool|array $handles Styles to be printed. Default 'false'.
* @return array On success, a processed array of WP_Dependencies items; otherwise, an empty array.
*/
function wp_print_styles( $handles = false ) {
- if ( '' === $handles ) // for wp_head
+ if ( '' === $handles ) { // for wp_head
$handles = false;
+ }
/**
* Fires before styles in the $handles queue are printed.
*
* @since 2.6.0
*/
- if ( ! $handles )
+ if ( ! $handles ) {
do_action( 'wp_print_styles' );
+ }
- 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>login_enqueue_scripts</code>' ), '3.3' );
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
- if ( !$handles )
+ global $wp_styles;
+ if ( ! ( $wp_styles instanceof WP_Styles ) ) {
+ if ( ! $handles ) {
return array(); // No need to instantiate if nothing is there.
- else
- $wp_styles = new WP_Styles();
+ }
}
- return $wp_styles->do_items( $handles );
+ return wp_styles()->do_items( $handles );
}
/**
* they were added, i.e. the latter added styles can redeclare the previous.
*
* @see WP_Styles::add_inline_style()
- * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
*
* @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.
*/
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>login_enqueue_scripts</code>' ), '3.3' );
- $wp_styles = new WP_Styles();
- }
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
if ( false !== stripos( $data, '</style>' ) ) {
- _doing_it_wrong( __FUNCTION__, 'Do not pass style tags to wp_add_inline_style().', '3.7' );
+ _doing_it_wrong( __FUNCTION__, __( 'Do not pass style tags to wp_add_inline_style().' ), '3.7' );
$data = trim( preg_replace( '#<style[^>]*>(.*)</style>#is', '$1', $data ) );
}
- return $wp_styles->add_inline_style( $handle, $data );
+ return wp_styles()->add_inline_style( $handle, $data );
}
/**
*
* @see WP_Dependencies::add()
* @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
- * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
*
* @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' ) {
- 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>login_enqueue_scripts</code>' ), '3.3' );
- $wp_styles = new WP_Styles();
- }
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
- $wp_styles->add( $handle, $src, $deps, $ver, $media );
+ return wp_styles()->add( $handle, $src, $deps, $ver, $media );
}
/**
* Remove a registered stylesheet.
*
* @see WP_Dependencies::remove()
- * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
*
* @since 2.1.0
*
* @param string $handle Name of the stylesheet to be removed.
*/
function wp_deregister_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>login_enqueue_scripts</code>' ), '3.3' );
- $wp_styles = new WP_Styles();
- }
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
- $wp_styles->remove( $handle );
+ wp_styles()->remove( $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.
- * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
*
* @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;
- 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>login_enqueue_scripts</code>' ), '3.3' );
- $wp_styles = new WP_Styles();
- }
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
+
+ $wp_styles = wp_styles();
if ( $src ) {
$_handle = explode('?', $handle);
* Remove a previously enqueued CSS stylesheet.
*
* @see WP_Dependencies::dequeue()
- * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
*
* @since 3.1.0
*
* @param string $handle Name of the stylesheet to be removed.
*/
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>login_enqueue_scripts</code>' ), '3.3' );
- $wp_styles = new WP_Styles();
- }
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
- $wp_styles->dequeue( $handle );
+ wp_styles()->dequeue( $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.
* @return bool Whether style is queued.
*/
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>login_enqueue_scripts</code>' ), '3.3' );
- $wp_styles = new WP_Styles();
- }
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
- return (bool) $wp_styles->query( $handle, $list );
+ return (bool) wp_styles()->query( $handle, $list );
}
/**
* @param string $handle Name of the stylesheet.
* @param string $key Name of data point for which we're storing a value.
* Accepts 'conditional', 'rtl' and 'suffix', 'alt' and 'title'.
- * @param mixed $data String containing the CSS data to be added.
+ * @param mixed $value String containing the CSS data to be added.
* @return bool True on success, false on failure.
*/
function wp_style_add_data( $handle, $key, $value ) {
- global $wp_styles;
- return $wp_styles->add_data( $handle, $key, $value );
+ return wp_styles()->add_data( $handle, $key, $value );
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff