$is_module parameter was added.
+- [`option_page_capability_{$option_page}`](https://developer.wordpress.org/reference/hooks/option_page_capability_option_page/) - Applied when wp-admin/options.php is accessed directly.
+- [`the_author_posts_link`](https://developer.wordpress.org/reference/hooks/the_author_posts_link/) - Added $author and $title parameters.
+- [`wp_hash_password_algorithm`](https://developer.wordpress.org/reference/hooks/wp_hash_password_algorithm/) - The $algorithm parameter is now always a string.
+- [`wp_hash_password_options`](https://developer.wordpress.org/reference/hooks/wp_hash_password_options/) - The $algorithm parameter is now always a string.
+
## WordPress 6.9
### New Actions
@@ -42,7 +73,10 @@ This document is automatically generated from the hooks extracted from WordPress
- [`get_{$adjacent}_post_sort`](https://developer.wordpress.org/reference/hooks/get_adjacent_post_sort/) - Adds ID sort to ensure deterministic ordering for posts with identical dates.
- [`get_{$adjacent}_post_where`](https://developer.wordpress.org/reference/hooks/get_adjacent_post_where/) - Adds ID-based fallback for posts with identical dates in adjacent post queries.
- [`get_avatar_comment_types`](https://developer.wordpress.org/reference/hooks/get_avatar_comment_types/) - The 'note' comment type was added.
+- [`pre_wp_mail`](https://developer.wordpress.org/reference/hooks/pre_wp_mail/) - The $embeds element was added to the $atts array.
- [`styles_inline_size_limit`](https://developer.wordpress.org/reference/hooks/styles_inline_size_limit/) - The default limit increased from 20K to 40K.
+- [`wp_mail_succeeded`](https://developer.wordpress.org/reference/hooks/wp_mail_succeeded/) - The $embeds element was added to the $mail_data array.
+- [`wp_mail`](https://developer.wordpress.org/reference/hooks/wp_mail/) - The $embeds element was added to the $args array.
## WordPress 6.8
@@ -81,7 +115,7 @@ This document is automatically generated from the hooks extracted from WordPress
- [`get_calendar`](https://developer.wordpress.org/reference/hooks/get_calendar/) - Added the $args parameter.
- [`the_password_form`](https://developer.wordpress.org/reference/hooks/the_password_form/) - Added the $invalid_password parameter.
- [`wp_create_application_password`](https://developer.wordpress.org/reference/hooks/wp_create_application_password/) - The hashed password value now uses wp_fast_hash() instead of phpass.
-- [`wp_editor_set_quality`](https://developer.wordpress.org/reference/hooks/wp_editor_set_quality/) - Added the size parameter.
+- [`wp_editor_set_quality`](https://developer.wordpress.org/reference/hooks/wp_editor_set_quality/) - Added the $size parameter.
- [`wp_get_attachment_image_attributes`](https://developer.wordpress.org/reference/hooks/wp_get_attachment_image_attributes/) (6.8.2) - The $attr array includes width and height attributes.
- [`wp_pre_insert_user_data`](https://developer.wordpress.org/reference/hooks/wp_pre_insert_user_data/) - The user's password is now hashed using bcrypt by default instead of phpass.
- [`wp_update_application_password`](https://developer.wordpress.org/reference/hooks/wp_update_application_password/) - The password is now hashed using wp_fast_hash() instead of phpass. Existing passwords may still be hashed using phpass.
@@ -104,7 +138,7 @@ _No new actions in this version._
### Changes
-- [`get_edit_comment_link`](https://developer.wordpress.org/reference/hooks/get_edit_comment_link/) - The $comment_id and $context parameters are now being passed to the filter.
+- [`get_edit_comment_link`](https://developer.wordpress.org/reference/hooks/get_edit_comment_link/) - The $comment_id and $context parameters are now being passed to the filter.
- [`image_editor_output_format`](https://developer.wordpress.org/reference/hooks/image_editor_output_format/) - The default was changed from an empty array to an array containing the HEIC/HEIF images mime types.
- [`wp_set_password`](https://developer.wordpress.org/reference/hooks/wp_set_password/) - The $old_user_data parameter was added.
@@ -130,7 +164,7 @@ _No new actions in this version._
### Changes
-- [`comment_cookie_lifetime`](https://developer.wordpress.org/reference/hooks/comment_cookie_lifetime/) - The default $seconds value changed from 30000000 to YEAR_IN_SECONDS.
+- [`comment_cookie_lifetime`](https://developer.wordpress.org/reference/hooks/comment_cookie_lifetime/) - The default $seconds value changed from 30000000 to YEAR_IN_SECONDS.
- [`load_translation_file`](https://developer.wordpress.org/reference/hooks/load_translation_file/) - Added the $locale parameter.
- [`split_the_query`](https://developer.wordpress.org/reference/hooks/split_the_query/) - Added the $old_request and $clauses parameters.
- [`wp_preload_resources`](https://developer.wordpress.org/reference/hooks/wp_preload_resources/) - Added the $fetchpriority attribute.
@@ -198,7 +232,7 @@ _No new actions in this version._
### Changes
-- [`_wp_put_post_revision`](https://developer.wordpress.org/reference/hooks/_wp_put_post_revision/) - The post_id parameter was added.
+- [`_wp_put_post_revision`](https://developer.wordpress.org/reference/hooks/_wp_put_post_revision/) - The $post_id parameter was added.
- [`block_editor_no_javascript_message`](https://developer.wordpress.org/reference/hooks/block_editor_no_javascript_message/) - Added $installed parameter.
- [`register_{$post_type}_post_type_args`](https://developer.wordpress.org/reference/hooks/register_post_type_post_type_args/) - Added late_route_registration, autosave_rest_controller_class and revisions_rest_controller_class arguments.
- [`wp_creating_autosave`](https://developer.wordpress.org/reference/hooks/wp_creating_autosave/) - The $is_update parameter was added to indicate if the autosave is being updated or was newly created.
@@ -214,7 +248,7 @@ _No new actions in this version._
### New Filters
- [`cron_memory_limit`](https://developer.wordpress.org/reference/hooks/cron_memory_limit/) - Filters the memory limit allocated for WP-Cron event processing.
-- [`get_pages_query_args`](https://developer.wordpress.org/reference/hooks/get_pages_query_args/) - Filters query arguments passed to WP_Query in get_pages.
+- [`get_pages_query_args`](https://developer.wordpress.org/reference/hooks/get_pages_query_args/) - Filters query arguments passed to WP_Query in get_pages().
- [`image_edit_thumbnails_separately`](https://developer.wordpress.org/reference/hooks/image_edit_thumbnails_separately/) - Shows the settings in the Image Editor that allow selecting to edit only the thumbnail of an image.
- [`nav_menu_item_attributes`](https://developer.wordpress.org/reference/hooks/nav_menu_item_attributes/) - Filters the HTML attributes applied to a menu's list item element.
- [`nav_menu_submenu_attributes`](https://developer.wordpress.org/reference/hooks/nav_menu_submenu_attributes/) - Filters the HTML attributes applied to a menu list element.
@@ -296,7 +330,7 @@ _No new actions in this version._
- [`site_status_should_suggest_persistent_object_cache`](https://developer.wordpress.org/reference/hooks/site_status_should_suggest_persistent_object_cache/) - Filters whether to suggest use of a persistent object cache and bypass default threshold checks.
- [`the_posts_pagination_args`](https://developer.wordpress.org/reference/hooks/the_posts_pagination_args/) - Filters the arguments for posts pagination links.
- [`update_themes_{$hostname}`](https://developer.wordpress.org/reference/hooks/update_themes_hostname/) - Filters the update response for a given theme hostname.
-- [`wp_img_tag_add_decoding_attr`](https://developer.wordpress.org/reference/hooks/wp_img_tag_add_decoding_attr/) - Filters the `decoding` attribute value to add to an image. Default `async`.
+- [`wp_img_tag_add_decoding_attr`](https://developer.wordpress.org/reference/hooks/wp_img_tag_add_decoding_attr/) - Filters the `decoding` attribute value to add to an image. Default 'async'.
- [`wp_list_authors_args`](https://developer.wordpress.org/reference/hooks/wp_list_authors_args/) - Filters the query arguments for the list of all authors of the site.
- [`wp_list_table_class_name`](https://developer.wordpress.org/reference/hooks/wp_list_table_class_name/) - Filters the list table class to instantiate.
- [`wp_list_users_args`](https://developer.wordpress.org/reference/hooks/wp_list_users_args/) - Filters the query arguments for the list of all users of the site.
@@ -349,7 +383,7 @@ _No new actions in this version._
- [`media_date_column_time`](https://developer.wordpress.org/reference/hooks/media_date_column_time/) - Filters the published time of an attachment displayed in the Media list table.
- [`plugin_install_description`](https://developer.wordpress.org/reference/hooks/plugin_install_description/) - Filters the plugin card description on the Add Plugins screen.
-- [`pre_wp_filesize`](https://developer.wordpress.org/reference/hooks/pre_wp_filesize/) - Filters the result of wp_filesize before the PHP function is run.
+- [`pre_wp_filesize`](https://developer.wordpress.org/reference/hooks/pre_wp_filesize/) - Filters the result of wp_filesize() before the file_exists() PHP function is run.
- [`register_{$post_type}_post_type_args`](https://developer.wordpress.org/reference/hooks/register_post_type_post_type_args/) - Filters the arguments for registering a specific post type.
- [`register_{$taxonomy}_taxonomy_args`](https://developer.wordpress.org/reference/hooks/register_taxonomy_taxonomy_args/) - Filters the arguments for registering a specific taxonomy.
- [`retrieve_password_notification_email`](https://developer.wordpress.org/reference/hooks/retrieve_password_notification_email/) - Filters the contents of the reset password notification email sent to the user.
@@ -395,7 +429,7 @@ _No new actions in this version._
- [`is_post_status_viewable`](https://developer.wordpress.org/reference/hooks/is_post_status_viewable/) - Filters whether a post status is considered "viewable".
- [`is_post_type_viewable`](https://developer.wordpress.org/reference/hooks/is_post_type_viewable/) - Filters whether a post type is considered "viewable".
- [`login_display_language_dropdown`](https://developer.wordpress.org/reference/hooks/login_display_language_dropdown/) - Filters whether to display the Language selector on the login screen.
-- [`login_language_dropdown_args`](https://developer.wordpress.org/reference/hooks/login_language_dropdown_args/) - Filters default arguments for the Languages select input on the login screen.
+- [`login_language_dropdown_args`](https://developer.wordpress.org/reference/hooks/login_language_dropdown_args/) - Filters default arguments for the Language select input on the login screen.
- [`post_thumbnail_id`](https://developer.wordpress.org/reference/hooks/post_thumbnail_id/) - Filters the post thumbnail ID.
- [`post_thumbnail_url`](https://developer.wordpress.org/reference/hooks/post_thumbnail_url/) - Filters the post thumbnail URL.
- [`pre_get_block_file_template`](https://developer.wordpress.org/reference/hooks/pre_get_block_file_template/) - Filters the block template object before the theme file discovery takes place.
@@ -499,8 +533,8 @@ _No new actions in this version._
- [`update_post_term_count_statuses`](https://developer.wordpress.org/reference/hooks/update_post_term_count_statuses/) - Filters the post statuses for updating the term count.
- [`upgrader_install_package_result`](https://developer.wordpress.org/reference/hooks/upgrader_install_package_result/) - Filters the result of WP_Upgrader::install_package().
- [`wp_direct_update_https_url`](https://developer.wordpress.org/reference/hooks/wp_direct_update_https_url/) - Filters the URL for directly updating the PHP version the site is running on from the host.
-- [`wp_iframe_tag_add_loading_attr`](https://developer.wordpress.org/reference/hooks/wp_iframe_tag_add_loading_attr/) - Filters the `loading` attribute value to add to an iframe. Default `lazy`.
-- [`wp_image_src_get_dimensions`](https://developer.wordpress.org/reference/hooks/wp_image_src_get_dimensions/) - Filters the 'wp_image_src_get_dimensions' value.
+- [`wp_iframe_tag_add_loading_attr`](https://developer.wordpress.org/reference/hooks/wp_iframe_tag_add_loading_attr/) - Filters the `loading` attribute value to add to an iframe. Default 'lazy'.
+- [`wp_image_src_get_dimensions`](https://developer.wordpress.org/reference/hooks/wp_image_src_get_dimensions/) - Filters the wp_image_src_get_dimensions() value.
- [`wp_inline_script_attributes`](https://developer.wordpress.org/reference/hooks/wp_inline_script_attributes/) - Filters attributes to be added to a script tag.
- [`wp_list_table_show_post_checkbox`](https://developer.wordpress.org/reference/hooks/wp_list_table_show_post_checkbox/) - Filters whether to show the bulk edit checkbox for a post in its list table.
- [`wp_robots`](https://developer.wordpress.org/reference/hooks/wp_robots/) - Filters the directives to be included in the 'robots' meta tag.
@@ -512,11 +546,11 @@ _No new actions in this version._
### Changes
- [`get_post_status`](https://developer.wordpress.org/reference/hooks/get_post_status/) - The attachment post type is now passed through this filter.
-- [`pre_clear_scheduled_hook`](https://developer.wordpress.org/reference/hooks/pre_clear_scheduled_hook/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
-- [`pre_reschedule_event`](https://developer.wordpress.org/reference/hooks/pre_reschedule_event/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
-- [`pre_schedule_event`](https://developer.wordpress.org/reference/hooks/pre_schedule_event/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
-- [`pre_unschedule_event`](https://developer.wordpress.org/reference/hooks/pre_unschedule_event/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
-- [`pre_unschedule_hook`](https://developer.wordpress.org/reference/hooks/pre_unschedule_hook/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
+- [`pre_clear_scheduled_hook`](https://developer.wordpress.org/reference/hooks/pre_clear_scheduled_hook/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
+- [`pre_reschedule_event`](https://developer.wordpress.org/reference/hooks/pre_reschedule_event/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
+- [`pre_schedule_event`](https://developer.wordpress.org/reference/hooks/pre_schedule_event/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
+- [`pre_unschedule_event`](https://developer.wordpress.org/reference/hooks/pre_unschedule_event/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
+- [`pre_unschedule_hook`](https://developer.wordpress.org/reference/hooks/pre_unschedule_hook/) - The $wp_error parameter was added, and a WP_Error object can now be returned.
- [`rest_{$this->post_type}_query`](https://developer.wordpress.org/reference/hooks/rest_this-post_type_query/) - Moved after the tax_query query arg is generated.
- [`xmlrpc_call`](https://developer.wordpress.org/reference/hooks/xmlrpc_call/) - Added the $args and $server parameters.
@@ -528,7 +562,7 @@ _No new actions in this version._
- [`application_password_did_authenticate`](https://developer.wordpress.org/reference/hooks/application_password_did_authenticate/) - Fires after an application password was used for authentication.
- [`application_password_failed_authentication`](https://developer.wordpress.org/reference/hooks/application_password_failed_authentication/) - Fires when an application password failed to authenticate the user.
- [`do_all_pings`](https://developer.wordpress.org/reference/hooks/do_all_pings/) - Fires immediately after the `do_pings` event to hook services individually.
-- [`is_wp_error_instance`](https://developer.wordpress.org/reference/hooks/is_wp_error_instance/) - Fires when `is_wp_error()` is called and its parameter is an instance of `WP_Error`.
+- [`is_wp_error_instance`](https://developer.wordpress.org/reference/hooks/is_wp_error_instance/) - Fires when `is_wp_error()` is called and its parameter is an instance of WP_Error.
- [`manage_{$this->screen->id}_custom_column`](https://developer.wordpress.org/reference/hooks/manage_this-screen-id_custom_column/) - Fires for each custom column in the Application Passwords list table.
- [`manage_{$this->screen->id}_custom_column_js_template`](https://developer.wordpress.org/reference/hooks/manage_this-screen-id_custom_column_js_template/) - Fires in the JavaScript row template for each custom column in the Application Passwords list table.
- [`network_site_info_form`](https://developer.wordpress.org/reference/hooks/network_site_info_form/) - Fires at the end of the site info form in network admin.
@@ -651,7 +685,7 @@ _No new actions in this version._
- [`themes_auto_update_enabled`](https://developer.wordpress.org/reference/hooks/themes_auto_update_enabled/) - Filters whether themes auto-update is enabled.
- [`wp_edited_image_metadata`](https://developer.wordpress.org/reference/hooks/wp_edited_image_metadata/) - Filters the meta data for the new image created by editing an existing image.
- [`wp_image_file_matches_image_meta`](https://developer.wordpress.org/reference/hooks/wp_image_file_matches_image_meta/) - Filters whether an image path or URI matches image meta.
-- [`wp_img_tag_add_loading_attr`](https://developer.wordpress.org/reference/hooks/wp_img_tag_add_loading_attr/) - Filters the `loading` attribute value to add to an image. Default `lazy`.
+- [`wp_img_tag_add_loading_attr`](https://developer.wordpress.org/reference/hooks/wp_img_tag_add_loading_attr/) - Filters the `loading` attribute value to add to an image. Default 'lazy'.
- [`wp_img_tag_add_srcset_and_sizes_attr`](https://developer.wordpress.org/reference/hooks/wp_img_tag_add_srcset_and_sizes_attr/) - Filters whether to add the `srcset` and `sizes` HTML attributes to the img tag. Default `true`.
- [`wp_img_tag_add_width_and_height_attr`](https://developer.wordpress.org/reference/hooks/wp_img_tag_add_width_and_height_attr/) - Filters whether to add the missing `width` and `height` HTML attributes to the img tag. Default `true`.
- [`wp_lazy_loading_enabled`](https://developer.wordpress.org/reference/hooks/wp_lazy_loading_enabled/) - Filters whether to add the `loading` attribute to the specified tag in the specified context.
@@ -731,7 +765,7 @@ _No new actions in this version._
### New Filters
-- [`add_trashed_suffix_to_trashed_posts`](https://developer.wordpress.org/reference/hooks/add_trashed_suffix_to_trashed_posts/) - Filters whether or not to add a `__trashed` suffix to trashed posts that match the name of the updated post.
+- [`add_trashed_suffix_to_trashed_posts`](https://developer.wordpress.org/reference/hooks/add_trashed_suffix_to_trashed_posts/) - Filters whether or not to add a `__trashed` suffix to the name of trashed posts that match the name of the updated post.
- [`rest_{$this->post_type}_item_schema`](https://developer.wordpress.org/reference/hooks/rest_this-post_type_item_schema/) - Filters the post's schema.
- [`set_screen_option_{$option}`](https://developer.wordpress.org/reference/hooks/set_screen_option_option/) (5.4.2) - Filters a screen option value before it is set.
- [`user_request_action_email_headers`](https://developer.wordpress.org/reference/hooks/user_request_action_email_headers/) - Filters the headers of the email sent when an account action is attempted.
@@ -744,7 +778,7 @@ _No new actions in this version._
- [`category_link`](https://developer.wordpress.org/reference/hooks/category_link/) (5.4.1) - Restored (un-deprecated).
- [`lostpassword_post`](https://developer.wordpress.org/reference/hooks/lostpassword_post/) - Added the $user_data parameter.
- [`newblog_notify_siteadmin`](https://developer.wordpress.org/reference/hooks/newblog_notify_siteadmin/) - The $blog_id parameter was added.
-- [`post_locked_dialog`](https://developer.wordpress.org/reference/hooks/post_locked_dialog/) - The $user parameter was added.
+- [`post_locked_dialog`](https://developer.wordpress.org/reference/hooks/post_locked_dialog/) - The $user parameter was added.
- [`remove_user_from_blog`](https://developer.wordpress.org/reference/hooks/remove_user_from_blog/) - Added the $reassign parameter.
- [`set-screen-option`](https://developer.wordpress.org/reference/hooks/set-screen-option/) (5.4.2) - Only applied to options ending with '_page', or the 'layout_columns' option.
- [`switch_blog`](https://developer.wordpress.org/reference/hooks/switch_blog/) - The $context parameter was added.
@@ -898,13 +932,13 @@ _No new actions in this version._
- [`wp_targeted_link_rel`](https://developer.wordpress.org/reference/hooks/wp_targeted_link_rel/) - Filters the rel values that are added to links with `target` attribute.
- [`wp_update_php_url`](https://developer.wordpress.org/reference/hooks/wp_update_php_url/) - Filters the URL to learn more about updating the PHP version the site is running on.
- [`wp_using_themes`](https://developer.wordpress.org/reference/hooks/wp_using_themes/) - Filters whether the current request should use themes.
-- [`x_redirect_by`](https://developer.wordpress.org/reference/hooks/x_redirect_by/) - Filters the X-Redirect-By header.
+- [`x_redirect_by`](https://developer.wordpress.org/reference/hooks/x_redirect_by/) - Filters the value of the `X-Redirect-By` HTTP header.
### Changes
- [`comment_status_links`](https://developer.wordpress.org/reference/hooks/comment_status_links/) - The 'Mine' link was added.
-- [`doing_it_wrong_trigger_error`](https://developer.wordpress.org/reference/hooks/doing_it_wrong_trigger_error/) - Added the $function_name, $message and $version parameters.
-- [`found_users_query`](https://developer.wordpress.org/reference/hooks/found_users_query/) - Added the $this parameter.
+- [`doing_it_wrong_trigger_error`](https://developer.wordpress.org/reference/hooks/doing_it_wrong_trigger_error/) - Added the $function_name, $message, and $version parameters.
+- [`found_users_query`](https://developer.wordpress.org/reference/hooks/found_users_query/) - Added the $query parameter.
- [`http_headers_useragent`](https://developer.wordpress.org/reference/hooks/http_headers_useragent/) - The $url parameter was added.
- [`http_request_redirection_count`](https://developer.wordpress.org/reference/hooks/http_request_redirection_count/) - The $url parameter was added.
- [`http_request_reject_unsafe_urls`](https://developer.wordpress.org/reference/hooks/http_request_reject_unsafe_urls/) - The $url parameter was added.
@@ -913,7 +947,7 @@ _No new actions in this version._
- [`https_local_ssl_verify`](https://developer.wordpress.org/reference/hooks/https_local_ssl_verify/) - The $url parameter was added.
- [`https_ssl_verify`](https://developer.wordpress.org/reference/hooks/https_ssl_verify/) - The $url parameter was added.
- [`lost_password`](https://developer.wordpress.org/reference/hooks/lost_password/) - Added the $errors parameter.
-- [`wp_check_filetype_and_ext`](https://developer.wordpress.org/reference/hooks/wp_check_filetype_and_ext/) - The $real_mime parameter was added.
+- [`wp_check_filetype_and_ext`](https://developer.wordpress.org/reference/hooks/wp_check_filetype_and_ext/) - The $real_mime parameter was added.
- [`wp_get_attachment_link`](https://developer.wordpress.org/reference/hooks/wp_get_attachment_link/) - Added the $attr parameter.
## WordPress 5.0
@@ -946,6 +980,7 @@ _No new actions in this version._
- [`render_block`](https://developer.wordpress.org/reference/hooks/render_block/) - Filters the content of a single block.
- [`rest_prepare_autosave`](https://developer.wordpress.org/reference/hooks/rest_prepare_autosave/) - Filters a revision returned from the REST API.
- [`rest_prepare_theme`](https://developer.wordpress.org/reference/hooks/rest_prepare_theme/) - Filters theme data returned from the REST API.
+- [`rest_revision_query`](https://developer.wordpress.org/reference/hooks/rest_revision_query/) - Filters WP_Query arguments when querying revisions via the REST API.
- [`rest_themes_collection_params`](https://developer.wordpress.org/reference/hooks/rest_themes_collection_params/) - Filters REST API collection parameters for the themes controller.
- [`update_{$meta_type}_metadata_by_mid`](https://developer.wordpress.org/reference/hooks/update_meta_type_metadata_by_mid/) - Short-circuits updating metadata of a specific type by meta ID.
- [`update_{$meta_type}_metadata_cache`](https://developer.wordpress.org/reference/hooks/update_meta_type_metadata_cache/) - Short-circuits updating the metadata cache of a specific type.
@@ -1290,7 +1325,7 @@ _No new actions in this version._
- [`admin_memory_limit`](https://developer.wordpress.org/reference/hooks/admin_memory_limit/) - The default now takes the original memory_limit into account.
- [`admin_post_thumbnail_html`](https://developer.wordpress.org/reference/hooks/admin_post_thumbnail_html/) - Added the $thumbnail_id parameter.
-- [`customize_value_{$id_base}`](https://developer.wordpress.org/reference/hooks/customize_value_id_base/) - Added the $this setting instance as the second parameter.
+- [`customize_value_{$id_base}`](https://developer.wordpress.org/reference/hooks/customize_value_id_base/) - Added the $setting instance as the second parameter.
- [`date_query_valid_columns`](https://developer.wordpress.org/reference/hooks/date_query_valid_columns/) - Added 'registered' and 'last_updated' to the default recognized columns.
- [`edit_comment`](https://developer.wordpress.org/reference/hooks/edit_comment/) - Added the $data parameter.
- [`fs_ftp_connection_types`](https://developer.wordpress.org/reference/hooks/fs_ftp_connection_types/) - The $context parameter default changed from false to an empty string.
@@ -1300,7 +1335,7 @@ _No new actions in this version._
- [`get_the_modified_time`](https://developer.wordpress.org/reference/hooks/get_the_modified_time/) - Added the $post parameter.
- [`image_memory_limit`](https://developer.wordpress.org/reference/hooks/image_memory_limit/) - The default now takes the original memory_limit into account.
- [`nav_menu_items_{$post_type_name}`](https://developer.wordpress.org/reference/hooks/nav_menu_items_post_type_name/) - Converted the $post_type parameter to accept a WP_Post_Type object.
-- [`registered_post_type`](https://developer.wordpress.org/reference/hooks/registered_post_type/) - Converted the $post_type parameter to accept a WP_Post_Type object.
+- [`registered_post_type`](https://developer.wordpress.org/reference/hooks/registered_post_type/) - Converted the $post_type parameter to accept a WP_Post_Type object.
- [`request_filesystem_credentials`](https://developer.wordpress.org/reference/hooks/request_filesystem_credentials/) - The $context parameter default changed from false to an empty string.
- [`restrict_manage_posts`](https://developer.wordpress.org/reference/hooks/restrict_manage_posts/) - The $which parameter was added.
- [`restrict_manage_users`](https://developer.wordpress.org/reference/hooks/restrict_manage_users/) - The $which parameter was added.
@@ -1403,7 +1438,7 @@ _No new actions in this version._
- [`register_new_user`](https://developer.wordpress.org/reference/hooks/register_new_user/) - Fires after a new user registration has been recorded.
- [`rest_api_init`](https://developer.wordpress.org/reference/hooks/rest_api_init/) - Fires when preparing to serve a REST API request.
- [`wp_add_nav_menu_item`](https://developer.wordpress.org/reference/hooks/wp_add_nav_menu_item/) - Fires immediately after a new navigation menu item has been added.
-- [`wp_mail_failed`](https://developer.wordpress.org/reference/hooks/wp_mail_failed/) - Fires after a PHPMailer\PHPMailer\Exception is caught.
+- [`wp_mail_failed`](https://developer.wordpress.org/reference/hooks/wp_mail_failed/) - Fires after a PHPMailer exception is caught.
- [`wp_verify_nonce_failed`](https://developer.wordpress.org/reference/hooks/wp_verify_nonce_failed/) - Fires when nonce verification fails.
### New Filters
@@ -1494,7 +1529,7 @@ _No new actions in this version._
- [`user_profile_picture_description`](https://developer.wordpress.org/reference/hooks/user_profile_picture_description/) - Filters the user profile picture description displayed under the Gravatar.
- [`users_list_table_query_args`](https://developer.wordpress.org/reference/hooks/users_list_table_query_args/) - Filters the query arguments used to retrieve users for the current users list table.
- [`view_mode_post_types`](https://developer.wordpress.org/reference/hooks/view_mode_post_types/) - Filters the post types that have different view mode options.
-- [`wp_calculate_image_sizes`](https://developer.wordpress.org/reference/hooks/wp_calculate_image_sizes/) - Filters the output of 'wp_calculate_image_sizes()'.
+- [`wp_calculate_image_sizes`](https://developer.wordpress.org/reference/hooks/wp_calculate_image_sizes/) - Filters the output of wp_calculate_image_sizes().
- [`wp_calculate_image_srcset`](https://developer.wordpress.org/reference/hooks/wp_calculate_image_srcset/) - Filters an image's 'srcset' sources.
- [`wp_dropdown_users_args`](https://developer.wordpress.org/reference/hooks/wp_dropdown_users_args/) - Filters the query arguments for the list of users in the dropdown.
- [`wp_http_ixr_client_headers`](https://developer.wordpress.org/reference/hooks/wp_http_ixr_client_headers/) - Filters the headers collection to be sent to the XML-RPC server.
@@ -1514,10 +1549,10 @@ _No new actions in this version._
- [`get_{$adjacent}_post_join`](https://developer.wordpress.org/reference/hooks/get_adjacent_post_join/) - Added the $taxonomy and $post parameters.
- [`get_{$adjacent}_post_sort`](https://developer.wordpress.org/reference/hooks/get_adjacent_post_sort/) - Added the $post parameter.
- [`get_{$adjacent}_post_where`](https://developer.wordpress.org/reference/hooks/get_adjacent_post_where/) - Added the $taxonomy and $post parameters.
-- [`get_{$taxonomy}`](https://developer.wordpress.org/reference/hooks/get_taxonomy/) - $_term is now a WP_Term object.
+- [`get_{$taxonomy}`](https://developer.wordpress.org/reference/hooks/get_taxonomy/) - $_term is now a WP_Term object.
- [`get_comment_link`](https://developer.wordpress.org/reference/hooks/get_comment_link/) - Added the $cpage parameter.
- [`get_sample_permalink_html`](https://developer.wordpress.org/reference/hooks/get_sample_permalink_html/) - Added $post parameter.
-- [`get_term`](https://developer.wordpress.org/reference/hooks/get_term/) - $_term is now a WP_Term object.
+- [`get_term`](https://developer.wordpress.org/reference/hooks/get_term/) - $_term is now a WP_Term object.
- [`get_the_categories`](https://developer.wordpress.org/reference/hooks/get_the_categories/) - Added the $post_id parameter.
- [`get_wp_title_rss`](https://developer.wordpress.org/reference/hooks/get_wp_title_rss/) - The $sep parameter was deprecated and renamed to $deprecated.
- [`hidden_columns`](https://developer.wordpress.org/reference/hooks/hidden_columns/) (4.4.1) - Added the use_defaults parameter.
@@ -1548,7 +1583,7 @@ _No new actions in this version._
- [`theme_{$post_type}_templates`](https://developer.wordpress.org/reference/hooks/theme_post_type_templates/) - Converted to allow complete control over the $page_templates array.
- [`transient_{$transient}`](https://developer.wordpress.org/reference/hooks/transient_transient/) - The $transient parameter was added
- [`update_option_{$option}`](https://developer.wordpress.org/reference/hooks/update_option_option/) - The $option parameter was added.
-- [`upgrader_source_selection`](https://developer.wordpress.org/reference/hooks/upgrader_source_selection/) - The $hook_extra parameter became available.
+- [`upgrader_source_selection`](https://developer.wordpress.org/reference/hooks/upgrader_source_selection/) - The $hook_extra parameter became available.
- [`widget_links_args`](https://developer.wordpress.org/reference/hooks/widget_links_args/) - Added the $instance parameter.
- [`widget_nav_menu_args`](https://developer.wordpress.org/reference/hooks/widget_nav_menu_args/) - Added the $instance parameter.
- [`widget_text`](https://developer.wordpress.org/reference/hooks/widget_text/) - Added the $widget parameter.
@@ -1856,7 +1891,7 @@ _No changes in this version._
- [`term_updated_messages`](https://developer.wordpress.org/reference/hooks/term_updated_messages/) - Filters the messages displayed when a tag is updated.
- [`themes_update_check_locales`](https://developer.wordpress.org/reference/hooks/themes_update_check_locales/) - Filters the locales requested for theme translations.
- [`update_translations_complete_actions`](https://developer.wordpress.org/reference/hooks/update_translations_complete_actions/) - Filters the list of action links available following a translations update.
-- [`upgrader_pre_download`](https://developer.wordpress.org/reference/hooks/upgrader_pre_download/) - Filters whether to return the package.
+- [`upgrader_pre_download`](https://developer.wordpress.org/reference/hooks/upgrader_pre_download/) - Filters whether to download a package for a WordPress core, plugin, theme, or translation upgrade.
- [`wp_count_attachments`](https://developer.wordpress.org/reference/hooks/wp_count_attachments/) - Filters the attachment counts by mime type.
- [`wp_count_posts`](https://developer.wordpress.org/reference/hooks/wp_count_posts/) - Filters the post counts by status for the current post type.
- [`wp_link_query`](https://developer.wordpress.org/reference/hooks/wp_link_query/) - Filters the link query results.
@@ -1865,7 +1900,6 @@ _No changes in this version._
### Changes
-- [`password_reset_key_expired`](https://developer.wordpress.org/reference/hooks/password_reset_key_expired/) - Previously plain-text keys were stored in the database.
- [`upgrader_process_complete`](https://developer.wordpress.org/reference/hooks/upgrader_process_complete/) - Added to WP_Upgrader::run().
- [`user_has_cap`](https://developer.wordpress.org/reference/hooks/user_has_cap/) - Added the $user parameter.
@@ -1937,7 +1971,7 @@ _No changes in this version._
- [`display_post_states`](https://developer.wordpress.org/reference/hooks/display_post_states/) - Added the $post parameter.
- [`set_transient_{$transient}`](https://developer.wordpress.org/reference/hooks/set_transient_transient/) - The $value and $expiration parameters were added.
-- [`set_user_role`](https://developer.wordpress.org/reference/hooks/set_user_role/) - Added $old_roles to include an array of the user's previous roles.
+- [`set_user_role`](https://developer.wordpress.org/reference/hooks/set_user_role/) - Added $old_roles to include an array of the user's previous roles.
## WordPress 3.5
@@ -2045,6 +2079,7 @@ _No changes in this version._
- [`allowed_http_origin`](https://developer.wordpress.org/reference/hooks/allowed_http_origin/) - Changes the allowed HTTP origin result.
- [`allowed_http_origins`](https://developer.wordpress.org/reference/hooks/allowed_http_origins/) - Changes the origin types allowed for HTTP requests.
+- [`autocomplete_users_for_site_admins`](https://developer.wordpress.org/reference/hooks/autocomplete_users_for_site_admins/) - Filters whether to enable user auto-complete for non-super admins in Multisite.
- [`current_theme_supports-{$feature}`](https://developer.wordpress.org/reference/hooks/current_theme_supports-feature/) - Filters whether the active theme supports a specific feature.
- [`customize_allowed_urls`](https://developer.wordpress.org/reference/hooks/customize_allowed_urls/) - Filters the list of URLs allowed to be clicked and followed in the Customizer preview.
- [`customize_sanitize_js_{$this->id}`](https://developer.wordpress.org/reference/hooks/customize_sanitize_js_this-id/) - Filters a Customize setting value for use in JavaScript.
@@ -2252,6 +2287,7 @@ _No changes in this version._
- [`show_admin_bar`](https://developer.wordpress.org/reference/hooks/show_admin_bar/) - Filters whether to show the admin bar.
- [`show_network_site_users_add_existing_form`](https://developer.wordpress.org/reference/hooks/show_network_site_users_add_existing_form/) - Filters whether to show the Add Existing User form on the Multisite Users screen.
- [`show_network_site_users_add_new_form`](https://developer.wordpress.org/reference/hooks/show_network_site_users_add_new_form/) - Filters whether to show the Add New User form on the Multisite Users screen.
+- [`show_recent_comments_widget_style`](https://developer.wordpress.org/reference/hooks/show_recent_comments_widget_style/) - Filters the Recent Comments default widget styles.
- [`single_term_title`](https://developer.wordpress.org/reference/hooks/single_term_title/) - Filters the custom taxonomy archive page title.
- [`terms_clauses`](https://developer.wordpress.org/reference/hooks/terms_clauses/) - Filters the terms query SQL clauses.
- [`the_comments`](https://developer.wordpress.org/reference/hooks/the_comments/) - Filters the comment query results.
@@ -2586,12 +2622,12 @@ _No changes in this version._
### Changes
- [`{$action}_prefilter`](https://developer.wordpress.org/reference/hooks/action_prefilter/) - as 'wp_handle_upload_prefilter'.
-- [`add_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/add_site_option_option/) - As "add_siteoption{$key}"
-- [`delete_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/delete_site_option_option/) - As "delete_siteoption{$key}"
-- [`pre_add_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/pre_add_site_option_option/) - As 'pre_add_siteoption' . $key
-- [`pre_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/pre_site_option_option/) - As 'pre_siteoption' . $key
+- [`add_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/add_site_option_option/) - As add_site_option_{$key}.
+- [`delete_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/delete_site_option_option/) - As delete_site_option_{$key}.
+- [`pre_add_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/pre_add_site_option_option/) - As pre_add_site_option_{$key}.
+- [`pre_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/pre_site_option_option/) - As pre_site_option_{$key}.
- [`pre_update_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/pre_update_site_option_option/) - As 'pre_update_siteoption' . $key
-- [`site_option_{$option}`](https://developer.wordpress.org/reference/hooks/site_option_option/) - As 'siteoption' . $key
+- [`site_option_{$option}`](https://developer.wordpress.org/reference/hooks/site_option_option/) - As site_option_{$key}.
- [`update_site_option_{$option}`](https://developer.wordpress.org/reference/hooks/update_site_option_option/) - As "update_siteoption{$key}"
## WordPress 2.8
@@ -3455,7 +3491,7 @@ _No changes in this version._
### Changes
-- [`option_{$option}`](https://developer.wordpress.org/reference/hooks/option_option/) - As 'option_' . $setting
+- [`option_{$option}`](https://developer.wordpress.org/reference/hooks/option_option/) - As option_{$setting}.
## WordPress 1.2
diff --git a/ISSUES.md b/ISSUES.md
index 022e22c..d882229 100644
--- a/ISSUES.md
+++ b/ISSUES.md
@@ -8,7 +8,7 @@ This document lists known data quality issues in the hooks JSON files.
## Duplicate Filters
-_No duplicate filters._
+- `rest_block_hooks_post_types`
## Missing @since Tags
@@ -35,9 +35,6 @@ _No hooks with invalid variable names._
Hooks with `@param` tags that have an empty description.
- `block_core_navigation_render_inner_blocks` — $inner_blocks (wp-includes/blocks/navigation.php)
-- `render_block_core_navigation_link_allowed_post_status` — $attributes (wp-includes/blocks/navigation-link.php)
-- `render_block_core_navigation_link_allowed_post_status` — $block (wp-includes/blocks/navigation-link.php)
-- `render_block_core_navigation_link_allowed_post_status` — $post_status (wp-includes/blocks/navigation-link.php)
- `should_load_remote_block_patterns` — $should_load_remote (wp-includes/block-patterns.php)
- `the_weekday` — $the_weekday (wp-includes/general-template.php)
@@ -46,14 +43,12 @@ Hooks with `@param` tags that have an empty description.
Hooks where all `@since` tags have descriptions, indicating the original version is missing.
- `{$action}_prefilter` (wp-admin/includes/file.php)
-- `password_reset_key_expired` (wp-includes/user.php)
## Param Count Mismatches
Hooks where the number of `@param` tags does not match the `args` count.
-- `wp_default_autoload_value` — args: 4, params: 3 (wp-includes/option.php)
-- `wp_next_scheduled` — args: 4, params: 3 (wp-includes/cron.php)
+_No hooks with param count mismatches._
## Empty Param Types
@@ -65,6 +60,5 @@ _No hooks with empty param types._
Hooks with `@param` tags where types are not valid PHP docblock types.
-- `block_editor_rest_api_preload_paths` — $preload_paths: `(string` (wp-includes/block-editor.php)
-- `block_editor_rest_api_preload_paths` — $preload_paths: `string[])[]` (wp-includes/block-editor.php)
+- `block_editor_rest_api_preload_paths` — $preload_paths: `(string|string[])[]` (wp-includes/block-editor.php)
diff --git a/composer.json b/composer.json
index c1eac1f..018ea85 100644
--- a/composer.json
+++ b/composer.json
@@ -33,7 +33,7 @@
"wp-hooks/generator": "1.0.0",
"oomphinc/composer-installers-extender": "^2",
"roots/wordpress-core-installer": "^1.0.0",
- "roots/wordpress-full": "6.9"
+ "roots/wordpress-full": "7.0"
},
"extra": {
"wordpress-install-dir": "vendor/wordpress/wordpress",
@@ -42,6 +42,7 @@
"wp-admin/includes/deprecated.php",
"wp-admin/includes/ms-deprecated.php",
"wp-content/",
+ "wp-includes/build/pages/",
"wp-includes/deprecated.php",
"wp-includes/ID3/",
"wp-includes/ms-deprecated.php",
diff --git a/hooks/actions.json b/hooks/actions.json
index f9d545b..03fceeb 100644
--- a/hooks/actions.json
+++ b/hooks/actions.json
@@ -104,7 +104,7 @@
{
"name": "since",
"content": "6.4.0",
- "description": "The post_id parameter was added."
+ "description": "The $post_id parameter was added."
},
{
"name": "param",
@@ -409,19 +409,21 @@
},
{
"name": "param",
- "content": "Post type.",
+ "content": "The type of the current object that meta boxes were added to. Can be 'post', 'page', custom post types, 'comment', or 'link'.",
"types": [
"string"
],
- "variable": "$post_type"
+ "variable": "$object_type"
},
{
"name": "param",
- "content": "Post object.",
+ "content": "The post, comment, or link object. Type varies depending on $object_type.",
"types": [
- "\\WP_Post"
+ "\\WP_Post",
+ "\\WP_Comment",
+ "object"
],
- "variable": "$post"
+ "variable": "$object"
}
],
"long_description_html": ""
@@ -482,6 +484,8 @@
"name": "add_meta_boxes_{$post_type}",
"aliases": [
"add_meta_boxes_attachment",
+ "add_meta_boxes_comment",
+ "add_meta_boxes_link",
"add_meta_boxes_page",
"add_meta_boxes_post"
],
@@ -489,7 +493,7 @@
"type": "action",
"doc": {
"description": "Fires after all built-in meta boxes have been added, contextually for the given post type.",
- "long_description": "The dynamic portion of the hook name, `$post_type`, refers to the post type of the post.\n Possible hook names include:\n\n - `add_meta_boxes_post`\n - `add_meta_boxes_page`\n - `add_meta_boxes_attachment`",
+ "long_description": "The dynamic portion of the hook name, `$post_type`, refers to the post type of the post, or the object type (comment, link).\n Possible hook names include:\n\n - `add_meta_boxes_post`\n - `add_meta_boxes_page`\n - `add_meta_boxes_attachment`\n - `add_meta_boxes_comment`\n - `add_meta_boxes_link`",
"tags": [
{
"name": "since",
@@ -497,14 +501,16 @@
},
{
"name": "param",
- "content": "Post object.",
+ "content": "The post, comment, or link object. Type varies depending on the hook name.",
"types": [
- "\\WP_Post"
+ "\\WP_Post",
+ "\\WP_Comment",
+ "object"
],
- "variable": "$post"
+ "variable": "$object"
}
],
- "long_description_html": "The dynamic portion of the hook name, $post_type, refers to the post type of the post.
Possible hook names include:
add_meta_boxes_postadd_meta_boxes_pageadd_meta_boxes_attachmentThe dynamic portion of the hook name, $post_type, refers to the post type of the post, or the object type (comment, link).
Possible hook names include:
add_meta_boxes_postadd_meta_boxes_pageadd_meta_boxes_attachmentadd_meta_boxes_commentadd_meta_boxes_linkadd_site_option_{$key}."
},
{
"name": "since",
@@ -5727,7 +5733,7 @@
{
"name": "since",
"content": "2.9.0",
- "description": "As \"delete_siteoption{$key}\""
+ "description": "As delete_site_option_{$key}."
},
{
"name": "since",
@@ -7119,7 +7125,7 @@
"types": [
"string"
],
- "variable": "$post_type"
+ "variable": "$object_type"
},
{
"name": "param",
@@ -7137,7 +7143,7 @@
"object",
"string"
],
- "variable": "$post"
+ "variable": "$object"
}
],
"long_description_html": "Fires once for each of the default meta box contexts: normal, advanced, and side.
" @@ -8994,9 +9000,10 @@ }, { "name": "param", - "content": "Return null if new fields are added.", + "content": "Default 'noform'. Return null if new fields are added.", "types": [ - "null" + "null", + "string" ], "variable": "$return" }, @@ -9242,7 +9249,7 @@ "file": "wp-includes/load.php", "type": "action", "doc": { - "description": "Fires when `is_wp_error()` is called and its parameter is an instance of `WP_Error`.", + "description": "Fires when `is_wp_error()` is called and its parameter is an instance of WP_Error.", "long_description": "", "tags": [ { @@ -10301,6 +10308,43 @@ }, "args": 2 }, + { + "name": "manage_{$this->screen->id}_custom_column", + "aliases": [ + "manage_erase-personal-data_custom_column", + "manage_export-personal-data_custom_column" + ], + "file": "wp-admin/includes/class-wp-privacy-requests-table.php", + "type": "action", + "doc": { + "description": "Fires for each custom column of a specific request type in the Privacy Requests list table.", + "long_description": "Custom columns are registered using the {@see 'manage_export-personal-data_columns'} and the {@see 'manage_erase-personal-data_columns'} filters.\n The dynamic portion of the hook name, `$this->screen->id`, refers to the ID given to the list table according to which screen it's displayed on.\n Possible hook names include:\n\n - `manage_export-personal-data_custom_column`\n - `manage_erase-personal-data_custom_column`", + "tags": [ + { + "name": "since", + "content": "5.7.0" + }, + { + "name": "param", + "content": "The name of the column to display.", + "types": [ + "string" + ], + "variable": "$column_name" + }, + { + "name": "param", + "content": "The item being shown.", + "types": [ + "\\WP_User_Request" + ], + "variable": "$item" + } + ], + "long_description_html": "Custom columns are registered using the {@see 'manage_export-personal-data_columns'} and the {@see 'manage_erase-personal-data_columns'} filters.
The dynamic portion of the hook name, $this->screen->id, refers to the ID given to the list table according to which screen it's displayed on.
Possible hook names include:
manage_export-personal-data_custom_columnmanage_erase-personal-data_custom_column$user parameter was added."
},
{
"name": "param",
@@ -12062,7 +12106,7 @@
"type": "action_reference",
"doc": {
"description": "Fires after the query variable object is created, but before the actual query is run.",
- "long_description": "Note: If using conditional tags, use the method versions within the passed instance (e.g. $this->is_main_query() instead of is_main_query()). This is because the functions like is_main_query() test against the global $wp_query instance, not the passed one.",
+ "long_description": "Note: If using conditional tags, use the method versions within the passed instance (e.g. `$query->is_main_query()` instead of `is_main_query()`). This is because the functions like `is_main_query()` test against the global `$wp_query` instance, not the passed one.",
"tags": [
{
"name": "since",
@@ -12077,7 +12121,7 @@
"variable": "$query"
}
],
- "long_description_html": "Note: If using conditional tags, use the method versions within the passed instance (e.g. $this->is_main_query() instead of is_main_query()). This is because the functions like is_main_query() test against the global $wp_query instance, not the passed one.
" + "long_description_html": "Note: If using conditional tags, use the method versions within the passed instance (e.g. $query->is_main_query() instead of is_main_query()). This is because the functions like is_main_query() test against the global $wp_query instance, not the passed one.
$post_type parameter to accept a WP_Post_Type object."
+ "description": "Converted the $post_type parameter to accept a WP_Post_Type object."
},
{
"name": "param",
@@ -15409,7 +15453,7 @@
{
"name": "since",
"content": "3.6.0",
- "description": "Added $old_roles to include an array of the user's previous roles."
+ "description": "Added $old_roles to include an array of the user's previous roles."
},
{
"name": "param",
@@ -18240,6 +18284,31 @@
},
"args": 3
},
+ {
+ "name": "wp_ai_client_{$event_name}",
+ "file": "wp-includes/ai-client/adapters/class-wp-ai-client-event-dispatcher.php",
+ "type": "action",
+ "doc": {
+ "description": "Fires when an AI client event is dispatched.",
+ "long_description": "The dynamic portion of the hook name, `$event_name`, refers to the snake_case version of the event class name, without the `_event` suffix.\n For example, an event class named `BeforeGenerateResultEvent` will fire the `wp_ai_client_before_generate_result` action hook.\n In practice, the available action hook names are:\n - wp_ai_client_before_generate_result - wp_ai_client_after_generate_result",
+ "tags": [
+ {
+ "name": "since",
+ "content": "7.0.0"
+ },
+ {
+ "name": "param",
+ "content": "The event object.",
+ "types": [
+ "object"
+ ],
+ "variable": "$event"
+ }
+ ],
+ "long_description_html": "The dynamic portion of the hook name, $event_name, refers to the snake_case version of the event class name, without the _event suffix.
For example, an event class named BeforeGenerateResultEvent will fire the wp_ai_client_before_generate_result action hook.
In practice, the available action hook names are:
Built-in connectors and any AI providers auto-discovered from the WP AI Client registry have already been registered at this point and cannot be unhooked.
AI provider plugins that register with the WP AI Client do not need to use this action \u2014 their connectors are created automatically. This action is primarily for registering non-AI-provider connectors or overriding metadata on existing connectors.
Use $registry->register() within this action to add new connectors. To override an existing connector, unregister it first, then re-register with updated data.
Example \u2014 overriding metadata on an auto-discovered connector:
add_action( 'wp_connectors_init', function ( WP_Connector_Registry $registry ) { if ( $registry->is_registered( 'anthropic' ) ) { $connector = $registry->unregister( 'anthropic' ); $connector['description'] = __( 'Custom description for Anthropic.', 'my-plugin' ); $registry->register( 'anthropic', $connector ); } } );$embeds element was added to the $mail_data array."
+ },
{
"name": "param",
- "content": "{ An array containing the email recipient(s), subject, message, headers, and attachments. @type string[] $to Email addresses to send message. @type string $subject Email subject. @type string $message Message contents. @type string[] $headers Additional headers. @type string[] $attachments Paths to files to attach. @type string[] $embeds Paths to files to embed. }",
+ "content": "{ An array containing the email recipient(s), subject, message, headers, attachments, and embeds. @type string[] $to Email addresses to send message. @type string $subject Email subject. @type string $message Message contents. @type string[] $headers Additional headers. @type string[] $attachments Paths to files to attach. @type string[] $embeds Paths to files to embed. }",
"types": [
"array"
],
@@ -20336,6 +20435,47 @@
},
"args": 2
},
+ {
+ "name": "wp_trigger_error_always_run",
+ "file": "wp-includes/functions.php",
+ "type": "action",
+ "doc": {
+ "description": "Always fires when the given function triggers a user-level error/warning/notice/deprecation message.",
+ "long_description": "Can be used to attach custom error handlers even if WP_DEBUG is not truthy.",
+ "tags": [
+ {
+ "name": "since",
+ "content": "7.0.0"
+ },
+ {
+ "name": "param",
+ "content": "The function that triggered the error.",
+ "types": [
+ "string"
+ ],
+ "variable": "$function_name"
+ },
+ {
+ "name": "param",
+ "content": "The message explaining the error.",
+ "types": [
+ "string"
+ ],
+ "variable": "$message"
+ },
+ {
+ "name": "param",
+ "content": "The designated error type for this error.",
+ "types": [
+ "int"
+ ],
+ "variable": "$error_level"
+ }
+ ],
+ "long_description_html": "Can be used to attach custom error handlers even if WP_DEBUG is not truthy.
" + }, + "args": 3 + }, { "name": "wp_trigger_error_run", "file": "wp-includes/functions.php", @@ -20350,7 +20490,7 @@ }, { "name": "param", - "content": "The function that was called.", + "content": "The function that triggered the error.", "types": [ "string" ], @@ -20358,7 +20498,7 @@ }, { "name": "param", - "content": "A message explaining what has been done incorrectly.", + "content": "The message explaining the error.", "types": [ "string" ], diff --git a/hooks/filters.json b/hooks/filters.json index 91b051d..f41fc92 100644 --- a/hooks/filters.json +++ b/hooks/filters.json @@ -264,7 +264,7 @@ "file": "wp-includes/post.php", "type": "filter", "doc": { - "description": "Filters whether or not to add a `__trashed` suffix to trashed posts that match the name of the updated post.", + "description": "Filters whether or not to add a `__trashed` suffix to the name of trashed posts that match the name of the updated post.", "long_description": "", "tags": [ { @@ -2805,6 +2805,72 @@ }, "args": 2 }, + { + "name": "block_core_breadcrumbs_items", + "file": "wp-includes/blocks/breadcrumbs.php", + "type": "filter", + "doc": { + "description": "Filters the breadcrumb items array before rendering.", + "long_description": "Allows developers to modify, add, or remove breadcrumb items.", + "tags": [ + { + "name": "since", + "content": "7.0.0" + }, + { + "name": "param", + "content": "{ Array of breadcrumb item data. @type string $label The breadcrumb text. @type string $url Optional. The breadcrumb link URL. @type bool $allow_html Optional. Whether to allow HTML in the label. When true, the label will be sanitized with wp_kses_post(), allowing only safe HTML tags. When false or omitted, all HTML will be escaped with esc_html(). Default false. }", + "types": [ + "array[]" + ], + "variable": "$breadcrumb_items" + } + ], + "long_description_html": "Allows developers to modify, add, or remove breadcrumb items.
" + }, + "args": 1 + }, + { + "name": "block_core_breadcrumbs_post_type_settings", + "file": "wp-includes/blocks/breadcrumbs.php", + "type": "filter", + "doc": { + "description": "Filters breadcrumb settings (taxonomy and term selection) for a post or post type.", + "long_description": "Allows developers to specify which taxonomy and term should be used in the breadcrumb trail when a post type has multiple taxonomies or when a post is assigned to multiple terms within a taxonomy.", + "tags": [ + { + "name": "since", + "content": "7.0.0" + }, + { + "name": "param", + "content": "{ Array of breadcrumb settings. Default empty array. @type string $taxonomy Optional. Taxonomy slug to use for breadcrumbs. The taxonomy must be registered for the post type and have terms assigned to the post. If not found or has no terms, fall back to the first available taxonomy with terms. @type string $term Optional. Term slug to use when the post has multiple terms in the selected taxonomy. If the term is not found or not assigned to the post, fall back to the first term. If the post has only one term, that term is used regardless. }", + "types": [ + "array" + ], + "variable": "$settings" + }, + { + "name": "param", + "content": "The post type slug.", + "types": [ + "string" + ], + "variable": "$post_type" + }, + { + "name": "param", + "content": "The post ID.", + "types": [ + "int" + ], + "variable": "$post_id" + } + ], + "long_description_html": "Allows developers to specify which taxonomy and term should be used in the breadcrumb trail when a post type has multiple taxonomies or when a post is assigned to multiple terms within a taxonomy.
" + }, + "args": 3 + }, { "name": "block_core_navigation_listable_blocks", "file": "wp-includes/blocks/navigation.php", @@ -3004,7 +3070,7 @@ "name": "param", "content": "Array of paths to preload.", "types": [ - "string[]" + "(string|string[])[]" ], "variable": "$preload_paths" }, @@ -4184,7 +4250,7 @@ { "name": "since", "content": "6.6.0", - "description": "The default $seconds value changed from 30000000 to YEAR_IN_SECONDS." + "description": "The default$seconds value changed from 30000000 to YEAR_IN_SECONDS."
},
{
"name": "param",
@@ -7151,7 +7217,7 @@
{
"name": "since",
"content": "4.6.0",
- "description": "Added the $this setting instance as the second parameter."
+ "description": "Added the $setting instance as the second parameter."
},
{
"name": "param",
@@ -8050,6 +8116,31 @@
},
"args": 2
},
+ {
+ "name": "default_role_dropdown_excluded_roles",
+ "file": "wp-admin/options-general.php",
+ "type": "filter",
+ "doc": {
+ "description": "Filters the roles to be excluded from the default_role option.",
+ "long_description": "",
+ "tags": [
+ {
+ "name": "since",
+ "content": "7.0.0"
+ },
+ {
+ "name": "param",
+ "content": "Array of roles to exclude from the dropdown. Defaults to administrator and editor.",
+ "types": [
+ "string[]"
+ ],
+ "variable": "$roles_to_exclude"
+ }
+ ],
+ "long_description_html": ""
+ },
+ "args": 1
+ },
{
"name": "default_site_option_{$option}",
"file": "wp-includes/option.php",
@@ -9078,7 +9169,7 @@
{
"name": "since",
"content": "5.1.0",
- "description": "Added the $function_name, $message and $version parameters."
+ "description": "Added the $function_name, $message, and $version parameters."
},
{
"name": "param",
@@ -12152,7 +12243,7 @@
{
"name": "since",
"content": "5.1.0",
- "description": "Added the $this parameter."
+ "description": "Added the $query parameter."
},
{
"name": "global",
@@ -13186,7 +13277,8 @@
"name": "param",
"content": "Comment data.",
"types": [
- "\\WP_Comment"
+ "\\WP_Comment",
+ "null"
],
"variable": "$_comment"
}
@@ -14122,7 +14214,7 @@
{
"name": "since",
"content": "6.7.0",
- "description": "The $comment_id and $context parameters are now being passed to the filter."
+ "description": "The $comment_id and $context parameters are now being passed to the filter."
},
{
"name": "param",
@@ -15132,7 +15224,7 @@
"file": "wp-includes/post.php",
"type": "filter",
"doc": {
- "description": "Filters query arguments passed to WP_Query in get_pages.",
+ "description": "Filters query arguments passed to WP_Query in get_pages().",
"long_description": "",
"tags": [
{
@@ -15831,7 +15923,7 @@
{
"name": "since",
"content": "4.4.0",
- "description": "$_term is now a WP_Term object."
+ "description": "$_term is now a WP_Term object."
},
{
"name": "param",
@@ -17214,7 +17306,7 @@
{
"name": "since",
"content": "4.4.0",
- "description": "$_term is now a WP_Term object."
+ "description": "$_term is now a WP_Term object."
},
{
"name": "param",
@@ -19863,7 +19955,7 @@
},
{
"name": "param",
- "content": "{ Default meta values and keys for the user. @type string $nickname The user's nickname. Default is the user's username. @type string $first_name The user's first name. @type string $last_name The user's last name. @type string $description The user's description. @type string $rich_editing Whether to enable the rich-editor for the user. Default 'true'. @type string $syntax_highlighting Whether to enable the rich code editor for the user. Default 'true'. @type string $comment_shortcuts Whether to enable keyboard shortcuts for the user. Default 'false'. @type string $admin_color The color scheme for a user's admin screen. Default 'fresh'. @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL is not forced. @type string $show_admin_bar_front Whether to show the admin bar on the front end for the user. Default 'true'. @type string $locale User's locale. Default empty. }",
+ "content": "{ Default meta values and keys for the user. @type string $nickname The user's nickname. Default is the user's username. @type string $first_name The user's first name. @type string $last_name The user's last name. @type string $description The user's description. @type string $rich_editing Whether to enable the rich-editor for the user. Default 'true'. @type string $syntax_highlighting Whether to enable the rich code editor for the user. Default 'true'. @type string $comment_shortcuts Whether to enable keyboard shortcuts for the user. Default 'false'. @type string $admin_color The color scheme for a user's admin screen. Default 'modern'. @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL is not forced. @type string $show_admin_bar_front Whether to show the admin bar on the front end for the user. Default 'true'. @type string $locale User's locale. Default empty. }",
"types": [
"array"
],
@@ -21528,6 +21620,11 @@
"name": "since",
"content": "5.0.2"
},
+ {
+ "name": "since",
+ "content": "7.0.0",
+ "description": "The $is_module parameter was added."
+ },
{
"name": "param",
"content": "The relative path of the script. False if it could not be determined.",
@@ -21544,11 +21641,19 @@
"string"
],
"variable": "$src"
+ },
+ {
+ "name": "param",
+ "content": "Whether the source belongs to a script module (true) or a classic script (false).",
+ "types": [
+ "bool"
+ ],
+ "variable": "$is_module"
}
],
"long_description_html": ""
},
- "args": 2
+ "args": 3
},
{
"name": "load_script_translation_file",
@@ -22102,7 +22207,7 @@
"file": "wp-login.php",
"type": "filter",
"doc": {
- "description": "Filters default arguments for the Languages select input on the login screen.",
+ "description": "Filters default arguments for the Language select input on the login screen.",
"long_description": "The arguments get passed to the wp_dropdown_languages() function.",
"tags": [
{
@@ -22111,7 +22216,7 @@
},
{
"name": "param",
- "content": "Arguments for the Languages select input on the login screen.",
+ "content": "Arguments for the Language select input on the login screen.",
"types": [
"array"
],
@@ -26995,6 +27100,11 @@
"name": "since",
"content": "3.2.0"
},
+ {
+ "name": "since",
+ "content": "7.0.0",
+ "description": "Applied when wp-admin/options.php is accessed directly."
+ },
{
"name": "param",
"content": "The capability used for the page, which is manage_options by default.",
@@ -27019,7 +27129,7 @@
{
"name": "since",
"content": "1.5.0",
- "description": "As 'option_' . $setting"
+ "description": "As option_{$setting}."
},
{
"name": "since",
@@ -27738,12 +27848,11 @@
"type": "filter",
"doc": {
"description": "Filters the return value of check_password_reset_key() when an old-style key or an expired key is used.",
- "long_description": "",
+ "long_description": "Prior to 3.7, plain-text keys were stored in the database.",
"tags": [
{
"name": "since",
- "content": "3.7.0",
- "description": "Previously plain-text keys were stored in the database."
+ "content": "3.7.0"
},
{
"name": "since",
@@ -27767,7 +27876,7 @@
"variable": "$user_id"
}
],
- "long_description_html": ""
+ "long_description_html": "Prior to 3.7, plain-text keys were stored in the database.
" }, "args": 2 }, @@ -28430,6 +28539,47 @@ }, "args": 1 }, + { + "name": "plugins_list_status_text", + "file": "wp-admin/includes/class-wp-plugins-list-table.php", + "type": "filter", + "doc": { + "description": "Filters the status text of default switch case in the plugins list table.", + "long_description": "", + "tags": [ + { + "name": "since", + "content": "7.0.0" + }, + { + "name": "param", + "content": "Plugins list status text. Default empty string.", + "types": [ + "string" + ], + "variable": "$text" + }, + { + "name": "param", + "content": "Count of the number of plugins.", + "types": [ + "int" + ], + "variable": "$count" + }, + { + "name": "param", + "content": "The status slug being filtered.", + "types": [ + "string" + ], + "variable": "$type" + } + ], + "long_description_html": "" + }, + "args": 3 + }, { "name": "plugins_update_check_locales", "file": "wp-includes/update.php", @@ -30770,7 +30920,7 @@ { "name": "since", "content": "2.9.0", - "description": "As 'pre_add_siteoption' . $key" + "description": "Aspre_add_site_option_{$key}."
},
{
"name": "since",
@@ -30914,7 +31064,7 @@
{
"name": "since",
"content": "5.7.0",
- "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
+ "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
},
{
"name": "param",
@@ -33008,7 +33158,7 @@
{
"name": "since",
"content": "5.7.0",
- "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
+ "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
},
{
"name": "param",
@@ -33056,7 +33206,7 @@
{
"name": "since",
"content": "5.7.0",
- "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
+ "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
},
{
"name": "param",
@@ -33271,7 +33421,7 @@
{
"name": "since",
"content": "2.9.0",
- "description": "As 'pre_siteoption' . $key"
+ "description": "As pre_site_option_{$key}."
},
{
"name": "since",
@@ -33533,7 +33683,7 @@
{
"name": "since",
"content": "5.7.0",
- "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
+ "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
},
{
"name": "param",
@@ -33597,7 +33747,7 @@
{
"name": "since",
"content": "5.7.0",
- "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
+ "description": "The $wp_error parameter was added, and a WP_Error object can now be returned."
},
{
"name": "param",
@@ -34193,7 +34343,7 @@
"file": "wp-includes/functions.php",
"type": "filter",
"doc": {
- "description": "Filters the result of wp_filesize before the PHP function is run.",
+ "description": "Filters the result of wp_filesize() before the file_exists() PHP function is run.",
"long_description": "",
"tags": [
{
@@ -34412,6 +34562,11 @@
"name": "since",
"content": "5.7.0"
},
+ {
+ "name": "since",
+ "content": "6.9.0",
+ "description": "The $embeds element was added to the $atts array."
+ },
{
"name": "param",
"content": "Short-circuit return value.",
@@ -35167,6 +35322,39 @@
},
"args": 3
},
+ {
+ "name": "propagate_network_user_spam_to_blogs",
+ "file": "wp-admin/network/users.php",
+ "type": "filter",
+ "doc": {
+ "description": "Filters whether to propagate the blog status when a user is marked as spam.",
+ "long_description": "",
+ "tags": [
+ {
+ "name": "since",
+ "content": "7.0.0"
+ },
+ {
+ "name": "param",
+ "content": "Whether to propagate the blog status. Default false.",
+ "types": [
+ "bool"
+ ],
+ "variable": "$propagate"
+ },
+ {
+ "name": "param",
+ "content": "User ID.",
+ "types": [
+ "int"
+ ],
+ "variable": "$user_id"
+ }
+ ],
+ "long_description_html": ""
+ },
+ "args": 2
+ },
{
"name": "protected_title_format",
"file": "wp-includes/post-template.php",
@@ -36540,7 +36728,7 @@
},
{
"name": "render_block_core_navigation_link_allowed_post_status",
- "file": "wp-includes/blocks/navigation-link.php",
+ "file": "wp-includes/blocks/navigation-link/shared/item-should-render.php",
"type": "filter",
"doc": {
"description": "Filter allowed post_status for navigation link block to render.",
@@ -36552,7 +36740,7 @@
},
{
"name": "param",
- "content": "",
+ "content": "Array of allowed post statuses.",
"types": [
"array"
],
@@ -36560,7 +36748,7 @@
},
{
"name": "param",
- "content": "",
+ "content": "Block attributes.",
"types": [
"array"
],
@@ -36568,7 +36756,7 @@
},
{
"name": "param",
- "content": "",
+ "content": "The parsed block.",
"types": [
"\\WP_Block"
],
@@ -36990,6 +37178,88 @@
},
"args": 1
},
+ {
+ "name": "rest_block_hooks_post_types",
+ "file": "wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php",
+ "type": "filter",
+ "doc": {
+ "description": "Filters which post types should have Block Hooks applied.",
+ "long_description": "Allows themes and plugins to add or remove post types that should have Block Hooks functionality enabled in the REST API.",
+ "tags": [
+ {
+ "name": "since",
+ "content": "7.0.0"
+ },
+ {
+ "name": "param",
+ "content": "Array of post type names that support Block Hooks.",
+ "types": [
+ "array"
+ ],
+ "variable": "$content_like_post_types"
+ },
+ {
+ "name": "param",
+ "content": "The current post type being processed.",
+ "types": [
+ "string"
+ ],
+ "variable": "$post_type"
+ },
+ {
+ "name": "param",
+ "content": "The prepared post object.",
+ "types": [
+ "object"
+ ],
+ "variable": "$prepared_post"
+ }
+ ],
+ "long_description_html": "Allows themes and plugins to add or remove post types that should have Block Hooks functionality enabled in the REST API.
" + }, + "args": 3 + }, + { + "name": "rest_block_hooks_post_types", + "file": "wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php", + "type": "filter", + "doc": { + "description": "Filters which post types should have Block Hooks applied.", + "long_description": "Allows themes and plugins to add or remove post types that should have Block Hooks functionality enabled in the REST API.", + "tags": [ + { + "name": "since", + "content": "7.0.0" + }, + { + "name": "param", + "content": "Array of post type names that support Block Hooks.", + "types": [ + "array" + ], + "variable": "$content_like_post_types" + }, + { + "name": "param", + "content": "The current post type being processed.", + "types": [ + "string" + ], + "variable": "$post_type" + }, + { + "name": "param", + "content": "The post object.", + "types": [ + "\\WP_Post" + ], + "variable": "$post" + } + ], + "long_description_html": "Allows themes and plugins to add or remove post types that should have Block Hooks functionality enabled in the REST API.
" + }, + "args": 3 + }, { "name": "rest_comment_collection_params", "file": "wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php", @@ -39358,6 +39628,39 @@ }, "args": 1 }, + { + "name": "rest_revision_query", + "file": "wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php", + "type": "filter", + "doc": { + "description": "Filters WP_Query arguments when querying revisions via the REST API.", + "long_description": "Serves the same purpose as the {@see 'rest_{$this->post_type}_query'} filter in WP_REST_Posts_Controller, but for the standalone WP_REST_Revisions_Controller.", + "tags": [ + { + "name": "since", + "content": "5.0.0" + }, + { + "name": "param", + "content": "Array of arguments for WP_Query.", + "types": [ + "array" + ], + "variable": "$args" + }, + { + "name": "param", + "content": "The REST API request.", + "types": [ + "\\WP_REST_Request" + ], + "variable": "$request" + } + ], + "long_description_html": "Serves the same purpose as the {@see 'rest_{$this->post_type}_query'} filter in WP_REST_Posts_Controller, but for the standalone WP_REST_Revisions_Controller.
" + }, + "args": 2 + }, { "name": "rest_route_data", "file": "wp-includes/rest-api/class-wp-rest-server.php", @@ -43504,7 +43807,7 @@ { "name": "since", "content": "2.9.0", - "description": "As 'siteoption' . $key" + "description": "Assite_option_{$key}."
},
{
"name": "since",
@@ -43721,7 +44024,7 @@
"type": "filter",
"doc": {
"description": "Filters the list of cache headers supported by core.",
- "long_description": "",
+ "long_description": "This list indicates how each of the specified headers will be checked to indicate if a page cache is enabled or not. WordPress checks for each of the headers in the returned array. If the callback is provided, it will be passed the value for the corresponding header and return a boolean value indicating if the header suggests that a cache is active. If the value is `null` for the header, then WordPress will assume that a cache is active if the header is present, regardless of its value.",
"tags": [
{
"name": "since",
@@ -43729,14 +44032,14 @@
},
{
"name": "param",
- "content": "Array of supported cache headers.",
+ "content": "Mapping from cache-related HTTP headers to whether they indicate if a page cache is enabled for the site. null indicates caching in the presence of the header; a callback is provided the header\u2019s value and should return true if it implies that a cache is active.",
"types": [
- "array"
+ "arrayThis list indicates how each of the specified headers will be checked to indicate if a page cache is enabled or not. WordPress checks for each of the headers in the returned array. If the callback is provided, it will be passed the value for the corresponding header and return a boolean value indicating if the header suggests that a cache is active. If the value is null for the header, then WordPress will assume that a cache is active if the header is present, regardless of its value.
$author and $title parameters."
+ },
{
"name": "param",
"content": "HTML link.",
@@ -45778,11 +46086,27 @@
"string"
],
"variable": "$link"
+ },
+ {
+ "name": "param",
+ "content": "Author's display name.",
+ "types": [
+ "string"
+ ],
+ "variable": "$author"
+ },
+ {
+ "name": "param",
+ "content": "Text originally used for a title attribute.",
+ "types": [
+ "string"
+ ],
+ "variable": "$title"
}
],
"long_description_html": ""
},
- "args": 1
+ "args": 3
},
{
"name": "the_author_{$field}",
@@ -49384,8 +49708,8 @@
"file": "wp-admin/includes/class-wp-upgrader.php",
"type": "filter",
"doc": {
- "description": "Filters whether to return the package.",
- "long_description": "",
+ "description": "Filters whether to download a package for a WordPress core, plugin, theme, or translation upgrade.",
+ "long_description": "Return a non-false value to short-circuit the download and return that value instead.",
"tags": [
{
"name": "since",
@@ -49398,15 +49722,17 @@
},
{
"name": "param",
- "content": "Whether to bail without returning the package. Default false.",
+ "content": "Whether to short-circuit the download, the path to the downloaded package, or a WP_Error object. Default false.",
"types": [
- "bool"
+ "false",
+ "string",
+ "\\WP_Error"
],
"variable": "$reply"
},
{
"name": "param",
- "content": "The package file name.",
+ "content": "The package URI. May be a remote URL or local file path.",
"types": [
"string"
],
@@ -49429,7 +49755,7 @@
"variable": "$hook_extra"
}
],
- "long_description_html": ""
+ "long_description_html": "Return a non-false value to short-circuit the download and return that value instead.
" }, "args": 4 }, @@ -49482,13 +49808,14 @@ { "name": "since", "content": "4.4.0", - "description": "The $hook_extra parameter became available." + "description": "The$hook_extra parameter became available."
},
{
"name": "param",
- "content": "File source location.",
+ "content": "File source location or a WP_Error object.",
"types": [
- "string"
+ "string",
+ "\\WP_Error"
],
"variable": "$source"
},
@@ -52461,6 +52788,64 @@
},
"args": 3
},
+ {
+ "name": "wp_ai_client_default_request_timeout",
+ "file": "wp-includes/ai-client/class-wp-ai-client-prompt-builder.php",
+ "type": "filter",
+ "doc": {
+ "description": "Filters the default request timeout in seconds for AI Client HTTP requests.",
+ "long_description": "",
+ "tags": [
+ {
+ "name": "since",
+ "content": "7.0.0"
+ },
+ {
+ "name": "param",
+ "content": "The default timeout in seconds.",
+ "types": [
+ "float"
+ ],
+ "variable": "$default_timeout"
+ }
+ ],
+ "long_description_html": ""
+ },
+ "args": 1
+ },
+ {
+ "name": "wp_ai_client_prevent_prompt",
+ "file": "wp-includes/ai-client/class-wp-ai-client-prompt-builder.php",
+ "type": "filter",
+ "doc": {
+ "description": "Filters whether to prevent the prompt from being executed.",
+ "long_description": "",
+ "tags": [
+ {
+ "name": "since",
+ "content": "7.0.0"
+ },
+ {
+ "name": "param",
+ "content": "Whether to prevent the prompt. Default false.",
+ "types": [
+ "bool"
+ ],
+ "variable": "$prevent"
+ },
+ {
+ "name": "param",
+ "content": "A clone of the prompt builder instance (read-only).",
+ "types": [
+ "\\WP_AI_Client_Prompt_Builder"
+ ],
+ "variable": "$builder"
+ }
+ ],
+ "long_description_html": ""
+ },
+ "args": 2
+ },
{
"name": "wp_ajax_cropped_attachment_id",
"file": "wp-admin/includes/ajax-actions.php",
@@ -53048,7 +53433,7 @@
"file": "wp-includes/media.php",
"type": "filter",
"doc": {
- "description": "Filters the output of 'wp_calculate_image_sizes()'.",
+ "description": "Filters the output of wp_calculate_image_sizes().",
"long_description": "",
"tags": [
{
@@ -53224,7 +53609,7 @@
{
"name": "since",
"content": "5.1.0",
- "description": "The $real_mime parameter was added."
+ "description": "The $real_mime parameter was added."
},
{
"name": "param",
@@ -53752,6 +54137,14 @@
"mixed"
],
"variable": "$value"
+ },
+ {
+ "name": "param",
+ "content": "The passed option value to be saved, in serialized form.",
+ "types": [
+ "mixed"
+ ],
+ "variable": "$serialized_value"
}
],
"long_description_html": ""
@@ -54322,7 +54715,7 @@
{
"name": "since",
"content": "6.8.0",
- "description": "Added the size parameter."
+ "description": "Added the $size parameter."
},
{
"name": "param",
@@ -54777,6 +55170,36 @@
},
"args": 1
},
+ {
+ "name": "wp_get_archives_args",
+ "file": "wp-includes/general-template.php",
+ "type": "filter",
+ "doc": {
+ "description": "Filters the arguments for displaying archive links.",
+ "long_description": "",
+ "tags": [
+ {
+ "name": "since",
+ "content": "7.0.0"
+ },
+ {
+ "name": "see",
+ "content": "",
+ "refers": "wp_get_archives()"
+ },
+ {
+ "name": "param",
+ "content": "Arguments.",
+ "types": [
+ "array$algorithm parameter is now always a string."
+ },
{
"name": "param",
"content": "The hashing algorithm. Default is the value of the PASSWORD_BCRYPT constant.",
"types": [
- "string",
- "int"
+ "string"
],
"variable": "$algorithm"
}
],
- "long_description_html": "The default is the value of the PASSWORD_BCRYPT constant which means bcrypt is used.
Important: The only password hashing algorithm that is guaranteed to be available across PHP installations is bcrypt. If you use any other algorithm you must make sure that it is available on the server. The password_algos() function can be used to check which hashing algorithms are available.
The hashing options can be controlled via the {@see 'wp_hash_password_options'} filter.
Other available constants include:
PASSWORD_ARGON2IPASSWORD_ARGON2IDPASSWORD_DEFAULTThe values of the algorithm constants are strings in PHP 7.4+ and integers in PHP 7.3 and earlier.
" + "long_description_html": "The default is the value of the PASSWORD_BCRYPT constant which means bcrypt is used.
Important: The only password hashing algorithm that is guaranteed to be available across PHP installations is bcrypt. If you use any other algorithm you must make sure that it is available on the server. The password_algos() function can be used to check which hashing algorithms are available.
The hashing options can be controlled via the {@see 'wp_hash_password_options'} filter.
Other available constants include:
PASSWORD_ARGON2IPASSWORD_ARGON2IDPASSWORD_DEFAULT$algorithm parameter is now always a string."
+ },
{
"name": "param",
"content": "Array of options to pass to the password hashing functions. By default this is an empty array which means the default options will be used.",
@@ -55883,13 +56315,12 @@
"name": "param",
"content": "The hashing algorithm in use.",
"types": [
- "string",
- "int"
+ "string"
],
"variable": "$algorithm"
}
],
- "long_description_html": "The default hashing algorithm is bcrypt, but this can be changed via the {@see 'wp_hash_password_algorithm'} filter. You must ensure that the options are appropriate for the algorithm in use.
The values of the algorithm constants are strings in PHP 7.4+ and integers in PHP 7.3 and earlier.
" + "long_description_html": "The default hashing algorithm is bcrypt, but this can be changed via the {@see 'wp_hash_password_algorithm'} filter. You must ensure that the options are appropriate for the algorithm in use.
" }, "args": 2 }, @@ -56060,7 +56491,7 @@ "file": "wp-includes/media.php", "type": "filter", "doc": { - "description": "Filters the `loading` attribute value to add to an iframe. Default `lazy`.", + "description": "Filters the `loading` attribute value to add to an iframe. Default 'lazy'.", "long_description": "Returning `false` or an empty string will not add the attribute. Returning `true` will add the default value.", "tags": [ { @@ -56283,7 +56714,7 @@ "file": "wp-includes/media.php", "type": "filter", "doc": { - "description": "Filters the 'wp_image_src_get_dimensions' value.", + "description": "Filters the wp_image_src_get_dimensions() value.", "long_description": "", "tags": [ { @@ -56358,7 +56789,7 @@ "file": "wp-includes/media.php", "type": "filter", "doc": { - "description": "Filters the `decoding` attribute value to add to an image. Default `async`.", + "description": "Filters the `decoding` attribute value to add to an image. Default 'async'.", "long_description": "Returning a falsey value will omit the attribute.", "tags": [ { @@ -56401,7 +56832,7 @@ "file": "wp-includes/media.php", "type": "filter", "doc": { - "description": "Filters the `loading` attribute value to add to an image. Default `lazy`.", + "description": "Filters the `loading` attribute value to add to an image. Default 'lazy'.", "long_description": "Returning `false` or an empty string will not add the attribute. Returning `true` will add the default value.", "tags": [ { @@ -56593,7 +57024,7 @@ "name": "param", "content": "Key-value pairs representing<script> tag attributes. Only the attribute name is added to the <script> tag for entries with a boolean value, and that are true.",
"types": [
- "array"
+ "array$embeds element was added to the $args array."
+ },
{
"name": "param",
"content": "{ Array of the wp_mail() arguments. @type string|string[] $to Array or comma-separated list of email addresses to send message. @type string $subject Email subject. @type string $message Message contents. @type string|string[] $headers Additional headers. @type string|string[] $attachments Paths to files to attach. @type string|string[] $embeds Paths to files to embed. }",
@@ -58024,7 +58460,7 @@
},
{
"name": "param",
- "content": "{ An array of arguments for addEmbeddedImage(). @type string $path The path to the file. @type string $cid The Content-ID of the image. Default: The key in the embeds array. @type string $name The filename of the image. @type string $encoding The encoding of the image. Default: 'base64'. @type string $type The MIME type of the image. Default: empty string, which lets PHPMailer auto-detect. @type string $disposition The disposition of the image. Default: 'inline'. }",
+ "content": "{ An array of arguments for PHPMailer's addEmbeddedImage() method. @type string $path The path to the file. @type string $cid The Content-ID of the image. Default: The key in the embeds array. @type string $name The filename of the image. @type string $encoding The encoding of the image. Default: 'base64'. @type string $type The MIME type of the image. Default: empty string, which lets PHPMailer auto-detect. @type string $disposition The disposition of the image. Default: 'inline'. }",
"types": [
"array"
],
@@ -58662,6 +59098,14 @@
],
"variable": "$next_event"
},
+ {
+ "name": "param",
+ "content": "Action hook of the event.",
+ "types": [
+ "string"
+ ],
+ "variable": "$hook"
+ },
{
"name": "param",
"content": "Array containing each separate argument to pass to the hook callback function.",
@@ -61953,6 +62397,31 @@
},
"args": 1
},
+ {
+ "name": "wp_supports_ai",
+ "file": "wp-includes/ai-client.php",
+ "type": "filter",
+ "doc": {
+ "description": "Filters whether the current request can use AI.",
+ "long_description": "This allows plugins and 3rd-party code to disable AI features on a per-request basis, or to even override explicit preferences defined by the site owner.",
+ "tags": [
+ {
+ "name": "since",
+ "content": "7.0.0"
+ },
+ {
+ "name": "param",
+ "content": "Whether AI is available. Default to true.",
+ "types": [
+ "bool"
+ ],
+ "variable": "$is_enabled"
+ }
+ ],
+ "long_description_html": "This allows plugins and 3rd-party code to disable AI features on a per-request basis, or to even override explicit preferences defined by the site owner.
" + }, + "args": 1 + }, { "name": "wp_tag_cloud", "file": "wp-includes/category-template.php", @@ -62392,6 +62861,55 @@ }, "args": 2 }, + { + "name": "wp_trigger_error_trigger_error", + "file": "wp-includes/functions.php", + "type": "filter", + "doc": { + "description": "Filters whether to trigger an error.", + "long_description": "", + "tags": [ + { + "name": "since", + "content": "7.0.0" + }, + { + "name": "param", + "content": "Whether to trigger the error. Default true.", + "types": [ + "bool" + ], + "variable": "$trigger" + }, + { + "name": "param", + "content": "The function that triggered the error.", + "types": [ + "string" + ], + "variable": "$function_name" + }, + { + "name": "param", + "content": "The message explaining the error.", + "types": [ + "string" + ], + "variable": "$message" + }, + { + "name": "param", + "content": "The designated error type for this error.", + "types": [ + "int" + ], + "variable": "$error_level" + } + ], + "long_description_html": "" + }, + "args": 4 + }, { "name": "wp_trim_excerpt", "file": "wp-includes/formatting.php", @@ -64374,7 +64892,7 @@ "file": "wp-includes/pluggable.php", "type": "filter", "doc": { - "description": "Filters the X-Redirect-By header.", + "description": "Filters the value of the `X-Redirect-By` HTTP header.", "long_description": "Allows applications to identify themselves when they're doing a redirect.", "tags": [ {