_get_dropins(): array[]

Description

Compatibility

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

Return value

array[]

Key is file name. The value is an array of data about the drop-in.

• ...$0array

  Data about the drop-in.

  • $0string

    The purpose of the drop-in.

  • $1string|true

    Name of the constant that must be true for the drop-in to be used, or true if no constant is required.

Performance profile

How much work a call to _get_dropins() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

53–81

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

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

What one call costs · 2 distinct outcomes

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

Uses · 2

• __()Retrieves the translation of $text.
• is_multisite()Determines whether Multisite is enabled.

Used by · 3

• WP_Debug_Data::get_wp_dropins()Gets the WordPress drop-in section of the debug data.
• WP_Plugins_List_Table::single_row()
• get_dropins()Checks the wp-content directory and retrieve all drop-ins with any plugin data.

Source code

View on Trac ↗View on GitHub ↗

500function _get_dropins() {501	$dropins = array(502		'advanced-cache.php'      => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ),  // WP_CACHE503		'db.php'                  => array( __( 'Custom database class.' ), true ),          // Auto on load.504		'db-error.php'            => array( __( 'Custom database error message.' ), true ),  // Auto on error.505		'install.php'             => array( __( 'Custom installation script.' ), true ),     // Auto on installation.506		'maintenance.php'         => array( __( 'Custom maintenance message.' ), true ),     // Auto on maintenance.507		'object-cache.php'        => array( __( 'External object cache.' ), true ),          // Auto on load.508		'php-error.php'           => array( __( 'Custom PHP error message.' ), true ),       // Auto on error.509		'fatal-error-handler.php' => array( __( 'Custom PHP fatal error handler.' ), true ), // Auto on error.510	);511 512	if ( is_multisite() ) {513		$dropins['sunrise.php']        = array( __( 'Executed before Multisite is loaded.' ), 'SUNRISE' ); // SUNRISE514		$dropins['blog-deleted.php']   = array( __( 'Custom site deleted message.' ), true );   // Auto on deleted blog.515		$dropins['blog-inactive.php']  = array( __( 'Custom site inactive message.' ), true );  // Auto on inactive blog.516		$dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true ); // Auto on archived or spammed blog.517	}518 519	return $dropins;520}

Changelog

Introduced in 3.0.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-admin/includes/plugin.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.