mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-22 17:18:32 +01:00
dcb08f0637
Hook documentation should be on the line directly above the line containing the `do_action()` or `apply_filters()` call. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of duplicate hook references. Includes minor code layout fixes. See #47110. Built from https://develop.svn.wordpress.org/trunk@46088 git-svn-id: http://core.svn.wordpress.org/trunk@45900 1a063a9b-81f0-0310-95a4-ce76da25c4cd
413 lines
9.7 KiB
PHP
413 lines
9.7 KiB
PHP
<?php
|
|
/**
|
|
* Dependencies API: WP_Styles class
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Dependencies
|
|
*/
|
|
|
|
/**
|
|
* Core class used to register styles.
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @see WP_Dependencies
|
|
*/
|
|
class WP_Styles extends WP_Dependencies {
|
|
/**
|
|
* Base URL for styles.
|
|
*
|
|
* Full URL with trailing slash.
|
|
*
|
|
* @since 2.6.0
|
|
* @var string
|
|
*/
|
|
public $base_url;
|
|
|
|
/**
|
|
* URL of the content directory.
|
|
*
|
|
* @since 2.8.0
|
|
* @var string
|
|
*/
|
|
public $content_url;
|
|
|
|
/**
|
|
* Default version string for stylesheets.
|
|
*
|
|
* @since 2.6.0
|
|
* @var string
|
|
*/
|
|
public $default_version;
|
|
|
|
/**
|
|
* The current text direction.
|
|
*
|
|
* @since 2.6.0
|
|
* @var string
|
|
*/
|
|
public $text_direction = 'ltr';
|
|
|
|
/**
|
|
* Holds a list of style handles which will be concatenated.
|
|
*
|
|
* @since 2.8.0
|
|
* @var string
|
|
*/
|
|
public $concat = '';
|
|
|
|
/**
|
|
* Holds a string which contains style handles and their version.
|
|
*
|
|
* @since 2.8.0
|
|
* @deprecated 3.4.0
|
|
* @var string
|
|
*/
|
|
public $concat_version = '';
|
|
|
|
/**
|
|
* Whether to perform concatenation.
|
|
*
|
|
* @since 2.8.0
|
|
* @var bool
|
|
*/
|
|
public $do_concat = false;
|
|
|
|
/**
|
|
* Holds HTML markup of styles and additional data if concatenation
|
|
* is enabled.
|
|
*
|
|
* @since 2.8.0
|
|
* @var string
|
|
*/
|
|
public $print_html = '';
|
|
|
|
/**
|
|
* Holds inline styles if concatenation is enabled.
|
|
*
|
|
* @since 3.3.0
|
|
* @var string
|
|
*/
|
|
public $print_code = '';
|
|
|
|
/**
|
|
* List of default directories.
|
|
*
|
|
* @since 2.8.0
|
|
* @var array
|
|
*/
|
|
public $default_dirs;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @since 2.6.0
|
|
*/
|
|
public function __construct() {
|
|
/**
|
|
* Fires when the WP_Styles instance is initialized.
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @param WP_Styles $this WP_Styles instance (passed by reference).
|
|
*/
|
|
do_action_ref_array( 'wp_default_styles', array( &$this ) );
|
|
}
|
|
|
|
/**
|
|
* Processes a style dependency.
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @see WP_Dependencies::do_item()
|
|
*
|
|
* @param string $handle The style's registered handle.
|
|
* @return bool True on success, false on failure.
|
|
*/
|
|
public function do_item( $handle ) {
|
|
if ( ! parent::do_item( $handle ) ) {
|
|
return false;
|
|
}
|
|
|
|
$obj = $this->registered[ $handle ];
|
|
|
|
if ( null === $obj->ver ) {
|
|
$ver = '';
|
|
} else {
|
|
$ver = $obj->ver ? $obj->ver : $this->default_version;
|
|
}
|
|
|
|
if ( isset( $this->args[ $handle ] ) ) {
|
|
$ver = $ver ? $ver . '&' . $this->args[ $handle ] : $this->args[ $handle ];
|
|
}
|
|
|
|
$src = $obj->src;
|
|
$cond_before = '';
|
|
$cond_after = '';
|
|
$conditional = isset( $obj->extra['conditional'] ) ? $obj->extra['conditional'] : '';
|
|
|
|
if ( $conditional ) {
|
|
$cond_before = "<!--[if {$conditional}]>\n";
|
|
$cond_after = "<![endif]-->\n";
|
|
}
|
|
|
|
$inline_style = $this->print_inline_style( $handle, false );
|
|
|
|
if ( $inline_style ) {
|
|
$inline_style_tag = sprintf( "<style id='%s-inline-css' type='text/css'>\n%s\n</style>\n", esc_attr( $handle ), $inline_style );
|
|
} else {
|
|
$inline_style_tag = '';
|
|
}
|
|
|
|
if ( $this->do_concat ) {
|
|
if ( $this->in_default_dir( $src ) && ! $conditional && ! isset( $obj->extra['alt'] ) ) {
|
|
$this->concat .= "$handle,";
|
|
$this->concat_version .= "$handle$ver";
|
|
|
|
$this->print_code .= $inline_style;
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
if ( isset( $obj->args ) ) {
|
|
$media = esc_attr( $obj->args );
|
|
} else {
|
|
$media = 'all';
|
|
}
|
|
|
|
// A single item may alias a set of items, by having dependencies, but no source.
|
|
if ( ! $src ) {
|
|
if ( $inline_style_tag ) {
|
|
if ( $this->do_concat ) {
|
|
$this->print_html .= $inline_style_tag;
|
|
} else {
|
|
echo $inline_style_tag;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
$href = $this->_css_href( $src, $ver, $handle );
|
|
if ( ! $href ) {
|
|
return true;
|
|
}
|
|
|
|
$rel = isset( $obj->extra['alt'] ) && $obj->extra['alt'] ? 'alternate stylesheet' : 'stylesheet';
|
|
$title = isset( $obj->extra['title'] ) ? "title='" . esc_attr( $obj->extra['title'] ) . "'" : '';
|
|
|
|
$tag = "<link rel='$rel' id='$handle-css' $title href='$href' type='text/css' media='$media' />\n";
|
|
|
|
/**
|
|
* Filters the HTML link tag of an enqueued style.
|
|
*
|
|
* @since 2.6.0
|
|
* @since 4.3.0 Introduced the `$href` parameter.
|
|
* @since 4.5.0 Introduced the `$media` parameter.
|
|
*
|
|
* @param string $html The link tag for the enqueued style.
|
|
* @param string $handle The style's registered handle.
|
|
* @param string $href The stylesheet's source URL.
|
|
* @param string $media The stylesheet's media attribute.
|
|
*/
|
|
$tag = apply_filters( 'style_loader_tag', $tag, $handle, $href, $media );
|
|
|
|
if ( 'rtl' === $this->text_direction && isset( $obj->extra['rtl'] ) && $obj->extra['rtl'] ) {
|
|
if ( is_bool( $obj->extra['rtl'] ) || 'replace' === $obj->extra['rtl'] ) {
|
|
$suffix = isset( $obj->extra['suffix'] ) ? $obj->extra['suffix'] : '';
|
|
$rtl_href = str_replace( "{$suffix}.css", "-rtl{$suffix}.css", $this->_css_href( $src, $ver, "$handle-rtl" ) );
|
|
} else {
|
|
$rtl_href = $this->_css_href( $obj->extra['rtl'], $ver, "$handle-rtl" );
|
|
}
|
|
|
|
$rtl_tag = "<link rel='$rel' id='$handle-rtl-css' $title href='$rtl_href' type='text/css' media='$media' />\n";
|
|
/** This filter is documented in wp-includes/class.wp-styles.php */
|
|
$rtl_tag = apply_filters( 'style_loader_tag', $rtl_tag, $handle, $rtl_href, $media );
|
|
|
|
if ( $obj->extra['rtl'] === 'replace' ) {
|
|
$tag = $rtl_tag;
|
|
} else {
|
|
$tag .= $rtl_tag;
|
|
}
|
|
}
|
|
|
|
if ( $this->do_concat ) {
|
|
$this->print_html .= $cond_before;
|
|
$this->print_html .= $tag;
|
|
if ( $inline_style_tag ) {
|
|
$this->print_html .= $inline_style_tag;
|
|
}
|
|
$this->print_html .= $cond_after;
|
|
} else {
|
|
echo $cond_before;
|
|
echo $tag;
|
|
$this->print_inline_style( $handle );
|
|
echo $cond_after;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Adds extra CSS styles to a registered stylesheet.
|
|
*
|
|
* @since 3.3.0
|
|
*
|
|
* @param string $handle The style's registered handle.
|
|
* @param string $code String containing the CSS styles to be added.
|
|
* @return bool True on success, false on failure.
|
|
*/
|
|
public function add_inline_style( $handle, $code ) {
|
|
if ( ! $code ) {
|
|
return false;
|
|
}
|
|
|
|
$after = $this->get_data( $handle, 'after' );
|
|
if ( ! $after ) {
|
|
$after = array();
|
|
}
|
|
|
|
$after[] = $code;
|
|
|
|
return $this->add_data( $handle, 'after', $after );
|
|
}
|
|
|
|
/**
|
|
* Prints extra CSS styles of a registered stylesheet.
|
|
*
|
|
* @since 3.3.0
|
|
*
|
|
* @param string $handle The style's registered handle.
|
|
* @param bool $echo Optional. Whether to echo the inline style instead of just returning it.
|
|
* Default true.
|
|
* @return string|bool False if no data exists, inline styles if `$echo` is true, true otherwise.
|
|
*/
|
|
public function print_inline_style( $handle, $echo = true ) {
|
|
$output = $this->get_data( $handle, 'after' );
|
|
|
|
if ( empty( $output ) ) {
|
|
return false;
|
|
}
|
|
|
|
$output = implode( "\n", $output );
|
|
|
|
if ( ! $echo ) {
|
|
return $output;
|
|
}
|
|
|
|
printf( "<style id='%s-inline-css' type='text/css'>\n%s\n</style>\n", esc_attr( $handle ), $output );
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Determines style dependencies.
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @see WP_Dependencies::all_deps()
|
|
*
|
|
* @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
|
|
* @param bool $recursion Internal flag that function is calling itself.
|
|
* @param int|false $group Group level: (int) level, (false) no groups.
|
|
* @return bool True on success, false on failure.
|
|
*/
|
|
public function all_deps( $handles, $recursion = false, $group = false ) {
|
|
$r = parent::all_deps( $handles, $recursion, $group );
|
|
if ( ! $recursion ) {
|
|
/**
|
|
* Filters the array of enqueued styles before processing for output.
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @param string[] $to_do The list of enqueued style handles about to be processed.
|
|
*/
|
|
$this->to_do = apply_filters( 'print_styles_array', $this->to_do );
|
|
}
|
|
return $r;
|
|
}
|
|
|
|
/**
|
|
* Generates an enqueued style's fully-qualified URL.
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @param string $src The source of the enqueued style.
|
|
* @param string $ver The version of the enqueued style.
|
|
* @param string $handle The style's registered handle.
|
|
* @return string Style's fully-qualified URL.
|
|
*/
|
|
public function _css_href( $src, $ver, $handle ) {
|
|
if ( ! is_bool( $src ) && ! preg_match( '|^(https?:)?//|', $src ) && ! ( $this->content_url && 0 === strpos( $src, $this->content_url ) ) ) {
|
|
$src = $this->base_url . $src;
|
|
}
|
|
|
|
if ( ! empty( $ver ) ) {
|
|
$src = add_query_arg( 'ver', $ver, $src );
|
|
}
|
|
|
|
/**
|
|
* Filters an enqueued style's fully-qualified URL.
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @param string $src The source URL of the enqueued style.
|
|
* @param string $handle The style's registered handle.
|
|
*/
|
|
$src = apply_filters( 'style_loader_src', $src, $handle );
|
|
return esc_url( $src );
|
|
}
|
|
|
|
/**
|
|
* Whether a handle's source is in a default directory.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @param string $src The source of the enqueued style.
|
|
* @return bool True if found, false if not.
|
|
*/
|
|
public function in_default_dir( $src ) {
|
|
if ( ! $this->default_dirs ) {
|
|
return true;
|
|
}
|
|
|
|
foreach ( (array) $this->default_dirs as $test ) {
|
|
if ( 0 === strpos( $src, $test ) ) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Processes items and dependencies for the footer group.
|
|
*
|
|
* HTML 5 allows styles in the body, grab late enqueued items and output them in the footer.
|
|
*
|
|
* @since 3.3.0
|
|
*
|
|
* @see WP_Dependencies::do_items()
|
|
*
|
|
* @return array Handles of items that have been processed.
|
|
*/
|
|
public function do_footer_items() {
|
|
$this->do_items( false, 1 );
|
|
return $this->done;
|
|
}
|
|
|
|
/**
|
|
* Resets class properties.
|
|
*
|
|
* @since 3.3.0
|
|
*/
|
|
public function reset() {
|
|
$this->do_concat = false;
|
|
$this->concat = '';
|
|
$this->concat_version = '';
|
|
$this->print_html = '';
|
|
}
|
|
}
|