Docs: Document the usage of $_paused_plugins and $_paused_themes globals.

Follow-up to [44973].

Props upadalavipul, sabernhardt.
See #60021.
Built from https://develop.svn.wordpress.org/trunk@57772


git-svn-id: http://core.svn.wordpress.org/trunk@57273 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2024-03-05 11:43:13 +00:00
parent 1562e99f44
commit 6e89ac85c6
4 changed files with 17 additions and 3 deletions

View File

@ -2457,6 +2457,8 @@ function wp_add_privacy_policy_content( $plugin_name, $policy_text ) {
* *
* @since 5.2.0 * @since 5.2.0
* *
* @global WP_Paused_Extensions_Storage $_paused_plugins
*
* @param string $plugin Path to the plugin file relative to the plugins directory. * @param string $plugin Path to the plugin file relative to the plugins directory.
* @return bool True, if in the list of paused plugins. False, if not in the list. * @return bool True, if in the list of paused plugins. False, if not in the list.
*/ */
@ -2479,6 +2481,8 @@ function is_plugin_paused( $plugin ) {
* *
* @since 5.2.0 * @since 5.2.0
* *
* @global WP_Paused_Extensions_Storage $_paused_plugins
*
* @param string $plugin Path to the plugin file relative to the plugins directory. * @param string $plugin Path to the plugin file relative to the plugins directory.
* @return array|false Array of error information as returned by `error_get_last()`, * @return array|false Array of error information as returned by `error_get_last()`,
* or false if none was recorded. * or false if none was recorded.
@ -2553,7 +2557,8 @@ function resume_plugin( $plugin, $redirect = '' ) {
* *
* @since 5.2.0 * @since 5.2.0
* *
* @global string $pagenow The filename of the current screen. * @global string $pagenow The filename of the current screen.
* @global WP_Paused_Extensions_Storage $_paused_plugins
*/ */
function paused_plugins_notice() { function paused_plugins_notice() {
if ( 'plugins.php' === $GLOBALS['pagenow'] ) { if ( 'plugins.php' === $GLOBALS['pagenow'] ) {

View File

@ -1111,6 +1111,8 @@ function customize_themes_print_templates() {
* *
* @since 5.2.0 * @since 5.2.0
* *
* @global WP_Paused_Extensions_Storage $_paused_themes
*
* @param string $theme Path to the theme directory relative to the themes directory. * @param string $theme Path to the theme directory relative to the themes directory.
* @return bool True, if in the list of paused themes. False, not in the list. * @return bool True, if in the list of paused themes. False, not in the list.
*/ */
@ -1131,6 +1133,8 @@ function is_theme_paused( $theme ) {
* *
* @since 5.2.0 * @since 5.2.0
* *
* @global WP_Paused_Extensions_Storage $_paused_themes
*
* @param string $theme Path to the theme directory relative to the themes * @param string $theme Path to the theme directory relative to the themes
* directory. * directory.
* @return array|false Array of error information as it was returned by * @return array|false Array of error information as it was returned by
@ -1221,7 +1225,8 @@ function resume_theme( $theme, $redirect = '' ) {
* *
* @since 5.2.0 * @since 5.2.0
* *
* @global string $pagenow The filename of the current screen. * @global string $pagenow The filename of the current screen.
* @global WP_Paused_Extensions_Storage $_paused_themes
*/ */
function paused_themes_notice() { function paused_themes_notice() {
if ( 'themes.php' === $GLOBALS['pagenow'] ) { if ( 'themes.php' === $GLOBALS['pagenow'] ) {

View File

@ -1014,6 +1014,8 @@ function wp_get_active_and_valid_plugins() {
* *
* @since 5.2.0 * @since 5.2.0
* *
* @global WP_Paused_Extensions_Storage $_paused_plugins
*
* @param string[] $plugins Array of absolute plugin main file paths. * @param string[] $plugins Array of absolute plugin main file paths.
* @return string[] Filtered array of plugins, without any paused plugins. * @return string[] Filtered array of plugins, without any paused plugins.
*/ */
@ -1088,6 +1090,8 @@ function wp_get_active_and_valid_themes() {
* *
* @since 5.2.0 * @since 5.2.0
* *
* @global WP_Paused_Extensions_Storage $_paused_themes
*
* @param string[] $themes Array of absolute theme directory paths. * @param string[] $themes Array of absolute theme directory paths.
* @return string[] Filtered array of absolute paths to themes, without any paused themes. * @return string[] Filtered array of absolute paths to themes, without any paused themes.
*/ */

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.5-beta3-57771'; $wp_version = '6.5-beta3-57772';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.