[ Index ] |
PHP Cross Reference of WordPress |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Upgrader API: Automatic_Upgrader_Skin class 4 * 5 * @package WordPress 6 * @subpackage Upgrader 7 * @since 4.6.0 8 */ 9 10 /** 11 * Upgrader Skin for Automatic WordPress Upgrades. 12 * 13 * This skin is designed to be used when no output is intended, all output 14 * is captured and stored for the caller to process and log/email/discard. 15 * 16 * @since 3.7.0 17 * @since 4.6.0 Moved to its own file from wp-admin/includes/class-wp-upgrader-skins.php. 18 * 19 * @see Bulk_Upgrader_Skin 20 */ 21 class Automatic_Upgrader_Skin extends WP_Upgrader_Skin { 22 protected $messages = array(); 23 24 /** 25 * Determines whether the upgrader needs FTP/SSH details in order to connect 26 * to the filesystem. 27 * 28 * @since 3.7.0 29 * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string. 30 * 31 * @see request_filesystem_credentials() 32 * 33 * @param bool|WP_Error $error Optional. Whether the current request has failed to connect, 34 * or an error object. Default false. 35 * @param string $context Optional. Full path to the directory that is tested 36 * for being writable. Default empty. 37 * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false. 38 * @return bool True on success, false on failure. 39 */ 40 public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) { 41 if ( $context ) { 42 $this->options['context'] = $context; 43 } 44 /* 45 * TODO: Fix up request_filesystem_credentials(), or split it, to allow us to request a no-output version. 46 * This will output a credentials form in event of failure. We don't want that, so just hide with a buffer. 47 */ 48 ob_start(); 49 $result = parent::request_filesystem_credentials( $error, $context, $allow_relaxed_file_ownership ); 50 ob_end_clean(); 51 return $result; 52 } 53 54 /** 55 * Retrieves the upgrade messages. 56 * 57 * @since 3.7.0 58 * 59 * @return array Messages during an upgrade. 60 */ 61 public function get_upgrade_messages() { 62 return $this->messages; 63 } 64 65 /** 66 * Stores a message about the upgrade. 67 * 68 * @since 3.7.0 69 * 70 * @param string|array|WP_Error $data Message data. 71 * @param mixed ...$args Optional text replacements. 72 */ 73 public function feedback( $data, ...$args ) { 74 if ( is_wp_error( $data ) ) { 75 $string = $data->get_error_message(); 76 } elseif ( is_array( $data ) ) { 77 return; 78 } else { 79 $string = $data; 80 } 81 if ( ! empty( $this->upgrader->strings[ $string ] ) ) { 82 $string = $this->upgrader->strings[ $string ]; 83 } 84 85 if ( strpos( $string, '%' ) !== false ) { 86 if ( ! empty( $args ) ) { 87 $string = vsprintf( $string, $args ); 88 } 89 } 90 91 $string = trim( $string ); 92 93 // Only allow basic HTML in the messages, as it'll be used in emails/logs rather than direct browser output. 94 $string = wp_kses( 95 $string, 96 array( 97 'a' => array( 98 'href' => true, 99 ), 100 'br' => true, 101 'em' => true, 102 'strong' => true, 103 ) 104 ); 105 106 if ( empty( $string ) ) { 107 return; 108 } 109 110 $this->messages[] = $string; 111 } 112 113 /** 114 * Creates a new output buffer. 115 * 116 * @since 3.7.0 117 */ 118 public function header() { 119 ob_start(); 120 } 121 122 /** 123 * Retrieves the buffered content, deletes the buffer, and processes the output. 124 * 125 * @since 3.7.0 126 */ 127 public function footer() { 128 $output = ob_get_clean(); 129 if ( ! empty( $output ) ) { 130 $this->feedback( $output ); 131 } 132 } 133 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
Generated: Tue Jan 19 01:00:03 2021 | Cross-referenced by PHPXref 0.7.1 |