Changeset 28040

Timestamp:

04/08/2014 06:25:56 AM (12 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/class-wp-upgrader-skins.php.

Fixes #27711.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader-skins.php (modified) (7 diffs)

trunk/src/wp-admin/includes/class-wp-upgrader-skins.php

@@ -154 +154 @@
             unset( $update_actions['activate_plugin'] );
 
-        $update_actions = apply_filters('update_plugin_complete_actions', $update_actions, $this->plugin);
+        /**
+         * Filter the list of action links available following a single plugin update.
+         *
+         * @since 2.7.0
+         *
+         * @param array  $update_actions Array of plugin action links.
+         * @param string $plugin         Path to the plugin file.
+         */
+        $update_actions = apply_filters( 'update_plugin_complete_actions', $update_actions, $this->plugin );
+
         if ( ! empty($update_actions) )
             $this->feedback(implode(' | ', (array)$update_actions));
@@ -325 +334 @@
             unset( $update_actions['plugins_page'] );
 
-        $update_actions = apply_filters('update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info);
+        /**
+         * Filter the list of action links available following bulk plugin updates.
+         *
+         * @since 3.0.0
+         *
+         * @param array $update_actions Array of plugin action links.
+         * @param array $plugin_info    Array of information for the last-updated plugin.
+         */
+        $update_actions = apply_filters( 'update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
+
         if ( ! empty($update_actions) )
             $this->feedback(implode(' | ', (array)$update_actions));
@@ -361 +379 @@
             unset( $update_actions['themes_page'] );
 
-        $update_actions = apply_filters('update_bulk_theme_complete_actions', $update_actions, $this->theme_info );
+        /**
+         * Filter the list of action links available following bulk theme updates.
+         *
+         * @since 3.0.0
+         *
+         * @param array $update_actions Array of theme action links.
+         * @param array $theme_info     Array of information for the last-updated theme.
+         */
+        $update_actions = apply_filters( 'update_bulk_theme_complete_actions', $update_actions, $this->theme_info );
+
         if ( ! empty($update_actions) )
             $this->feedback(implode(' | ', (array)$update_actions));
@@ -424 +451 @@
         }
 
-        $install_actions = apply_filters('install_plugin_complete_actions', $install_actions, $this->api, $plugin_file);
+        /**
+         * Filter the list of action links available following a single plugin installation.
+         *
+         * @since 2.7.0
+         *
+         * @param array  $install_actions Array of plugin action links.
+         * @param object $api             Object containing WordPress.org API plugin data. Empty
+         *                                for non-API installs, such as when a plugin is installed
+         *                                via upload.
+         * @param string $plugin_file     Path to the plugin file.
+         */
+        $install_actions = apply_filters( 'install_plugin_complete_actions', $install_actions, $this->api, $plugin_file );
+
         if ( ! empty($install_actions) )
             $this->feedback(implode(' | ', (array)$install_actions));
@@ -497 +536 @@
             unset( $install_actions['activate'], $install_actions['preview'] );
 
-        $install_actions = apply_filters('install_theme_complete_actions', $install_actions, $this->api, $stylesheet, $theme_info);
+        /**
+         * Filter the list of action links available following a single theme installation.
+         *
+         * @since 2.8.0
+         *
+         * @param array    $install_actions Array of theme action links.
+         * @param object   $api             Object containing WordPress.org API theme data.
+         * @param string   $stylesheet      Theme directory name.
+         * @param WP_Theme $theme_info      Theme object.
+         */
+        $install_actions = apply_filters( 'install_theme_complete_actions', $install_actions, $this->api, $stylesheet, $theme_info );
         if ( ! empty($install_actions) )
             $this->feedback(implode(' | ', (array)$install_actions));
@@ -559 +608 @@
         $update_actions['themes_page'] = '<a href="' . self_admin_url('themes.php') . '" title="' . esc_attr__('Return to Themes page') . '" target="_parent">' . __('Return to Themes page') . '</a>';
 
-        $update_actions = apply_filters('update_theme_complete_actions', $update_actions, $this->theme);
+        /**
+         * Filter the list of action links available following a single theme update.
+         *
+         * @since 2.8.0
+         *
+         * @param array  $update_actions Array of theme action links.
+         * @param string $theme          Theme directory name.
+         */
+        $update_actions = apply_filters( 'update_theme_complete_actions', $update_actions, $this->theme );
+
         if ( ! empty($update_actions) )
             $this->feedback(implode(' | ', (array)$update_actions));
@@ -609 +667 @@
         $update_actions = array();
         $update_actions['updates_page'] = '<a href="' . self_admin_url( 'update-core.php' ) . '" title="' . esc_attr__( 'Go to WordPress Updates page' ) . '" target="_parent">' . __( 'Return to WordPress Updates' ) . '</a>';
+
+        /**
+         * Filter the list of action links available following a translations update.
+         *
+         * @since 3.7.0
+         *
+         * @param array $update_actions Array of translations update links.
+         */
         $update_actions = apply_filters( 'update_translations_complete_actions', $update_actions );