Changeset 26540

Timestamp:

12/02/2013 09:54:24 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/update.php.

Props stevenkword for the initial patches.
Fixes #26252.

File:

• trunk/src/wp-admin/includes/update.php (modified) (2 diffs)

trunk/src/wp-admin/includes/update.php

@@ -286 +286 @@
             printf( __('There is a new version of %1$s available. <a href="%2$s" class="thickbox" title="%3$s">View version %4$s details</a> or <a href="%5$s">update now</a>.'), $plugin_name, esc_url($details_url), esc_attr($plugin_name), $r->new_version, wp_nonce_url( self_admin_url('update.php?action=upgrade-plugin&plugin=') . $file, 'upgrade-plugin_' . $file) );
 
-        do_action( "in_plugin_update_message-$file", $plugin_data, $r );
+        /**
+         * Fires at the end of the update message container in each
+         * row of the plugins list table.
+         *
+         * The dynamic portion of the hook name, $file, refers to the path
+         * of the plugin's primary file relative to the plugins directory.
+         *
+         * @since 2.8.0
+         *
+         * @param array $plugin_data {
+         *     An array of plugin metadata.
+         *
+         *     @type string $name         The human-readable name of the plugin.
+         *     @type string $plugin_uri   Plugin URI.
+         *     @type string $version      Plugin version.
+         *     @type string $description  Plugin description.
+         *     @type string $author       Plugin author.
+         *     @type string $author_uri   Plugin author URI.
+         *     @type string $text_domain  Plugin text domain.
+         *     @type string $domain_path  Relative path to the plugin's .mo file(s).
+         *     @type bool   $network      Whether the plugin can only be activated network wide.
+         *     @type string $title        The human-readable title of the plugin.
+         *     @type string $author_name  Plugin author's name.
+         *     @type bool   $update       Whether there's an available update. Default null.
+         * }
+         * @param array $r {
+         *     An array of metadata about the available plugin update.
+         *
+         *     @type int    $id           Plugin ID.
+         *     @type string $slug         Plugin slug.
+         *     @type string $new_version  New plugin version.
+         *     @type string $url          Plugin URL.
+         *     @type string $package      Plugin update package URL.
+         * }
+         */
+        do_action( "in_plugin_update_message-{$file}", $plugin_data, $r );
 
         echo '</div></td></tr>';
@@ -343 +378 @@
         printf( __('There is a new version of %1$s available. <a href="%2$s" class="thickbox" title="%3$s">View version %4$s details</a> or <a href="%5$s">update now</a>.'), $theme['Name'], esc_url($details_url), esc_attr($theme['Name']), $r['new_version'], wp_nonce_url( self_admin_url('update.php?action=upgrade-theme&theme=') . $theme_key, 'upgrade-theme_' . $theme_key) );
 
-    do_action( "in_theme_update_message-$theme_key", $theme, $r );
+    /**
+     * Fires at the end of the update message container in each
+     * row of the themes list table.
+     *
+     * The dynamic portion of the hook name, $theme_key, refers to
+     * the theme slug as found in the WordPress.org themes repository.
+     *
+     * @since 3.1.0
+     *
+     * @param WP_Theme $theme The WP_Theme object.
+     * @param array    $r {
+     *     An array of metadata about the available theme update.
+     *
+     *     @type string $new_version New theme version.
+     *     @type string $url         Theme URL.
+     *     @type string $package     Theme update package URL.
+     * }
+     */
+    do_action( "in_theme_update_message-{$theme_key}", $theme, $r );
 
     echo '</div></td></tr>';