wppaste
WordPress

WP_Plugin_Dependencies::sanitize_dependency_slugs( string $slugs ): array

Since
6.5.0
Source
wp-includes/class-wp-plugin-dependencies.php:579
Sanitizes slugs.

Compatibility

WordPress
since 6.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$slugsstring
A comma-separated string of plugin dependency slugs.

Return value

array
An array of sanitized plugin dependency slugs.

Performance profile

How much work a call to WP_Plugin_Dependencies::sanitize_dependency_slugs() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Light

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
17–18

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 30.

Plugin surface
1 hook

Third-party callbacks on 'wp_plugin_dependencies_slug' run inside this call, and their cost is not bounded by anything here.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Plugin_Dependencies::sanitize_dependency_slugs() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always17–18explode(), array_unique(), sort()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev3017–183
8.53017–183
8.43017–1835 fewer instructions than PHP 8.3
8.33517–183
8.23517–183
8.13517–183
7.43517–183

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

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

  1. apply_filters( wp_plugin_dependencies_slug )filterline 596 (+17 into the body)

    Filters a plugin dependency's slug before matching to the WordPress.org slug format.

Uses · 1

  • apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

Source code

	protected static function sanitize_dependency_slugs( $slugs ) {		$sanitized_slugs = array();		$slugs           = explode( ',', $slugs ); 		foreach ( $slugs as $slug ) {			$slug = trim( $slug ); 			/**			 * Filters a plugin dependency's slug before matching to			 * the WordPress.org slug format.			 *			 * Can be used to switch between free and premium plugin slugs, for example.			 *			 * @since 6.5.0			 *			 * @param string $slug The slug.			 */			$slug = apply_filters( 'wp_plugin_dependencies_slug', $slug ); 			// Match to WordPress.org slug format.			if ( preg_match( '/^[a-z0-9]+(-[a-z0-9]+)*$/mu', $slug ) ) {				$sanitized_slugs[] = $slug;			}		}		$sanitized_slugs = array_unique( $sanitized_slugs );		sort( $sanitized_slugs ); 		return $sanitized_slugs;	}

Changelog

Introduced in 6.5.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 7.1.0 tag, from src/wp-includes/class-wp-plugin-dependencies.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.