Changeset 27430

Timestamp:

03/06/2014 01:43:59 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/class-wp-theme-install-list-table.php.

Props kpdesign for the cleanup.
Fixes #27293.

File:

• trunk/src/wp-admin/includes/class-wp-theme-install-list-table.php (modified) (4 diffs)

trunk/src/wp-admin/includes/class-wp-theme-install-list-table.php

@@ -49 +49 @@
         $nonmenu_tabs = array( 'theme-information' ); // Valid actions to perform which do not have a Menu item.
 
+        /**
+         * Filter the tabs shown on the Install Themes screen.
+         *
+         * @since 2.8.0
+         *
+         * @param array $tabs The tabs shown on the Install Themes screen. Defaults are
+         *                    'dashboard', 'search', 'upload', 'featured', 'new', and 'updated'.
+         */
         $tabs = apply_filters( 'install_themes_tabs', $tabs );
+
+        /**
+         * Filter tabs not associated with a menu item on the Install Themes screen.
+         *
+         * @since 2.8.0
+         *
+         * @param array $nonmenu_tabs The tabs that don't have a menu item on
+         *                            the Install Themes screen.
+         */
         $nonmenu_tabs = apply_filters( 'install_themes_nonmenu_tabs', $nonmenu_tabs );
 
@@ -94 +111 @@
         }
 
+        /**
+         * Filter API request arguments for each Install Themes screen tab.
+         *
+         * The dynamic portion of the hook name, $tab, refers to the theme install
+         * tabs. Default tabs are 'dashboard', 'search', 'upload', 'featured',
+         * 'new', and 'updated'.
+         *
+         * @since 3.7.0
+         *
+         * @param array $args An array of themes API arguments.
+         */
         $args = apply_filters( 'install_themes_table_api_args_' . $tab, $args );
 
@@ -135 +163 @@
         <div class="tablenav top themes">
             <div class="alignleft actions">
-                <?php do_action( 'install_themes_table_header' ); ?>
+                <?php
+                /**
+                 * Fires in the Install Themes list table header.
+                 *
+                 * @since 2.8.0
+                 */
+                do_action( 'install_themes_table_header' );
+                ?>
             </div>
             <?php $this->pagination( 'top' ); ?>
@@ -225 +260 @@
         $actions[] = '<a class="install-theme-preview" href="' . esc_url( $preview_url ) . '" title="' . esc_attr( sprintf( __( 'Preview %s' ), $name ) ) . '">' . __( 'Preview' ) . '</a>';
 
+        /**
+         * Filter the install action links for a theme in the Install Themes list table.
+         *
+         * @since 3.4.0
+         *
+         * @param array    $actions An array of theme action hyperlinks. Defaults are
+         *                          links to Install Now, Preview, and Details.
+         * @param WP_Theme $theme   Theme object.
+         */
         $actions = apply_filters( 'theme_install_actions', $actions, $theme );