Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Error Protection API: WP_Paused_Extensions_Storage class

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @since 5.2.0

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Core class used for storing paused extensions.

[9] Fix | Delete

[10] Fix | Delete

* @since 5.2.0

[11] Fix | Delete

[12] Fix | Delete

#[AllowDynamicProperties]

[13] Fix | Delete

class WP_Paused_Extensions_Storage {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Type of extension. Used to key extension storage. Either 'plugin' or 'theme'.

[17] Fix | Delete

[18] Fix | Delete

* @since 5.2.0

[19] Fix | Delete

* @var string

[20] Fix | Delete

[21] Fix | Delete

protected $type;

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Constructor.

[25] Fix | Delete

[26] Fix | Delete

* @since 5.2.0

[27] Fix | Delete

[28] Fix | Delete

* @param string $extension_type Extension type. Either 'plugin' or 'theme'.

[29] Fix | Delete

[30] Fix | Delete

public function __construct( $extension_type ) {

[31] Fix | Delete

$this->type = $extension_type;

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Records an extension error.

[36] Fix | Delete

[37] Fix | Delete

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

[38] Fix | Delete

* previously stored error.

[39] Fix | Delete

[40] Fix | Delete

* @since 5.2.0

[41] Fix | Delete

[42] Fix | Delete

* @param string $extension Plugin or theme directory name.

[43] Fix | Delete

* @param array $error {

[44] Fix | Delete

* Error information returned by `error_get_last()`.

[45] Fix | Delete

[46] Fix | Delete

* @type int $type The error type.

[47] Fix | Delete

* @type string $file The name of the file in which the error occurred.

[48] Fix | Delete

* @type int $line The line number in which the error occurred.

[49] Fix | Delete

* @type string $message The error message.

[50] Fix | Delete

* }

[51] Fix | Delete

* @return bool True on success, false on failure.

[52] Fix | Delete

[53] Fix | Delete

public function set( $extension, $error ) {

[54] Fix | Delete

if ( ! $this->is_api_loaded() ) {

[55] Fix | Delete

return false;

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

$option_name = $this->get_option_name();

[59] Fix | Delete

[60] Fix | Delete

if ( ! $option_name ) {

[61] Fix | Delete

return false;

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

$paused_extensions = (array) get_option( $option_name, array() );

[65] Fix | Delete

[66] Fix | Delete

// Do not update if the error is already stored.

[67] Fix | Delete

if ( isset( $paused_extensions[ $this->type ][ $extension ] ) && $paused_extensions[ $this->type ][ $extension ] === $error ) {

[68] Fix | Delete

return true;

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

$paused_extensions[ $this->type ][ $extension ] = $error;

[72] Fix | Delete

[73] Fix | Delete

return update_option( $option_name, $paused_extensions );

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Forgets a previously recorded extension error.

[78] Fix | Delete

[79] Fix | Delete

* @since 5.2.0

[80] Fix | Delete

[81] Fix | Delete

* @param string $extension Plugin or theme directory name.

[82] Fix | Delete

* @return bool True on success, false on failure.

[83] Fix | Delete

[84] Fix | Delete

public function delete( $extension ) {

[85] Fix | Delete

if ( ! $this->is_api_loaded() ) {

[86] Fix | Delete

return false;

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

$option_name = $this->get_option_name();

[90] Fix | Delete

[91] Fix | Delete

if ( ! $option_name ) {

[92] Fix | Delete

return false;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

$paused_extensions = (array) get_option( $option_name, array() );

[96] Fix | Delete

[97] Fix | Delete

// Do not delete if no error is stored.

[98] Fix | Delete

if ( ! isset( $paused_extensions[ $this->type ][ $extension ] ) ) {

[99] Fix | Delete

return true;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

unset( $paused_extensions[ $this->type ][ $extension ] );

[103] Fix | Delete

[104] Fix | Delete

if ( empty( $paused_extensions[ $this->type ] ) ) {

[105] Fix | Delete

unset( $paused_extensions[ $this->type ] );

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

// Clean up the entire option if we're removing the only error.

[109] Fix | Delete

if ( ! $paused_extensions ) {

[110] Fix | Delete

return delete_option( $option_name );

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

return update_option( $option_name, $paused_extensions );

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Gets the error for an extension, if paused.

[118] Fix | Delete

[119] Fix | Delete

* @since 5.2.0

[120] Fix | Delete

[121] Fix | Delete

* @param string $extension Plugin or theme directory name.

[122] Fix | Delete

* @return array|null Error that is stored, or null if the extension is not paused.

[123] Fix | Delete

[124] Fix | Delete

public function get( $extension ) {

[125] Fix | Delete

if ( ! $this->is_api_loaded() ) {

[126] Fix | Delete

return null;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

$paused_extensions = $this->get_all();

[130] Fix | Delete

[131] Fix | Delete

if ( ! isset( $paused_extensions[ $extension ] ) ) {

[132] Fix | Delete

return null;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

return $paused_extensions[ $extension ];

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

/**

[139] Fix | Delete

* Gets the paused extensions with their errors.

[140] Fix | Delete

[141] Fix | Delete

* @since 5.2.0

[142] Fix | Delete

[143] Fix | Delete

* @return array {

[144] Fix | Delete

* Associative array of errors keyed by extension slug.

[145] Fix | Delete

[146] Fix | Delete

* @type array ...$0 Error information returned by `error_get_last()`.

[147] Fix | Delete

* }

[148] Fix | Delete

[149] Fix | Delete

public function get_all() {

[150] Fix | Delete

if ( ! $this->is_api_loaded() ) {

[151] Fix | Delete

return array();

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

$option_name = $this->get_option_name();

[155] Fix | Delete

[156] Fix | Delete

if ( ! $option_name ) {

[157] Fix | Delete

return array();

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

$paused_extensions = (array) get_option( $option_name, array() );

[161] Fix | Delete

[162] Fix | Delete

return isset( $paused_extensions[ $this->type ] ) ? $paused_extensions[ $this->type ] : array();

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Remove all paused extensions.

[167] Fix | Delete

[168] Fix | Delete

* @since 5.2.0

[169] Fix | Delete

[170] Fix | Delete

* @return bool

[171] Fix | Delete

[172] Fix | Delete

public function delete_all() {

[173] Fix | Delete

if ( ! $this->is_api_loaded() ) {

[174] Fix | Delete

return false;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

$option_name = $this->get_option_name();

[178] Fix | Delete

[179] Fix | Delete

if ( ! $option_name ) {

[180] Fix | Delete

return false;

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

$paused_extensions = (array) get_option( $option_name, array() );

[184] Fix | Delete

[185] Fix | Delete

unset( $paused_extensions[ $this->type ] );

[186] Fix | Delete

[187] Fix | Delete

if ( ! $paused_extensions ) {

[188] Fix | Delete

return delete_option( $option_name );

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

return update_option( $option_name, $paused_extensions );

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

/**

[195] Fix | Delete

* Checks whether the underlying API to store paused extensions is loaded.

[196] Fix | Delete

[197] Fix | Delete

* @since 5.2.0

[198] Fix | Delete

[199] Fix | Delete

* @return bool True if the API is loaded, false otherwise.

[200] Fix | Delete

[201] Fix | Delete

protected function is_api_loaded() {

[202] Fix | Delete

return function_exists( 'get_option' );

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

/**

[206] Fix | Delete

* Get the option name for storing paused extensions.

[207] Fix | Delete

[208] Fix | Delete

* @since 5.2.0

[209] Fix | Delete

[210] Fix | Delete

* @return string

[211] Fix | Delete

[212] Fix | Delete

protected function get_option_name() {

[213] Fix | Delete

if ( ! wp_recovery_mode()->is_active() ) {

[214] Fix | Delete

return '';

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

$session_id = wp_recovery_mode()->get_session_id();

[218] Fix | Delete

if ( empty( $session_id ) ) {

[219] Fix | Delete

return '';

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

return "{$session_id}_paused_extensions";

[223] Fix | Delete

}

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete