[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> class-wp-paused-extensions-storage.php (summary)

Error Protection API: WP_Paused_Extensions_Storage class

File Size: 225 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_Paused_Extensions_Storage:: (8 methods):
  __construct()
  set()
  delete()
  get()
  get_all()
  delete_all()
  is_api_loaded()
  get_option_name()


Class: WP_Paused_Extensions_Storage  - X-Ref

Core class used for storing paused extensions.

__construct( $extension_type )   X-Ref
Constructor.

param: string $extension_type Extension type. Either 'plugin' or 'theme'.
since: 5.2.0

set( $extension, $error )   X-Ref
Records an extension error.

Only one error is stored per extension, with subsequent errors for the same extension overriding the
previously stored error.

param: string $extension Plugin or theme directory name.
param: array  $error     {
return: bool True on success, false on failure.
since: 5.2.0

delete( $extension )   X-Ref
Forgets a previously recorded extension error.

param: string $extension Plugin or theme directory name.
return: bool True on success, false on failure.
since: 5.2.0

get( $extension )   X-Ref
Gets the error for an extension, if paused.

param: string $extension Plugin or theme directory name.
return: array|null Error that is stored, or null if the extension is not paused.
since: 5.2.0

get_all()   X-Ref
Gets the paused extensions with their errors.

return: array {
since: 5.2.0

delete_all()   X-Ref
Remove all paused extensions.

return: bool
since: 5.2.0

is_api_loaded()   X-Ref
Checks whether the underlying API to store paused extensions is loaded.

return: bool True if the API is loaded, false otherwise.
since: 5.2.0

get_option_name()   X-Ref
Get the option name for storing paused extensions.

return: string
since: 5.2.0



Generated: Fri Dec 13 01:00:02 2024 Cross-referenced by PHPXref 0.7.1