WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.

Built from https://develop.svn.wordpress.org/trunk@30648


git-svn-id: http://core.svn.wordpress.org/trunk@30638 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-30 11:28:24 +00:00
parent 9ae5e43ac8
commit 78bb3e5ff5
17 changed files with 41 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
wp-admin/includes/class-wp-list-table.php
View File

@ -342,7 +342,7 @@ class WP_List_Table {
/**
* Filter the list of available list table views.
*
* The dynamic portion of the hook name, $this->screen->id, refers
* The dynamic portion of the hook name, `$this->screen->id`, refers
* to the ID of the current screen, usually a string.
*
* @since 3.5.0
@ -390,7 +390,7 @@ class WP_List_Table {
/**
* Filter the list table Bulk Actions drop-down.
*
* The dynamic portion of the hook name, $this->screen->id, refers
* The dynamic portion of the hook name, `$this->screen->id`, refers
* to the ID of the current screen, usually a string.
*
* This filter can currently only be used to remove bulk actions.
@ -766,7 +766,7 @@ class WP_List_Table {
/**
* Filter the list table sortable columns for a specific screen.
*
* The dynamic portion of the hook name, $this->screen->id, refers
* The dynamic portion of the hook name, `$this->screen->id`, refers
* to the ID of the current screen, usually a string.
*
* @since 3.5.0

4
wp-admin/includes/class-wp-ms-themes-list-table.php
View File

@ -331,7 +331,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
* Filter the action links of a specific theme in the Multisite themes
* list table.
*
* The dynamic portion of the hook name, $stylesheet, refers to the
* The dynamic portion of the hook name, `$stylesheet`, refers to the
* directory name of the theme, which in most cases is synonymous
* with the template name.
*
@ -444,7 +444,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
/**
* Fires after each specific row in the Multisite themes list table.
*
* The dynamic portion of the hook name, $stylesheet, refers to the
* The dynamic portion of the hook name, `$stylesheet`, refers to the
* directory name of the theme, most often synonymous with the template
* name of the theme.
*

2
wp-admin/includes/class-wp-plugin-install-list-table.php
View File

@ -156,7 +156,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
/**
* Filter API request arguments for each Plugin Install screen tab.
*
* The dynamic portion of the hook name, $tab, refers to the plugin install tabs.
* The dynamic portion of the hook name, `$tab`, refers to the plugin install tabs.
* Default tabs are 'dashboard', 'search', 'upload', 'featured', 'popular', 'new',
* and 'favorites'.
*

4
wp-admin/includes/class-wp-plugins-list-table.php
View File

@ -424,7 +424,7 @@ class WP_Plugins_List_Table extends WP_List_Table {
/**
* Filter the action links displayed for each plugin in the Plugins list table.
*
* The dynamic portion of the hook name, $prefix, refers to the context the
* The dynamic portion of the hook name, `$prefix`, refers to the context the
* action links are displayed in. The 'network_admin_' prefix is used if the
* current screen is the Network plugins list table. The prefix is empty ('')
* if the current screen is the site plugins list table.
@ -589,7 +589,7 @@ class WP_Plugins_List_Table extends WP_List_Table {
/**
* Fires after each specific row in the Plugins list table.
*
* The dynamic portion of the hook name, $plugin_file, refers to the path
* The dynamic portion of the hook name, `$plugin_file`, refers to the path
* to the plugin file, relative to the plugins directory.
*
* @since 2.7.0

6
wp-admin/includes/class-wp-posts-list-table.php
View File

@ -301,7 +301,7 @@ class WP_Posts_List_Table extends WP_List_Table {
/**
* Filter the taxonomy columns in the Posts list table.
*
* The dynamic portion of the hook name, $post_type, refers to the post
* The dynamic portion of the hook name, `$post_type`, refers to the post
* type slug.
*
* @since 3.5.0
@ -355,7 +355,7 @@ class WP_Posts_List_Table extends WP_List_Table {
/**
* Filter the columns displayed in the Posts list table for a specific post type.
*
* The dynamic portion of the hook name, $post_type, refers to the post type slug.
* The dynamic portion of the hook name, `$post_type`, refers to the post type slug.
*
* @since 3.0.0
*
@ -877,7 +877,7 @@ class WP_Posts_List_Table extends WP_List_Table {
/**
* Fires for each custom column of a specific post type in the Posts list table.
*
* The dynamic portion of the hook name, $post->post_type, refers to the post type.
* The dynamic portion of the hook name, `$post->post_type`, refers to the post type.
*
* @since 3.1.0
*

4
wp-admin/includes/class-wp-terms-list-table.php
View File

@ -327,7 +327,7 @@ class WP_Terms_List_Table extends WP_List_Table {
/**
* Filter the action links displayed for each term in the terms list table.
*
* The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* @since 3.0.0
*
@ -392,7 +392,7 @@ class WP_Terms_List_Table extends WP_List_Table {
/**
* Filter the displayed columns in the terms list table.
*
* The dynamic portion of the hook name, $this->screen->taxonomy,
* The dynamic portion of the hook name, `$this->screen->taxonomy`,
* refers to the slug of the current taxonomy.
*
* @since 2.8.0

2
wp-admin/includes/class-wp-theme-install-list-table.php
View File

@ -106,7 +106,7 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
/**
* Filter API request arguments for each Install Themes screen tab.
*
* The dynamic portion of the hook name, $tab, refers to the theme install
* The dynamic portion of the hook name, `$tab`, refers to the theme install
* tabs. Default tabs are 'dashboard', 'search', 'upload', 'featured',
* 'new', and 'updated'.
*

6
wp-admin/includes/class-wp-upgrader.php
View File

@ -1934,15 +1934,15 @@ class WP_Automatic_Updater {
/**
* Filter whether to automatically update core, a plugin, a theme, or a language.
*
* The dynamic portion of the hook name, $type, refers to the type of update
* The dynamic portion of the hook name, `$type`, refers to the type of update
* being checked. Can be 'core', 'theme', 'plugin', or 'translation'.
*
* Generally speaking, plugins, themes, and major core versions are not updated
* by default, while translations and minor and development versions for core
* are updated by default.
*
* See the allow_dev_auto_core_updates, allow_minor_auto_core_updates, and
* allow_major_auto_core_updates filters for a more straightforward way to
* See the {@see 'allow_dev_auto_core_updates', {@see 'allow_minor_auto_core_updates'},
* and {@see 'allow_major_auto_core_updates'} filters for a more straightforward way to
* adjust core updates.
*
* @since 3.7.0

8
wp-admin/includes/file.php
View File

@ -208,10 +208,12 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) {
}
/**
* The dynamic portion of the hook name, $action, refers to the post action.
* Filter the data for a file before it is uploaded to WordPress.
*
* @since 2.9.0 as 'wp_handle_upload_prefilter'
* @since 4.0.0 Converted to a dynamic hook with $action
* 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.
*/

6
wp-admin/includes/media.php
View File

@ -494,7 +494,7 @@ if ( is_string( $content_func ) ) {
* Fires in the admin header for each specific form tab in the legacy
* (pre-3.5.0) media upload popup.
*
* The dynamic portion of the hook, $content_func, refers to the form
* The dynamic portion of the hook, `$content_func`, refers to the form
* callback for the media upload type. Possible values include
* 'media_upload_type_form', 'media_upload_type_url_form', and
* 'media_upload_library_form'.
@ -595,7 +595,7 @@ function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) {
/**
* Filter the upload iframe source URL for a specific media type.
*
* The dynamic portion of the hook name, $type, refers to the type
* The dynamic portion of the hook name, `$type`, refers to the type
* of media uploaded.
*
* @since 3.0.0
@ -763,7 +763,7 @@ function wp_media_upload_handler() {
/**
* Filter the URL sent to the editor for a specific media type.
*
* The dynamic portion of the hook name, $type, refers to the type
* The dynamic portion of the hook name, `$type`, refers to the type
* of media being sent.
*
* @since 3.3.0

4
wp-admin/includes/nav-menu.php
View File

@ -792,8 +792,8 @@ function wp_nav_menu_item_post_type_meta_box( $object, $post_type ) {
* Filter the posts displayed in the 'View All' tab of the current
* post type's menu items meta box.
*
* The dynamic portion of the hook name, $post_type_name,
* refers to the slug of the current post type.
* The dynamic portion of the hook name, `$post_type_name`, refers
* to the slug of the current post type.
*
* @since 3.2.0
*

8
wp-admin/includes/plugin.php
View File

@ -561,8 +561,8 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
* Fires as a specific plugin is being activated.
*
* This hook is the "activation" hook used internally by
* register_activation_hook(). The dynamic portion of the
* hook name, $plugin, refers to the plugin basename.
* {@see register_activation_hook()}. The dynamic portion of the
* hook name, `$plugin`, refers to the plugin basename.
*
* If a plugin is silently activated (such as during an update),
* this hook does not fire.
@ -674,8 +674,8 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
* Fires as a specific plugin is being deactivated.
*
* This hook is the "deactivation" hook used internally by
* register_deactivation_hook(). The dynamic portion of the
* hook name, $plugin, refers to the plugin basename.
* {@see register_deactivation_hook()}. The dynamic portion of the
* hook name, `$plugin`, refers to the plugin basename.
*
* If a plugin is silently deactivated (such as during an update),
* this hook does not fire.

6
wp-admin/includes/post.php
View File

@ -965,7 +965,7 @@ function wp_edit_posts_query( $q = false ) {
/**
* Filter the number of items per page to show for a specific 'per_page' type.
*
* The dynamic portion of the hook name, $post_type, refers to the post type.
* The dynamic portion of the hook name, `$post_type`, refers to the post type.
*
* Some examples of filter hooks generated here include: 'edit_attachment_per_page',
* 'edit_post_per_page', 'edit_page_per_page', etc.
@ -1104,8 +1104,8 @@ function postbox_classes( $id, $page ) {
/**
* Filter the postbox classes for a specific screen and screen ID combo.
*
* The dynamic portions of the hook name, $page, and $id, refer to
* the screen, and screen ID, respectively.
* The dynamic portions of the hook name, `$page` and `$id`, refer to
* the screen and screen ID, respectively.
*
* @since 3.2.0
*

5
wp-admin/includes/revision.php
View File

@ -58,7 +58,7 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
/**
* Contextually filter a post revision field.
*
* The dynamic portion of the hook name, $field, corresponds to each of the post
* The dynamic portion of the hook name, `$field`, corresponds to each of the post
* fields of the revision object being iterated over in a foreach statement.
*
* @since 3.6.0
@ -66,7 +66,8 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
* @param string $compare_from->$field The current revision field to compare to or from.
* @param string $field The current revision field.
* @param WP_Post $compare_from The revision post object to compare to or from.
* @param string null The context of whether the current revision is the old or the new one. Values are 'to' or 'from'.
* @param string null The context of whether the current revision is the old
* or the new one. Values are 'to' or 'from'.
*/
$content_from = $compare_from ? apply_filters( "_wp_post_revision_field_$field", $compare_from->$field, $field, $compare_from, 'from' ) : '';

2
wp-admin/includes/screen.php
View File

@ -25,7 +25,7 @@ function get_column_headers( $screen ) {
/**
* Filter the column headers for a list table on a specific screen.
*
* The dynamic portion of the hook name, $screen->id, refers to the
* The dynamic portion of the hook name, `$screen->id`, refers to the
* ID of a specific screen. For example, the screen ID for the Posts
* list table is edit-post, so the filter for that screen would be
* manage_edit-post_columns.

4
wp-admin/includes/update.php
View File

@ -289,7 +289,7 @@ function wp_plugin_update_row( $file, $plugin_data ) {
* 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
* 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
@ -378,7 +378,7 @@ function wp_theme_update_row( $theme_key, $theme ) {
* 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 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

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.1-beta2-30647';
$wp_version = '4.1-beta2-30648';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.