Changeset 30648 for trunk/src/wp-admin/includes/file.php

Timestamp:

11/30/2014 11:27:19 AM (10 years ago)

Author:

DrewAPicture

Message:

Docs Formatting: Backtick-escape inline code for all dynamic hook docs in wp-admin/includes/*.

Also adds a few inline @see cross-references as they apply.

Affects DocBlocks for the following hooks:

• views_{$this->screen->id}
• bulk_actions-{$this->screen->id}
• manage_{$this->screen->id}_sortable_columns
• theme_action_links_$stylesheet
• after_theme_row_$stylesheet
• install_plugins_table_api_args_$tab
• $prefix . plugin_action_links
• after_plugin_row_$plugin_file
• manage_taxonomies_for_{$post_type}_columns
• manage_{$post_type}_posts_columns
• manage_{$post->post_type}_posts_custom_column
• {$taxonomy}_row_actions
• manage_{$this->screen->taxonomy}_custom_column
• install_themes_table_api_args_' . $tab
• auto_update_ . $type
• {$action}_prefilter
• admin_head_{$content_func}
• nav_menu_items_{$post_type_name}
• activate_ . $plugin
• deactivate_ . $plugin
• edit_{$post_type}_per_page
• postbox_classes_{$page}_{$id}
• _wp_post_revision_field_$field
• manage_{$screen->id}_columns
• in_plugin_update_message-{$file}
• in_theme_update_message-{$theme_key}

See #30552.

File:

• trunk/src/wp-admin/includes/file.php (modified) (1 diff)

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

@@ -209 +209 @@
 
     /**
-     * The dynamic portion of the hook name, $action, refers to the post action.
-     *
-     * @since 2.9.0 as 'wp_handle_upload_prefilter'
-     * @since 4.0.0 Converted to a dynamic hook with $action
+     * Filter the data for a file before it is uploaded to WordPress.
+     *
+     * The dynamic portion of the hook name, `$action`, refers to the post action.
+     *
+     * @since 2.9.0 as 'wp_handle_upload_prefilter'.
+     * @since 4.0.0 Converted to a dynamic hook with `$action`.
      *
      * @param array $file An array of data for a single file.