mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-01-17 12:58:25 +01:00
Code Issues Actions 98 Packages Projects Releases Wiki Activity

Docs: Add missing descriptions for Automatic_Upgrader_Skin methods.

Browse Source 
Props johannadevos, dilipbheda.
Fixes #44546.

git-svn-id: https://develop.svn.wordpress.org/trunk@49596 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-11-14 16:21:19 +00:00
parent 637a3e8b5d
commit 36f47ff751
2 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/wp-admin/includes/class-automatic-upgrader-skin.php
View File

@ -8,7 +8,7 @@
*/
/**
* Upgrader Skin for Automatic WordPress Upgrades
* Upgrader Skin for Automatic WordPress Upgrades.
*
* This skin is designed to be used when no output is intended, all output
* is captured and stored for the caller to process and log/email/discard.
@ -52,14 +52,22 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin {
}
/**
* @return array
* Retrieves the upgrade messages.
*
* @since 3.7.0
*
* @return array Messages during an upgrade.
*/
public function get_upgrade_messages() {
return $this->messages;
}
/**
* @param string|array|WP_Error $data
* Stores a message about the upgrade.
*
* @since 3.7.0
*
* @param string|array|WP_Error $data Message data.
* @param mixed ...$args Optional text replacements.
*/
public function feedback( $data, ...$args ) {
@ -103,12 +111,18 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin {
}
/**
* Creates a new output buffer.
*
* @since 3.7.0
*/
public function header() {
ob_start();
}
/**
* Retrieves the buffered content, deletes the buffer, and processes the output.
*
* @since 3.7.0
*/
public function footer() {
$output = ob_get_clean();

6
src/wp-admin/includes/class-wp-ajax-upgrader-skin.php
View File

@ -81,7 +81,7 @@ class WP_Ajax_Upgrader_Skin extends Automatic_Upgrader_Skin {
}
/**
* Stores a log entry for an error.
* Stores an error message about the upgrade.
*
* @since 4.6.0
* @since 5.3.0 Formalized the existing `...$args` parameter by adding it
@ -116,13 +116,13 @@ class WP_Ajax_Upgrader_Skin extends Automatic_Upgrader_Skin {
}
/**
* Stores a log entry.
* Stores a message about the upgrade.
*
* @since 4.6.0
* @since 5.3.0 Formalized the existing `...$args` parameter by adding it
* to the function signature.
*
* @param string|array|WP_Error $data Log entry data.
* @param string|array|WP_Error $data Message data.
* @param mixed ...$args Optional text replacements.
*/
public function feedback( $data, ...$args ) {