Docs: Correct formatting of some DocBlocks in `Plugin_Upgrader` and `Theme_Upgrader` per the documentation standards.
See #49400. git-svn-id: https://develop.svn.wordpress.org/trunk@47414 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
288f5234e9
commit
cd84eaac26
|
@ -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.
|
||||||
|
|
|
@ -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;
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue