Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2025-03-11 14:22:26 +01:00
Code Issues Projects Releases Wiki Activity

Docs: Add missing descriptions for Automatic_Upgrader_Skin methods.

Browse Source 
Props johannadevos, dilipbheda.
Fixes #44546.
Built from https://develop.svn.wordpress.org/trunk@49596


git-svn-id: http://core.svn.wordpress.org/trunk@49334 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-11-14 16:23:10 +00:00
parent ec051cfb3e
commit 185607c417
3 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
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 * 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. * 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() { public function get_upgrade_messages() {
return $this->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. * @param mixed ...$args Optional text replacements.
*/ */
public function feedback( $data, ...$args ) { 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() { public function header() {
ob_start(); ob_start();
} }
/** /**
* Retrieves the buffered content, deletes the buffer, and processes the output.
*
* @since 3.7.0
*/ */
public function footer() { public function footer() {
$output = ob_get_clean(); $output = ob_get_clean();

6
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 4.6.0
* @since 5.3.0 Formalized the existing `...$args` parameter by adding it * @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 4.6.0
* @since 5.3.0 Formalized the existing `...$args` parameter by adding it * @since 5.3.0 Formalized the existing `...$args` parameter by adding it
* to the function signature. * 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. * @param mixed ...$args Optional text replacements.
*/ */
public function feedback( $data, ...$args ) { public function feedback( $data, ...$args ) {

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.6-beta4-49595'; $wp_version = '5.6-beta4-49596';
/** /**
* 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.