云策 WordPress 开发者社区

函数文档

_get_dropins()

查看官方原文 ↗
💡 云策文档标注

概述

_get_dropins() 函数返回 WordPress 使用的 drop-in 插件列表，包括标准 drop-ins 和仅在多站点环境下可用的 drop-ins。

关键要点

  • 函数返回一个数组，键为文件名，值为包含 drop-in 插件描述和所需常量的数组。
  • 当 is_multisite() 返回 true 时，会包含多站点专用的 drop-ins，如 sunrise.php。
  • 每个 drop-in 插件的数据格式为数组，包含描述字符串和必须为 true 的常量名（或 true 表示无常量要求）。

代码示例

function _get_dropins() {
	$dropins = array(
		'advanced-cache.php'      => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ),
		'db.php'                  => array( __( 'Custom database class.' ), true ),
		'db-error.php'            => array( __( 'Custom database error message.' ), true ),
		'install.php'             => array( __( 'Custom installation script.' ), true ),
		'maintenance.php'         => array( __( 'Custom maintenance message.' ), true ),
		'object-cache.php'        => array( __( 'External object cache.' ), true ),
		'php-error.php'           => array( __( 'Custom PHP error message.' ), true ),
		'fatal-error-handler.php' => array( __( 'Custom PHP fatal error handler.' ), true ),
	);

	if ( is_multisite() ) {
		$dropins['sunrise.php']        = array( __( 'Executed before Multisite is loaded.' ), 'SUNRISE' );
		$dropins['blog-deleted.php']   = array( __( 'Custom site deleted message.' ), true );
		$dropins['blog-inactive.php']  = array( __( 'Custom site inactive message.' ), true );
		$dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true );
	}

	return $dropins;
}
📄 原文内容

Returns drop-in plugins that WordPress uses.

Description

Includes Multisite drop-ins only when is_multisite()

Return

array[] Key is file name. The value is an array of data about the drop-in.
  • ...$0 array
    Data about the drop-in.
    • 0 string
      The purpose of the drop-in.
    • 1 string|true
      Name of the constant that must be true for the drop-in to be used, or true if no constant is required.

Source

function _get_dropins() {
	$dropins = array(
		'advanced-cache.php'      => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ),  // WP_CACHE
		'db.php'                  => array( __( 'Custom database class.' ), true ),          // Auto on load.
		'db-error.php'            => array( __( 'Custom database error message.' ), true ),  // Auto on error.
		'install.php'             => array( __( 'Custom installation script.' ), true ),     // Auto on installation.
		'maintenance.php'         => array( __( 'Custom maintenance message.' ), true ),     // Auto on maintenance.
		'object-cache.php'        => array( __( 'External object cache.' ), true ),          // Auto on load.
		'php-error.php'           => array( __( 'Custom PHP error message.' ), true ),       // Auto on error.
		'fatal-error-handler.php' => array( __( 'Custom PHP fatal error handler.' ), true ), // Auto on error.
	);

	if ( is_multisite() ) {
		$dropins['sunrise.php']        = array( __( 'Executed before Multisite is loaded.' ), 'SUNRISE' ); // SUNRISE
		$dropins['blog-deleted.php']   = array( __( 'Custom site deleted message.' ), true );   // Auto on deleted blog.
		$dropins['blog-inactive.php']  = array( __( 'Custom site inactive message.' ), true );  // Auto on inactive blog.
		$dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true ); // Auto on archived or spammed blog.
	}

	return $dropins;
}

View all references View on Trac View on GitHub

UsesDescription
__()wp-includes/l10n.php

Retrieves the translation of $text.

is_multisite()wp-includes/load.php

Determines whether Multisite is enabled.

Used byDescription
WP_Debug_Data::get_wp_dropins()wp-admin/includes/class-wp-debug-data.php

Gets the WordPress drop-in section of the debug data.

WP_Plugins_List_Table::single_row()wp-admin/includes/class-wp-plugins-list-table.php
get_dropins()wp-admin/includes/plugin.php

Checks the wp-content directory and retrieve all drop-ins with any plugin data.

Changelog

VersionDescription
3.0.0Introduced.

User Contributed Notes

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