Changeset 26916 for trunk/src/wp-admin/includes/class-wp-media-list-table.php

Timestamp:

01/08/2014 03:52:47 AM (11 years ago)

Author:

DrewAPicture

Message:

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

Props theorboman for the initial patch. Props kpdesign.
Fixes #25839.

File:

• trunk/src/wp-admin/includes/class-wp-media-list-table.php (modified) (5 diffs)

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

@@ -91 +91 @@
             $this->months_dropdown( 'attachment' );
 
+            /** This action is documented in wp-admin/includes/class-wp-posts-list-table.php */
             do_action( 'restrict_manage_posts' );
             submit_button( __( 'Filter' ), 'button', false, false, array( 'id' => 'post-query-submit' ) );
@@ -138 +139 @@
         $taxonomies = wp_filter_object_list( $taxonomies, array( 'show_admin_column' => true ), 'and', 'name' );
 
+        /**
+         * Filter the taxonomy columns for attachments in the Media list table.
+         *
+         * @since 3.5.0
+         *
+         * @param array  $taxonomies An array of registered taxonomies to show for attachments.
+         * @param string $post_type  The post type. Default 'attachment'.
+         */
         $taxonomies = apply_filters( 'manage_taxonomies_for_attachment_columns', $taxonomies, 'attachment' );
         $taxonomies = array_filter( $taxonomies, 'taxonomy_exists' );
@@ -160 +169 @@
         /* translators: column name */
         $posts_columns['date'] = _x( 'Date', 'column name' );
+        /**
+         * Filter the Media list table columns.
+         *
+         * @since 2.5.0
+         *
+         * @param array $posts_columns An array of columns displayed in the Media list table.
+         * @param bool  $detached      Whether the list table contains media not attached
+         *                             to any posts. Default true.
+         */
         $posts_columns = apply_filters( 'manage_media_columns', $posts_columns, $this->detached );
 
@@ -384 +402 @@
 ?>
         <td <?php echo $attributes ?>>
+            <?php
+                /**
+                 * Fires for each custom column in the Media list table.
+                 *
+                 * Custom columns are registered using the 'manage_media_columns' filter.
+                 *
+                 * @since 2.5.0
+                 *
+                 * @param string $column_name Name of the custom column.
+                 * @param int    $post_id     Attachment ID.
+                 */
+            ?>
             <?php do_action( 'manage_media_custom_column', $column_name, $post->ID ); ?>
         </td>
@@ -431 +461 @@
         }
 
+        /**
+         * Filter the action links for each attachment in the Media list table.
+         *
+         * @since 2.8.0
+         *
+         * @param array   $actions  An array of action links for each attachment.
+         *                          Default 'Edit', 'Delete Permanently', 'View'.
+         * @param WP_Post $post     WP_Post object for the current attachment.
+         * @param bool    $detached Whether the list table contains media not attached
+         *                          to any posts. Default true.
+         */
         $actions = apply_filters( 'media_row_actions', $actions, $post, $this->detached );