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

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

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


git-svn-id: http://core.svn.wordpress.org/trunk@50118 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2021-03-07 12:32:09 +00:00
parent f4f826d74d
commit 52679edbff
27 changed files with 404 additions and 36 deletions

View File

@ -119,8 +119,14 @@ if ( $_REQUEST['short'] ) {
/**
* Filters the returned ID of an uploaded attachment.
*
* The dynamic portion of the hook name, `$type`, refers to the attachment type,
* such as 'image', 'audio', 'video', 'file', etc.
* The dynamic portion of the hook name, `$type`, refers to the attachment type.
*
* Possible hook names include:
*
* - `async_upload_audio`
* - `async_upload_file`
* - `async_upload_image`
* - `async_upload_video`
*
* @since 2.5.0
*

View File

@ -60,6 +60,11 @@ require_once ABSPATH . 'wp-admin/includes/edit-tag-messages.php';
* The dynamic portion of the hook name, `$taxonomy`, refers to
* the taxonomy slug.
*
* Possible hook names include:
*
* - `category_pre_edit_form`
* - `post_tag_pre_edit_form`
*
* @since 3.0.0
*
* @param WP_Term $tag Current taxonomy term object.
@ -96,6 +101,11 @@ if ( $message ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `category_term_edit_form_tag`
* - `post_tag_term_edit_form_tag`
*
* @since 3.7.0
*/
do_action( "{$taxonomy}_term_edit_form_tag" );
@ -115,6 +125,11 @@ wp_nonce_field( 'update-tag_' . $tag_ID );
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `category_term_edit_form_top`
* - `post_tag_term_edit_form_top`
*
* @since 4.5.0
*
* @param WP_Term $tag Current taxonomy term object.
@ -229,6 +244,11 @@ if ( isset( $tag->name ) ) {
* The dynamic portion of the hook name, `$taxonomy`, refers to
* the taxonomy slug.
*
* Possible hook names include:
*
* - `category_edit_form_fields`
* - `post_tag_edit_form_fields`
*
* @since 3.0.0
*
* @param WP_Term $tag Current taxonomy term object.
@ -261,6 +281,11 @@ if ( 'category' === $taxonomy ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `category_edit_form`
* - `post_tag_edit_form`
*
* @since 3.0.0
*
* @param WP_Term $tag Current taxonomy term object.

View File

@ -414,6 +414,11 @@ if ( $can_edit_terms ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `category_pre_add_form`
* - `post_tag_pre_add_form`
*
* @since 3.0.0
*
* @param string $taxonomy The taxonomy slug.
@ -430,6 +435,11 @@ if ( $can_edit_terms ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `category_term_new_form_tag`
* - `post_tag_term_new_form_tag`
*
* @since 3.7.0
*/
do_action( "{$taxonomy}_term_new_form_tag" );
@ -522,6 +532,11 @@ if ( $can_edit_terms ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `category_add_form_fields`
* - `post_tag_add_form_fields`
*
* @since 3.0.0
*
* @param string $taxonomy The taxonomy slug.
@ -570,6 +585,11 @@ if ( $can_edit_terms ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `category_add_form`
* - `post_tag_add_form`
*
* @since 3.0.0
*
* @param string $taxonomy The taxonomy slug.
@ -638,6 +658,11 @@ endif;
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `after-category-table`
* - `after-post_tag-table`
*
* @since 3.0.0
*
* @param string $taxonomy The taxonomy name.

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`

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
*

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.

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.

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
*

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`

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.

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.
*

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
*

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
*

View File

@ -87,13 +87,19 @@ if ( 'type' === $tab || 'type_url' === $tab || ! array_key_exists( $tab, media_u
* media popup based on the current tab.
*
* The dynamic portion of the hook name, `$type`, refers to the specific
* media upload type. Possible values include 'image', 'audio', 'video',
* 'file', etc.
* media upload type.
*
* The hook only fires if the current `$tab` is 'type' (From Computer),
* 'type_url' (From URL), or, if the tab does not exist (i.e., has not
* been registered via the {@see 'media_upload_tabs'} filter.
*
* Possible hook names include:
*
* - `media_upload_audio`
* - `media_upload_file`
* - `media_upload_image`
* - `media_upload_video`
*
* @since 2.5.0
*/
do_action( "media_upload_{$type}" );

View File

@ -84,8 +84,16 @@ if ( $tab ) {
* Fires before each of the tabs are rendered on the Install Themes page.
*
* The dynamic portion of the hook name, `$tab`, refers to the current
* theme installation tab. Possible values are 'dashboard', 'search', 'upload',
* 'featured', 'new', or 'updated'.
* theme installation tab.
*
* Possible hook names include:
*
* - `install_themes_pre_dashboard`
* - `install_themes_pre_featured`
* - `install_themes_pre_new`
* - `install_themes_pre_search`
* - `install_themes_pre_updated`
* - `install_themes_pre_upload`
*
* @since 2.8.0
*/
@ -251,8 +259,16 @@ if ( $tab ) {
* Fires at the top of each of the tabs on the Install Themes page.
*
* The dynamic portion of the hook name, `$tab`, refers to the current
* theme installation tab. Possible values are 'dashboard', 'search', 'upload',
* 'featured', 'new', or 'updated'.
* theme installation tab.
*
* Possible hook names include:
*
* - `install_themes_dashboard`
* - `install_themes_featured`
* - `install_themes_new`
* - `install_themes_search`
* - `install_themes_updated`
* - `install_themes_upload`
*
* @since 2.8.0
*

View File

@ -1269,6 +1269,12 @@ final class WP_Theme implements ArrayAccess {
*
* The dynamic portion of the hook name, `$post_type`, refers to the post type.
*
* Possible hook names include:
*
* - `theme_post_templates`
* - `theme_page_templates`
* - `theme_attachment_templates`
*
* @since 3.9.0
* @since 4.4.0 Converted to allow complete control over the `$page_templates` array.
* @since 4.7.0 Added the `$post_type` parameter.

View File

@ -1568,7 +1568,13 @@ function do_feed() {
* Fires once the given feed is loaded.
*
* The dynamic portion of the hook name, `$feed`, refers to the feed template name.
* Possible values include: 'rdf', 'rss', 'rss2', and 'atom'.
*
* Possible hook names include:
*
* - `do_feed_atom`
* - `do_feed_rdf`
* - `do_feed_rss`
* - `do_feed_rss2`
*
* @since 2.1.0
* @since 4.4.0 The `$feed` parameter was added.

View File

@ -4719,6 +4719,16 @@ function get_the_generator( $type = '' ) {
*
* The dynamic portion of the hook name, `$type`, refers to the generator type.
*
* Possible hook names include:
*
* - `get_the_generator_atom`
* - `get_the_generator_comment`
* - `get_the_generator_export`
* - `get_the_generator_html`
* - `get_the_generator_rdf`
* - `get_the_generator_rss2`
* - `get_the_generator_xhtml`
*
* @since 2.5.0
*
* @param string $gen The HTML markup output to wp_head().

View File

@ -1811,6 +1811,11 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
* The dynamic portion of the hook name, `$adjacent`, refers to the type
* of adjacency, 'next' or 'previous'.
*
* Possible hook names include:
*
* - `get_next_post_excluded_terms`
* - `get_previous_post_excluded_terms`
*
* @since 4.4.0
*
* @param array|string $excluded_terms Array of excluded term IDs. Empty string if none were provided.
@ -1882,6 +1887,11 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
* The dynamic portion of the hook name, `$adjacent`, refers to the type
* of adjacency, 'next' or 'previous'.
*
* Possible hook names include:
*
* - `get_next_post_join`
* - `get_previous_post_join`
*
* @since 2.5.0
* @since 4.4.0 Added the `$taxonomy` and `$post` parameters.
*
@ -1899,6 +1909,11 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
* The dynamic portion of the hook name, `$adjacent`, refers to the type
* of adjacency, 'next' or 'previous'.
*
* Possible hook names include:
*
* - `get_next_post_where`
* - `get_previous_post_where`
*
* @since 2.5.0
* @since 4.4.0 Added the `$taxonomy` and `$post` parameters.
*
@ -1916,6 +1931,11 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
* The dynamic portion of the hook name, `$adjacent`, refers to the type
* of adjacency, 'next' or 'previous'.
*
* Possible hook names include:
*
* - `get_next_post_sort`
* - `get_previous_post_sort`
*
* @since 2.5.0
* @since 4.4.0 Added the `$post` parameter.
* @since 4.9.0 Added the `$order` parameter.
@ -2004,6 +2024,11 @@ function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $
* The dynamic portion of the hook name, `$adjacent`, refers to the type
* of adjacency, 'next' or 'previous'.
*
* Possible hook names include:
*
* - `next_post_rel_link`
* - `previous_post_rel_link`
*
* @since 2.8.0
*
* @param string $link The relational link.
@ -2261,6 +2286,11 @@ function get_adjacent_post_link( $format, $link, $in_same_term = false, $exclude
* The dynamic portion of the hook name, `$adjacent`, refers to the type
* of adjacency, 'next' or 'previous'.
*
* Possible hook names include:
*
* - `next_post_link`
* - `previous_post_link`
*
* @since 2.6.0
* @since 4.2.0 Added the `$adjacent` parameter.
*

View File

@ -3454,6 +3454,11 @@ function adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false )
* The dynamic portion of the hook name, `$adjacent`, refers to the type of adjacency,
* either 'next', or 'previous'.
*
* Possible hook names include:
*
* - `next_image_link`
* - `previous_image_link`
*
* @since 3.5.0
*
* @param string $output Adjacent image HTML markup.

View File

@ -1772,6 +1772,12 @@ function get_post_type_labels( $post_type_object ) {
* The dynamic portion of the hook name, `$post_type`, refers to
* the post type slug.
*
* Possible hook names include:
*
* - `post_type_labels_post`
* - `post_type_labels_page`
* - `post_type_labels_attachment`
*
* @since 3.5.0
*
* @see get_post_type_labels() for the full list of labels.
@ -5031,6 +5037,23 @@ function wp_transition_post_status( $new_status, $old_status, $post ) {
* The dynamic portions of the hook name, `$new_status` and `$post->post_type`,
* refer to the new post status and post type, respectively.
*
* Possible hook names include:
*
* - `draft_post`
* - `future_post`
* - `pending_post`
* - `private_post`
* - `publish_post`
* - `trash_post`
* - `draft_page`
* - `future_page`
* - `pending_page`
* - `private_page`
* - `publish_page`
* - `trash_page`
* - `publish_attachment`
* - `trash_attachment`
*
* Please note: When this action is hooked using a particular post status (like
* 'publish', as `publish_{$post->post_type}`), it will fire both when a post is
* first transitioned to that status from something else, as well as upon

View File

@ -290,7 +290,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
*
* Possible filter names include:
* Possible hook names include:
*
* - `rest_post_query`
* - `rest_page_query`
@ -610,6 +610,12 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
*
* Possible hook names include:
*
* - `rest_insert_post`
* - `rest_insert_page`
* - `rest_insert_attachment`
*
* @since 4.7.0
*
* @param WP_Post $post Inserted or updated post object.
@ -668,6 +674,12 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
*
* Possible hook names include:
*
* - `rest_after_insert_post`
* - `rest_after_insert_page`
* - `rest_after_insert_attachment`
*
* @since 5.0.0
*
* @param WP_Post $post Inserted or updated post object.
@ -890,6 +902,12 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
*
* Possible hook names include:
*
* - `rest_post_trashable`
* - `rest_page_trashable`
* - `rest_attachment_trashable`
*
* Pass false to disable Trash support for the post.
*
* @since 4.7.0
@ -1251,6 +1269,12 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
*
* Possible hook names include:
*
* - `rest_pre_insert_post`
* - `rest_pre_insert_page`
* - `rest_pre_insert_attachment`
*
* @since 4.7.0
*
* @param stdClass $prepared_post An object representing a single post prepared
@ -1854,7 +1878,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
*
* Possible filter names include:
* Possible hook names include:
*
* - `rest_prepare_post`
* - `rest_prepare_page`

View File

@ -237,6 +237,11 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `rest_category_query`
* - `rest_post_tag_query`
*
* Enables adding extra arguments or setting defaults for a terms
* collection request.
*
@ -475,6 +480,11 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `rest_insert_category`
* - `rest_insert_post_tag`
*
* @since 4.7.0
*
* @param WP_Term $term Inserted or updated term object.
@ -505,6 +515,11 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `rest_after_insert_category`
* - `rest_after_insert_post_tag`
*
* @since 5.0.0
*
* @param WP_Term $term Inserted or updated term object.
@ -702,6 +717,11 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `rest_delete_category`
* - `rest_delete_post_tag`
*
* @since 4.7.0
*
* @param WP_Term $term The deleted term.
@ -761,6 +781,11 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `rest_pre_insert_category`
* - `rest_pre_insert_post_tag`
*
* @since 4.7.0
*
* @param object $prepared_term Term object.
@ -832,7 +857,7 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
*
* The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
*
* Possible filter names include:
* Possible hook names include:
*
* - `rest_prepare_category`
* - `rest_prepare_post_tag`

View File

@ -627,6 +627,11 @@ function get_taxonomy_labels( $tax ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `taxonomy_labels_category`
* - `taxonomy_labels_post_tag`
*
* @since 4.4.0
*
* @see get_taxonomy_labels() for the full list of taxonomy labels.
@ -2031,6 +2036,11 @@ function wp_delete_term( $term, $taxonomy, $args = array() ) {
* The dynamic portion of the hook name, `$taxonomy`, refers to the specific
* taxonomy the term belonged to.
*
* Possible hook names include:
*
* - `delete_category`
* - `delete_post_tag`
*
* @since 2.3.0
* @since 4.5.0 Introduced the `$object_ids` argument.
*
@ -2474,6 +2484,11 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
* The dynamic portion of the hook name, `$taxonomy`, refers
* to the slug of the taxonomy the term was created for.
*
* Possible hook names include:
*
* - `create_category`
* - `create_post_tag`
*
* @since 2.3.0
*
* @param int $term_id Term ID.
@ -2513,6 +2528,11 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `created_category`
* - `created_post_tag`
*
* @since 2.3.0
*
* @param int $term_id Term ID.
@ -2541,6 +2561,11 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `saved_category`
* - `saved_post_tag`
*
* @since 5.5.0
*
* @param int $term_id Term ID.
@ -3186,6 +3211,11 @@ function wp_update_term( $term_id, $taxonomy, $args = array() ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `edit_category`
* - `edit_post_tag`
*
* @since 2.3.0
*
* @param int $term_id Term ID.
@ -3218,6 +3248,11 @@ function wp_update_term( $term_id, $taxonomy, $args = array() ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `edited_category`
* - `edited_post_tag`
*
* @since 2.3.0
*
* @param int $term_id Term ID.

View File

@ -16,8 +16,8 @@
*
* @since 1.5.0
*
* @param string $type Filename without extension.
* @param array $templates An optional list of template candidates
* @param string $type Filename without extension.
* @param string[] $templates An optional list of template candidates.
* @return string Full path to template file.
*/
function get_query_template( $type, $templates = array() ) {
@ -30,14 +30,34 @@ function get_query_template( $type, $templates = array() ) {
/**
* Filters the list of template filenames that are searched for when retrieving a template to use.
*
* The dynamic portion of the hook name, `$type`, refers to the filename -- minus the file
* extension and any non-alphanumeric characters delimiting words -- of the file to load.
* The last element in the array should always be the fallback template for this query type.
*
* Possible values for `$type` include: 'index', '404', 'archive', 'author', 'category', 'tag', 'taxonomy', 'date',
* 'embed', 'home', 'frontpage', 'privacypolicy', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
* Possible hook names include:
*
* - `404_template_hierarchy`
* - `archive_template_hierarchy`
* - `attachment_template_hierarchy`
* - `author_template_hierarchy`
* - `category_template_hierarchy`
* - `date_template_hierarchy`
* - `embed_template_hierarchy`
* - `frontpage_template_hierarchy`
* - `home_template_hierarchy`
* - `index_template_hierarchy`
* - `page_template_hierarchy`
* - `paged_template_hierarchy`
* - `privacypolicy_template_hierarchy`
* - `search_template_hierarchy`
* - `single_template_hierarchy`
* - `singular_template_hierarchy`
* - `tag_template_hierarchy`
* - `taxonomy_template_hierarchy`
*
* @since 4.7.0
*
* @param array $templates A list of template candidates, in descending order of priority.
* @param string[] $templates A list of template candidates, in descending order of priority.
*/
$templates = apply_filters( "{$type}_template_hierarchy", $templates );
@ -50,15 +70,33 @@ function get_query_template( $type, $templates = array() ) {
* extension and any non-alphanumeric characters delimiting words -- of the file to load.
* This hook also applies to various types of files loaded as part of the Template Hierarchy.
*
* Possible values for `$type` include: 'index', '404', 'archive', 'author', 'category', 'tag', 'taxonomy', 'date',
* 'embed', 'home', 'frontpage', 'privacypolicy', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
* Possible hook names include:
*
* - `404_template`
* - `archive_template`
* - `attachment_template`
* - `author_template`
* - `category_template`
* - `date_template`
* - `embed_template`
* - `frontpage_template`
* - `home_template`
* - `index_template`
* - `page_template`
* - `paged_template`
* - `privacypolicy_template`
* - `search_template`
* - `single_template`
* - `singular_template`
* - `tag_template`
* - `taxonomy_template`
*
* @since 1.5.0
* @since 4.8.0 The `$type` and `$templates` parameters were added.
*
* @param string $template Path to the template. See locate_template().
* @param string $type Sanitized filename without extension.
* @param array $templates A list of template candidates, in descending order of priority.
* @param string $template Path to the template. See locate_template().
* @param string $type Sanitized filename without extension.
* @param string[] $templates A list of template candidates, in descending order of priority.
*/
return apply_filters( "{$type}_template", $template, $type, $templates );
}

View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.8-alpha-50504';
$wp_version = '5.8-alpha-50505';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -430,8 +430,22 @@ do_action( 'login_init' );
* Fires before a specified login form action.
*
* The dynamic portion of the hook name, `$action`, refers to the action
* that brought the visitor to the login form. Actions include 'postpass',
* 'logout', 'lostpassword', etc.
* that brought the visitor to the login form.
*
* Possible hook names include:
*
* - 'login_form_checkemail'
* - 'login_form_confirm_admin_email'
* - 'login_form_confirmaction'
* - 'login_form_entered_recovery_mode'
* - 'login_form_login'
* - 'login_form_logout'
* - 'login_form_lostpassword'
* - 'login_form_postpass'
* - 'login_form_register'
* - 'login_form_resetpass'
* - 'login_form_retrievepassword'
* - 'login_form_rp'
*
* @since 2.8.0
*/