plugins_url( string $path = '', string $plugin = '' ): string

Description

Parameters

$pathstringoptional

Extra path appended to the end of the URL, including the relative directory if $plugin is supplied. Default empty.Default: ''

$pluginstringoptional

A full path to a file inside a plugin or mu-plugin. The URL will be relative to its directory. Default empty. Typically this is done by passing __FILE__ as the argument.Default: ''

Return

string

Plugins URL link with optional paths appended.

Hooks fired · 1

One hook fires while plugins_url() runs, in this order:

1. 1
   apply_filters( plugins_url )filterline 3711 (+36 into the body)

   Filters the URL to the plugins directory.

Uses · 5

• wp_normalize_path()Normalizes a filesystem path.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• set_url_scheme()Sets the scheme for a URL.
• plugin_basename()Gets the basename of a plugin.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 5

• WP_URL_Pattern_Prefixer::get_default_contexts()Returns the default contexts used by the class.
• get_block_asset_url()Gets the URL to a block asset.
• get_theme_root_uri()Retrieves URI for themes directory.
• load_script_textdomain()Loads the script translated strings.
• plugin_dir_url()Get the URL directory path (with trailing slash) for the plugin __FILE__ passed in.

Source

View on Trac ↗View on GitHub ↗

3675function plugins_url( $path = '', $plugin = '' ) {3676 3677	$path          = wp_normalize_path( $path );3678	$plugin        = wp_normalize_path( $plugin );3679	$mu_plugin_dir = wp_normalize_path( WPMU_PLUGIN_DIR );3680 3681	if ( ! empty( $plugin ) && str_starts_with( $plugin, $mu_plugin_dir ) ) {3682		$url = WPMU_PLUGIN_URL;3683	} else {3684		$url = WP_PLUGIN_URL;3685	}3686 3687	$url = set_url_scheme( $url );3688 3689	if ( ! empty( $plugin ) && is_string( $plugin ) ) {3690		$folder = dirname( plugin_basename( $plugin ) );3691		if ( '.' !== $folder ) {3692			$url .= '/' . ltrim( $folder, '/' );3693		}3694	}3695 3696	if ( $path && is_string( $path ) ) {3697		$url .= '/' . ltrim( $path, '/' );3698	}3699 3700	/**3701	 * Filters the URL to the plugins directory.3702	 *3703	 * @since 2.8.03704	 *3705	 * @param string $url    The complete URL to the plugins directory including scheme and path.3706	 * @param string $path   Path relative to the URL to the plugins directory. Blank string3707	 *                       if no path is specified.3708	 * @param string $plugin The plugin file path to be relative to. Blank string if no plugin3709	 *                       is specified.3710	 */3711	return apply_filters( 'plugins_url', $url, $path, $plugin );3712}

History

Introduced in 2.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.