vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-05-25 13:44:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Add examples of possible names for various hooks whose name contains a dynamic portion.

Browse Source 
This provides greater discoverability of such hooks in search results on the Code Reference site as well as increased clarity when reading the source.

See #50734, #52628


git-svn-id: https://develop.svn.wordpress.org/trunk@50505 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2021-03-07 12:30:38 +00:00
parent c3be472657
commit fa05e5e733
26 changed files with 403 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/wp-admin/includes/class-wp-automatic-updater.php
View File

@@ -182,7 +182,9 @@ class WP_Automatic_Updater {
* Filters 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
* being checked. Potential hook names include:
* being checked.
*
* Possible hook names include:
*
* - `auto_update_core`
* - `auto_update_plugin`

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

@@ -213,7 +213,14 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
* Filters API request arguments for each Add Plugins screen tab.
*
* The dynamic portion of the hook name, `$tab`, refers to the plugin install tabs.
* Default tabs include 'featured', 'popular', 'recommended', 'favorites', and 'upload'.
*
* Possible hook names include:
*
* - `install_plugins_table_api_args_favorites`
* - `install_plugins_table_api_args_featured`
* - `install_plugins_table_api_args_popular`
* - `install_plugins_table_api_args_recommended`
* - `install_plugins_table_api_args_upload`
*
* @since 3.7.0
*

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

@@ -632,6 +632,11 @@ class WP_Posts_List_Table extends WP_List_Table {
* The dynamic portion of the hook name, `$post_type`, refers to the post
* type slug.
*
* Possible hook names include:
*
* - `manage_taxonomies_for_post_columns`
* - `manage_taxonomies_for_page_columns`
*
* @since 3.5.0
*
* @param string[] $taxonomies Array of taxonomy names to show columns for.
@@ -687,6 +692,11 @@ class WP_Posts_List_Table extends WP_List_Table {
*
* The dynamic portion of the hook name, `$post_type`, refers to the post type slug.
*
* Possible hook names include:
*
* - `manage_post_posts_columns`
* - `manage_page_posts_columns`
*
* @since 3.0.0
*
* @param string[] $post_columns An associative array of column headings.
@@ -1274,6 +1284,11 @@ class WP_Posts_List_Table extends WP_List_Table {
*
* The dynamic portion of the hook name, `$post->post_type`, refers to the post type.
*
* Possible hook names include:
*
* - `manage_post_posts_custom_column`
* - `manage_page_posts_custom_column`
*
* @since 3.1.0
*
* @param string $column_name The name of the column to display.

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

@@ -526,6 +526,11 @@ class WP_Terms_List_Table extends WP_List_Table {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `category_row_actions`
* - `post_tag_row_actions`
*
* @since 3.0.0
*
* @param string[] $actions An array of action links to be displayed. Default
@@ -616,6 +621,11 @@ class WP_Terms_List_Table extends WP_List_Table {
* The dynamic portion of the hook name, `$this->screen->taxonomy`,
* refers to the slug of the current taxonomy.
*
* Possible hook names include:
*
* - `manage_category_custom_column`
* - `manage_post_tag_custom_column`
*
* @since 2.8.0
*
* @param string $string Blank string.

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

@@ -132,8 +132,16 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
* Filters 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'.
* tab.
*
* Possible hook names include:
*
* - `install_themes_table_api_args_dashboard`
* - `install_themes_table_api_args_featured`
* - `install_themes_table_api_args_new`
* - `install_themes_table_api_args_search`
* - `install_themes_table_api_args_updated`
* - `install_themes_table_api_args_upload`
*
* @since 3.7.0
*

6
src/wp-admin/includes/file.php
View File

@@ -757,7 +757,8 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) {
* Filters the data for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
* Possible filter names include:
*
* Possible hook names include:
*
* - `wp_handle_sideload_prefilter`
* - `wp_handle_upload_prefilter`
@@ -773,7 +774,8 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) {
* Filters the override parameters for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
* Possible filter names include:
*
* Possible hook names include:
*
* - `wp_handle_sideload_overrides`
* - `wp_handle_upload_overrides`

13
src/wp-admin/includes/media.php
View File

@@ -696,9 +696,14 @@ function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) {
* The dynamic portion of the hook name, `$type`, refers to the type
* of media uploaded.
*
* Possible hook names include:
*
* - `image_upload_iframe_src`
* - `media_upload_iframe_src`
*
* @since 3.0.0
*
* @param string $upload_iframe_src The upload iframe source URL by type.
* @param string $upload_iframe_src The upload iframe source URL.
*/
$upload_iframe_src = apply_filters( "{$type}_upload_iframe_src", $upload_iframe_src );
@@ -893,6 +898,12 @@ function wp_media_upload_handler() {
* The dynamic portion of the hook name, `$type`, refers to the type
* of media being sent.
*
* Possible hook names include:
*
* - `audio_send_to_editor_url`
* - `file_send_to_editor_url`
* - `video_send_to_editor_url`
*
* @since 3.3.0
*
* @param string $html HTML markup sent to the editor.

10
src/wp-admin/includes/nav-menu.php
View File

@@ -545,6 +545,11 @@ function wp_nav_menu_item_post_type_meta_box( $object, $box ) {
*
* The dynamic portion of the hook name, `$post_type_name`, refers to the post type name.
*
* Possible hook names include:
*
* - `nav_menu_items_post_recent`
* - `nav_menu_items_page_recent`
*
* @since 4.3.0
* @since 4.9.0 Added the `$recent_args` parameter.
*
@@ -633,6 +638,11 @@ function wp_nav_menu_item_post_type_meta_box( $object, $box ) {
* The dynamic portion of the hook name, `$post_type_name`, refers
* to the slug of the current post type.
*
* Possible hook names include:
*
* - `nav_menu_items_post`
* - `nav_menu_items_page`
*
* @since 3.2.0
* @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
*

7
src/wp-admin/includes/post.php
View File

@@ -1168,8 +1168,11 @@ function wp_edit_posts_query( $q = false ) {
*
* 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.
* Possible hook names include:
*
* - `edit_post_per_page`
* - `edit_page_per_page`
* - `edit_attachment_per_page`
*
* @since 3.0.0
*

10
src/wp-admin/includes/revision.php
View File

@@ -68,8 +68,14 @@ 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
* fields of the revision object being iterated over in a foreach statement.
* The dynamic portion of the hook name, `$field`, corresponds to a name of a
* field of the revision object.
*
* Possible hook names include:
*
* - `_wp_post_revision_field_post_title`
* - `_wp_post_revision_field_post_content`
* - `_wp_post_revision_field_post_excerpt`
*
* @since 3.6.0
*