Docs: Correct formatting of some DocBlocks in Plugin_Upgrader and Theme_Upgrader per the documentation standards.

See #49400.
Built from https://develop.svn.wordpress.org/trunk@47414


git-svn-id: http://core.svn.wordpress.org/trunk@47201 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-03-03 11:39:08 +00:00
parent ab854ce518
commit a9479f31d1
3 changed files with 11 additions and 10 deletions

View File

@ -415,8 +415,8 @@ class Plugin_Upgrader extends WP_Upgrader {
* @since 2.8.0 * @since 2.8.0
* @since 4.1.0 Added a return value. * @since 4.1.0 Added a return value.
* *
* @param bool|WP_Error $return Upgrade offer return. * @param bool|WP_Error $return Upgrade offer return.
* @param array $plugin Plugin package arguments. * @param array $plugin Plugin package arguments.
* @return bool|WP_Error The passed in $return param or WP_Error. * @return bool|WP_Error The passed in $return param or WP_Error.
*/ */
public function deactivate_plugin_before_upgrade( $return, $plugin ) { public function deactivate_plugin_before_upgrade( $return, $plugin ) {
@ -466,7 +466,7 @@ class Plugin_Upgrader extends WP_Upgrader {
$plugin = isset( $plugin['plugin'] ) ? $plugin['plugin'] : ''; $plugin = isset( $plugin['plugin'] ) ? $plugin['plugin'] : '';
// Only run if plugin is active // Only run if plugin is active.
if ( ! is_plugin_active( $plugin ) ) { if ( ! is_plugin_active( $plugin ) ) {
return $return; return $return;
} }
@ -486,8 +486,8 @@ class Plugin_Upgrader extends WP_Upgrader {
* *
* @since 5.4.0 * @since 5.4.0
* *
* @param bool|WP_Error $return Upgrade offer return. * @param bool|WP_Error $return Upgrade offer return.
* @param array $plugin Plugin package arguments. * @param array $plugin Plugin package arguments.
* @return bool|WP_Error The passed in $return param or WP_Error. * @return bool|WP_Error The passed in $return param or WP_Error.
*/ */
public function active_after( $return, $plugin ) { public function active_after( $return, $plugin ) {
@ -525,7 +525,8 @@ class Plugin_Upgrader extends WP_Upgrader {
* *
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
* *
* @param bool|WP_Error $removed Whether the destination was cleared. true on success, WP_Error on failure. * @param bool|WP_Error $removed Whether the destination was cleared.
* True on success, WP_Error on failure.
* @param string $local_destination The local package destination. * @param string $local_destination The local package destination.
* @param string $remote_destination The remote package destination. * @param string $remote_destination The remote package destination.
* @param array $plugin Extra arguments passed to hooked filters. * @param array $plugin Extra arguments passed to hooked filters.

View File

@ -529,7 +529,7 @@ class Theme_Upgrader extends WP_Upgrader {
* @since 2.8.0 * @since 2.8.0
* *
* @param bool|WP_Error $return Upgrade offer return. * @param bool|WP_Error $return Upgrade offer return.
* @param array $theme Theme arguments. * @param array $theme Theme arguments.
* @return bool|WP_Error The passed in $return param or WP_Error. * @return bool|WP_Error The passed in $return param or WP_Error.
*/ */
public function current_before( $return, $theme ) { public function current_before( $return, $theme ) {
@ -561,7 +561,7 @@ class Theme_Upgrader extends WP_Upgrader {
* @since 2.8.0 * @since 2.8.0
* *
* @param bool|WP_Error $return Upgrade offer return. * @param bool|WP_Error $return Upgrade offer return.
* @param array $theme Theme arguments. * @param array $theme Theme arguments.
* @return bool|WP_Error The passed in $return param or WP_Error. * @return bool|WP_Error The passed in $return param or WP_Error.
*/ */
public function current_after( $return, $theme ) { public function current_after( $return, $theme ) {
@ -571,7 +571,7 @@ class Theme_Upgrader extends WP_Upgrader {
$theme = isset( $theme['theme'] ) ? $theme['theme'] : ''; $theme = isset( $theme['theme'] ) ? $theme['theme'] : '';
// Only run if current theme // Only run if current theme.
if ( get_stylesheet() !== $theme ) { if ( get_stylesheet() !== $theme ) {
return $return; return $return;
} }

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.4-beta3-47413'; $wp_version = '5.4-beta3-47414';
/** /**
* 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.