wp_register_style( string $handle, string|false $src, string[] $deps = array(), string|bool|null $ver = false, string $media = 'all' ): bool

Register a CSS stylesheet.

Contents

Description

Top ↑

See also

Top ↑

Parameters

$handle string Required
Name of the stylesheet. Should be unique.
$src string|false Required
Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
If source is set to false, stylesheet is an alias of other stylesheets it depends on.
$deps string[] Optional
An array of registered stylesheet handles this stylesheet depends on.

Default: array()

$ver string|bool|null 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.

Default: false

$media string 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)'.

Default: 'all'

Top ↑

Return

bool Whether the style has been registered. True on success, false on failure.

Top ↑

Source

File: wp-includes/functions.wp-styles.php. View all references 

function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
	_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );

	return wp_styles()->add( $handle, $src, $deps, $ver, $media );
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
wp_styles() wp-includes/functions.wp-styles.php

Initialize $wp_styles if it has not been set.

Top ↑

Used By

Used By
Used By Description
wp_enqueue_classic_theme_styles() wp-includes/script-loader.php

Loads classic theme styles on classic themes in the frontend.
wp_enqueue_stored_styles() wp-includes/script-loader.php

Fetches, processes and compiles stored core styles, then combines and renders them to the page.
_wp_theme_json_webfonts_handler() wp-includes/script-loader.php

Runs the theme.json webfonts handler.
wp_enqueue_global_styles_css_custom_properties() wp-includes/script-loader.php

Function that enqueues the CSS Custom Properties coming from theme.json.
wp_enqueue_block_style() wp-includes/script-loader.php

Enqueues a stylesheet for a specific block.
wp_enqueue_global_styles() wp-includes/script-loader.php

Enqueues the global styles defined via theme.json.
register_block_style_handle() wp-includes/blocks.php

Finds a style handle for the block metadata field. It detects when a path to file was provided and registers the style under automatically generated handle name. It returns unprocessed style handle otherwise.
Show 2 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
4.3.0 A return value was added.
2.6.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note
    Contributed by Ivan Shulev —

    Examples
    In a Plugin (outside a PHP class)

    Assumes the Plugin directory is named ‘my-plugin’.
    Assumes the Plugin style sheet is named ‘plugin.css’.

    /**
 * Registers a stylesheet.
 */
function wpdocs_register_plugin_styles() {
	wp_register_style( 'my-plugin', plugins_url( 'my-plugin/css/plugin.css' ) );
	wp_enqueue_style( 'my-plugin' );
}
// Register style sheet.
add_action( 'wp_enqueue_scripts', 'wpdocs_register_plugin_styles' );
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
    Contributed by Ivan Shulev —

    Example
    In a plugin (inside a PHP class)

    Assumes the Plugin class name is ‘my_plugin’.
    Assumes the Plugin directory is named ‘my-plugin’.
    Assumes the Plugin style sheet is named ‘plugin.css’.

    class WPDocs_My_Plugin_Stylesheet {

	/**
	 * Constructor.
	 */
	function __construct() {
		// Register stylesheet.
		add_action( 'wp_enqueue_scripts', array( $this, 'register_plugin_styles' ) );
	}

	/**
	 * Registers and enqueues stylesheet.
	 */
	public function register_plugin_styles() {
		wp_register_style( 'my-plugin', plugins_url( 'my-plugin/css/plugin.css' ) );
		wp_enqueue_style( 'my-plugin' );
	}
}
new WPDocs_My_Plugin_Stylesheet();
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by crstauf —

    Note that Google Fonts has changed their URLs, so when embedding multiple font families only one will be loaded. The change is “fundamentally incompatible with how the rest of the world uses query variables and thus PHP itself”.

    The fix is to set null on the $version parameter, which prevents the URL from being parsed and the additional font families lost.

    Trac ticket: https://core.trac.wordpress.org/ticket/49742

You must log in before being able to contribute a note or feedback.