Gutenberg icon
Page Builders & Blocks

Gutenberg hooks reference

  • By WordPress.org
  • v24.4.1 New
  • Updated

Gutenberg 24.4.1 has 37 actions and 68 filters, read directly from its source code on Nov 17, 2026. The list updates automatically when a new version is released.

How to use these hooks

Actions let you run your own code at a specific moment. Filters let you change a value before the plugin uses it. Put your code in a child theme's functions.php or a code-snippets plugin, never in the plugin's own files, because updates overwrite them.

functions.phpyour child theme
// Run your own code when Gutenberg fires an action
add_action( 'admin_footer', function( $hook_suffix ) {
	// Your code runs here.
}, 10, 1 );

// Change a value Gutenberg is about to use
add_filter( 'image_editor_output_format', function( $value, $arg2, $mime_type ) {
	// Change $value here.
	return $value;
}, 10, 3 );

Parts of a name in {braces} are filled in at runtime (for example a post type or field ID). Choose Example on any hook for a ready-to-edit snippet.

All hooks

  • admin_head

    action
    build/pages/dashboard/page.php line 281 · used in 9 places
    /**
     * This action is documented in wp-admin/admin-header.php
     */
    do_action( 'admin_head' );
  • build/pages/dashboard/page.php line 278 · used in 9 places
    /**
     * This action is documented in wp-admin/admin-header.php
     */
    do_action( "admin_head-{$hook_suffix}" );
  • lib/media/class-gutenberg-rest-attachments-controller.php line 436 · used in 3 places
    /**
     * This filter is documented in wp-includes/class-wp-image-editor.php
     */
    apply_filters( 'image_editor_output_format', array( $mime_type => $mime_type ), $filename ? $filename : '', $mime_type );
  • lib/experimental/dashboard-widgets/dashboard-layout.php line 89 · used in 2 places
    /**
     * Filters the default dashboard layout served to users who have not customized
     * theirs.
     */
    apply_filters( 'gutenberg_dashboard_default_layout', array(), GUTENBERG_DASHBOARD_NAME );
  • lib/media/class-gutenberg-rest-attachments-controller.php line 447 · used in 2 places
    /**
     * This filter is documented in wp-includes/class-wp-image-editor-imagick.php
     */
    apply_filters( 'image_save_progressive', false, $mime_type );
  • the_content

    filter
    build/scripts/block-library/post-content.php line 50 · used in 2 places
    /**
     * This filter is documented in wp-includes/post-template.php
     */
    apply_filters( 'the_content', str_replace( ']]>', ']]>', $content ) );
  • lib/class-wp-theme-json-resolver-gutenberg.php line 546 · used in 2 places
    /**
     * Filters the data provided by the user for global styles & settings.
     */
    apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data_Gutenberg( $config, 'custom' ) );
  • lib/experimental/collaboration/collaboration.php line 86
    /**
     * Filters the sync storage implementation for collaborative editing.
     */
    apply_filters( '__unstable_wp_sync_storage', new WP_Sync_Post_Meta_Storage() );
  • lib/media/load.php line 173
    /**
     * This filter is documented in wp-admin/includes/image.php
     */
    apply_filters( 'big_image_size_threshold', 2560, array( 0, 0 ), '', 0 );
  • build/scripts/block-library/breadcrumbs.php line 180
    /**
     * Filters the breadcrumb items array before rendering.
     */
    apply_filters( 'block_core_breadcrumbs_items', $breadcrumb_items );
  • build/scripts/block-library/breadcrumbs.php line 542
    /**
     * Filters breadcrumb settings (taxonomy and term selection) for a post or post
     * type.
     */
    apply_filters( 'block_core_breadcrumbs_post_type_settings', array(), $post_type, $post_id );
  • build/scripts/block-library/navigation.php line 215
    /**
     * Filter the list of blocks that need a list item wrapper.
     */
    apply_filters( 'block_core_navigation_listable_blocks', self::$needs_list_item_wrapper );
  • build/scripts/block-library/navigation.php line 1551
    /**
     * Filters the fallback experience for the Navigation block.
     */
    apply_filters( 'block_core_navigation_render_fallback', $fallback_blocks );
  • build/scripts/block-library/navigation.php line 563
    /**
     * Filter navigation block $inner_blocks. Allows modification of a navigation
     * block menu items.
     */
    apply_filters( 'block_core_navigation_render_inner_blocks', $inner_blocks );
  • build/scripts/block-library/comments.php line 223
    /**
     * This filter is documented in wp-includes/blocks.php
     */
    apply_filters( 'block_type_metadata', $metadata );
  • comment_text

    filter
    build/scripts/block-library/comment-content.php line 37
    /**
     * This filter is documented in wp-includes/comment-template.php
     */
    apply_filters( 'comment_text', $comment_text, $comment, $args );
  • build/pages/dashboard/page.php line 229
    /**
     * Filters the boot script-module dependencies for the dashboard page.
     */
    apply_filters( 'dashboard_boot_dependencies', $boot_dependencies );
  • build/pages/dashboard/page.php line 141
    /**
     * Fires when the dashboard page is initialized so extensions can register
     * routes and menu items.
     */
    do_action( 'dashboard_init' );
  • build/pages/dashboard/page-wp-admin.php line 257
    /**
     * Filters the boot script-module dependencies for the dashboard-wp-admin page.
     */
    apply_filters( 'dashboard-wp-admin_boot_dependencies', $boot_dependencies );
  • build/pages/dashboard/page-wp-admin.php line 153
    /**
     * Fires when the dashboard admin page is initialized so extensions can
     * register routes and menu items.
     */
    do_action( 'dashboard-wp-admin_init' );
  • build/scripts/block-library/latest-posts.php line 168
    /**
     * This filter is documented in wp-includes/formatting.php
     */
    apply_filters( 'excerpt_length', $block_core_latest_posts_excerpt_length );
  • build/pages/experiments/page.php line 229
    /**
     * Filters the boot script-module dependencies for the experiments page.
     */
    apply_filters( 'experiments_boot_dependencies', $boot_dependencies );
  • build/pages/experiments/page.php line 141
    /**
     * Fires when the experiments page is initialized so extensions can register
     * routes and menu items.
     */
    do_action( 'experiments_init' );
  • build/pages/experiments/page-wp-admin.php line 257
    /**
     * Filters the boot script-module dependencies for the experiments-wp-admin
     * page.
     */
    apply_filters( 'experiments-wp-admin_boot_dependencies', $boot_dependencies );
  • build/pages/experiments/page-wp-admin.php line 153
    /**
     * Fires when the experiments admin page is initialized so extensions can
     * register routes and menu items.
     */
    do_action( 'experiments-wp-admin_init' );
  • lib/media/class-gutenberg-rest-attachments-controller.php line 721
    /**
     * This filter is documented in wp-admin/includes/image.php
     */
    apply_filters( 'fallback_intermediate_image_sizes', $fallback_sizes, $metadata );
  • build/pages/font-library/page.php line 229
    /**
     * Filters the boot script-module dependencies for the font-library page.
     */
    apply_filters( 'font-library_boot_dependencies', $boot_dependencies );
  • build/pages/font-library/page.php line 141
    /**
     * Fires when the font-library page is initialized so extensions can register
     * routes and menu items.
     */
    do_action( 'font-library_init' );
  • build/pages/font-library/page-wp-admin.php line 257
    /**
     * Filters the boot script-module dependencies for the font-library-wp-admin
     * page.
     */
    apply_filters( 'font-library-wp-admin_boot_dependencies', $boot_dependencies );
  • build/pages/font-library/page-wp-admin.php line 153
    /**
     * Fires when the font-library admin page is initialized so extensions can
     * register routes and menu items.
     */
    do_action( 'font-library-wp-admin_init' );
  • build/pages/guidelines/page.php line 229
    /**
     * Filters the boot script-module dependencies for the guidelines page.
     */
    apply_filters( 'guidelines_boot_dependencies', $boot_dependencies );
  • build/pages/guidelines/page.php line 141
    /**
     * Fires when the guidelines page is initialized so extensions can register
     * routes and menu items.
     */
    do_action( 'guidelines_init' );
  • build/pages/guidelines/page-wp-admin.php line 257
    /**
     * Filters the boot script-module dependencies for the guidelines-wp-admin
     * page.
     */
    apply_filters( 'guidelines-wp-admin_boot_dependencies', $boot_dependencies );
  • build/pages/guidelines/page-wp-admin.php line 153
    /**
     * Fires when the guidelines admin page is initialized so extensions can
     * register routes and menu items.
     */
    do_action( 'guidelines-wp-admin_init' );
  • build/pages/dashboard/page-wp-admin.php line 107
    /**
     * Filters the REST API paths preloaded for this page.
     */
    apply_filters( 'gutenberg_dashboard_wp_admin_preload_paths', $preload_paths );
  • build/pages/experiments/page-wp-admin.php line 107
    /**
     * Filters the REST API paths preloaded for this page.
     */
    apply_filters( 'gutenberg_experiments_wp_admin_preload_paths', $preload_paths );
  • build/pages/font-library/page-wp-admin.php line 107
    /**
     * Filters the REST API paths preloaded for this page.
     */
    apply_filters( 'gutenberg_font_library_wp_admin_preload_paths', $preload_paths );
  • build/pages/guidelines/page-wp-admin.php line 107
    /**
     * Filters the REST API paths preloaded for this page.
     */
    apply_filters( 'gutenberg_guidelines_wp_admin_preload_paths', $preload_paths );
  • build/pages/media-editor/page-wp-admin.php line 107
    /**
     * Filters the REST API paths preloaded for this page.
     */
    apply_filters( 'gutenberg_media_editor_wp_admin_preload_paths', $preload_paths );
  • build/pages/options-connectors/page-wp-admin.php line 107
    /**
     * Filters the REST API paths preloaded for this page.
     */
    apply_filters( 'gutenberg_options_connectors_wp_admin_preload_paths', $preload_paths );
  • build/pages/site-editor-v2/page-wp-admin.php line 107
    /**
     * Filters the REST API paths preloaded for this page.
     */
    apply_filters( 'gutenberg_site_editor_v2_wp_admin_preload_paths', $preload_paths );
  • build/pages/theme-preview/page-wp-admin.php line 107
    /**
     * Filters the REST API paths preloaded for this page.
     */
    apply_filters( 'gutenberg_theme_preview_wp_admin_preload_paths', $preload_paths );
  • lib/media/load.php line 414
    /**
     * Filters whether to use Document-Isolation-Policy for cross-origin isolation.
     */
    apply_filters( 'gutenberg_use_document_isolation_policy', null !== $chromium_version && $chromium_version >= 137 );
  • lib/media/load.php line 187
    /**
     * This filter is documented in wp-includes/class-wp-image-editor-imagick.php
     */
    apply_filters( 'image_max_bit_depth', 16, 16 );
  • lib/media/load.php line 176
    /**
     * This filter is documented in wp-includes/class-wp-image-editor-imagick.php
     */
    apply_filters( 'image_strip_meta', true );
  • jpeg_quality

    filter
    lib/media/class-gutenberg-rest-attachments-controller.php line 1797
    /**
     * This filter is documented in wp-includes/class-wp-image-editor.php
     */
    apply_filters( 'jpeg_quality', $quality, 'image_resize' );
  • build/pages/media-editor/page.php line 229
    /**
     * Filters the boot script-module dependencies for the media-editor page.
     */
    apply_filters( 'media-editor_boot_dependencies', $boot_dependencies );
  • build/pages/media-editor/page.php line 141
    /**
     * Fires when the media-editor page is initialized so extensions can register
     * routes and menu items.
     */
    do_action( 'media-editor_init' );
  • build/pages/media-editor/page-wp-admin.php line 257
    /**
     * Filters the boot script-module dependencies for the media-editor-wp-admin
     * page.
     */
    apply_filters( 'media-editor-wp-admin_boot_dependencies', $boot_dependencies );
  • build/pages/media-editor/page-wp-admin.php line 153
    /**
     * Fires when the media-editor admin page is initialized so extensions can
     * register routes and menu items.
     */
    do_action( 'media-editor-wp-admin_init' );
  • build/pages/options-connectors/page.php line 229
    /**
     * Filters the boot script-module dependencies for the options-connectors page.
     */
    apply_filters( 'options-connectors_boot_dependencies', $boot_dependencies );
  • build/pages/options-connectors/page.php line 141
    /**
     * Fires when the options-connectors page is initialized so extensions can
     * register routes and menu items.
     */
    do_action( 'options-connectors_init' );
  • build/pages/options-connectors/page-wp-admin.php line 257
    /**
     * Filters the boot script-module dependencies for the
     * options-connectors-wp-admin page.
     */
    apply_filters( 'options-connectors-wp-admin_boot_dependencies', $boot_dependencies );
  • build/pages/options-connectors/page-wp-admin.php line 153
    /**
     * Fires when the options-connectors admin page is initialized so extensions
     * can register routes and menu items.
     */
    do_action( 'options-connectors-wp-admin_init' );
  • build/scripts/block-library/breadcrumbs.php line 462
    /**
     * This filter is documented in wp-includes/general-template.php
     */
    apply_filters( 'post_type_archive_title', $post_type_object->labels->archives, $post_type );
  • build/scripts/block-library/navigation-link/shared/item-should-render.php line 34
    /**
     * Filter allowed post_status for navigation link block to render.
     */
    apply_filters( 'render_block_core_navigation_link_allowed_post_status', array( 'publish' ), $attributes, $block );
  • build/scripts/block-library/template-part.php line 111
    /**
     * Fires when a block template part is loaded from a template part in the
     * theme.
     */
    do_action( 'render_block_core_template_part_file', $template_part_id, $attributes, $template_part_file_path, $content );
  • build/scripts/block-library/template-part.php line 122
    /**
     * Fires when a requested block template part does not exist in the database
     * nor in the theme.
     */
    do_action( 'render_block_core_template_part_none', $template_part_id, $attributes, $template_part_file_path );
  • build/scripts/block-library/template-part.php line 78
    /**
     * Fires when a block template part is loaded from a template post stored in
     * the database.
     */
    do_action( 'render_block_core_template_part_post', $template_part_id, $attributes, $template_part_post, $content );
  • lib/compat/wordpress-7.2/rest-api.php line 337
    /**
     * This filter is documented in
     * wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
     */
    apply_filters( "rest_{$post->post_type}_trashable", $supports_trash, $post );
  • lib/media/class-gutenberg-rest-attachments-controller.php line 559
    /**
     * This action is documented in
     * wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php
     */
    do_action( 'rest_after_insert_attachment', $attachment, $request, true );
  • lib/compat/wordpress-7.2/class-gutenberg-rest-comment-controller-7-2.php line 1017
    /**
     * This action is documented in
     * wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php
     */
    do_action( 'rest_after_insert_comment', $comment, $request, true );
  • lib/compat/wordpress-7.2/class-gutenberg-rest-comment-controller-7-2.php line 495
    /**
     * This filter is documented in
     * wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php
     */
    apply_filters( 'rest_allow_anonymous_comments', false, $request );
  • lib/compat/wordpress-7.2/rest-api.php line 368
    /**
     * This filter is documented in
     * wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php
     */
    apply_filters( 'rest_comment_trashable', ( EMPTY_TRASH_DAYS > 0 ), $comment );
  • lib/compat/wordpress-7.2/class-gutenberg-rest-comment-controller-7-2.php line 995
    /**
     * This action is documented in
     * wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php
     */
    do_action( 'rest_insert_comment', $comment, $request, true );
  • lib/compat/wordpress-7.2/class-gutenberg-rest-comment-controller-7-2.php line 922
    /**
     * This filter is documented in
     * wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php
     */
    apply_filters( 'rest_pre_insert_comment', $prepared_comment, $request );
  • build/pages/site-editor-v2/page.php line 229
    /**
     * Filters the boot script-module dependencies for the site-editor-v2 page.
     */
    apply_filters( 'site-editor-v2_boot_dependencies', $boot_dependencies );
  • build/pages/site-editor-v2/page.php line 141
    /**
     * Fires when the site-editor-v2 page is initialized so extensions can register
     * routes and menu items.
     */
    do_action( 'site-editor-v2_init' );
  • build/pages/site-editor-v2/page-wp-admin.php line 257
    /**
     * Filters the boot script-module dependencies for the site-editor-v2-wp-admin
     * page.
     */
    apply_filters( 'site-editor-v2-wp-admin_boot_dependencies', $boot_dependencies );
  • build/pages/site-editor-v2/page-wp-admin.php line 153
    /**
     * Fires when the site-editor-v2 admin page is initialized so extensions can
     * register routes and menu items.
     */
    do_action( 'site-editor-v2-wp-admin_init' );
  • build/pages/theme-preview/page.php line 229
    /**
     * Filters the boot script-module dependencies for the theme-preview page.
     */
    apply_filters( 'theme-preview_boot_dependencies', $boot_dependencies );
  • build/pages/theme-preview/page.php line 141
    /**
     * Fires when the theme-preview page is initialized so extensions can register
     * routes and menu items.
     */
    do_action( 'theme-preview_init' );
  • build/pages/theme-preview/page-wp-admin.php line 257
    /**
     * Filters the boot script-module dependencies for the theme-preview-wp-admin
     * page.
     */
    apply_filters( 'theme-preview-wp-admin_boot_dependencies', $boot_dependencies );
  • build/pages/theme-preview/page-wp-admin.php line 153
    /**
     * Fires when the theme-preview admin page is initialized so extensions can
     * register routes and menu items.
     */
    do_action( 'theme-preview-wp-admin_init' );
  • build/scripts/block-library/archives.php line 83
    /**
     * This filter is documented in
     * wp-includes/widgets/class-wp-widget-archives.php
     */
    apply_filters( 'widget_archives_args', array( 'type' => $type, 'show_post_count' => $show_post_count, ) );
  • build/scripts/block-library/archives.php line 33
    /**
     * This filter is documented in
     * wp-includes/widgets/class-wp-widget-archives.php
     */
    apply_filters( 'widget_archives_dropdown_args', array( 'type' => $type, 'format' => 'option', 'show_post_count' => $show_post_count, ) );
  • build/scripts/block-library/latest-comments.php line 55
    /**
     * This filter is documented in
     * wp-includes/widgets/class-wp-widget-recent-comments.php
     */
    apply_filters( 'widget_comments_args', array( 'number' => $attributes['commentsToShow'], 'status' => 'approve', 'post_status' => 'publish', ), array() );
  • lib/compat/wordpress-7.1/admin-bar.php line 31
    /**
     * This filter is documented in wp-includes/admin-bar.php
     */
    apply_filters( 'wp_admin_bar_show_site_icons', true );
  • lib/experimental/collaboration/collaboration.php line 240
    /**
     * This filter is documented in wp-admin/includes/ajax-actions.php
     */
    apply_filters( 'wp_check_post_lock_window', 150 );
  • lib/compat/wordpress-7.1/media.php line 26
    /**
     * Filters whether client-side media processing is enabled.
     */
    apply_filters( 'wp_client_side_media_processing_enabled', true );
  • lib/media/class-gutenberg-rest-attachments-controller.php line 1788
    /**
     * This filter is documented in wp-includes/class-wp-image-editor.php
     */
    apply_filters( 'wp_editor_set_quality', $default_quality, $mime_type, $size );
  • lib/compat/wordpress-7.2/class-wp-entity-fields-registry.php line 575
    /**
     * Fires the first time the registered fields are read, after `init`.
     */
    do_action( 'wp_entity_fields_api_init' );
  • lib/media/load.php line 209
    /**
     * Filters whether sub-sizes of animated images should keep their animation.
     */
    apply_filters( 'wp_generate_animated_image_subsizes', true );
  • lib/media/class-gutenberg-rest-attachments-controller.php line 1687
    /**
     * This filter is documented in wp-admin/includes/image.php
     */
    apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id, 'update' );
  • lib/experimental/knowledge/knowledge.php line 141
    /**
     * Filters the maximum length, in characters, of a guideline row's content.
     */
    apply_filters( 'wp_guideline_max_length', 5000 );
  • lib/experimental/knowledge/knowledge.php line 96
    /**
     * Filters the guideline scopes available on this site.
     */
    apply_filters( 'wp_guideline_scopes', array( 'site' => array( 'title' => __( 'Site', 'gutenberg' ), 'description' => __( "Describe your site's purpose, goals, and primary audience.", 'gutenberg' ), 'order' => 10, ), 'copy' => array( 'title' => __( 'Copy', 'gutenberg' ), 'description' => __( 'Set your writing standards for tone, voice, style, and formatting.', 'gutenberg' ), 'order' => 20, ), 'images' => array( 'title' => __( 'Image... );
  • lib/experimental/collaboration/collaboration.php line 180
    /**
     * Filters whether real-time collaboration is disabled for a post type.
     */
    apply_filters( 'wp_is_post_type_collaboration_disabled', false, $post_type );
  • lib/experimental/knowledge/knowledge.php line 44
    /**
     * Filters the knowledge types available on this site.
     */
    apply_filters( 'wp_knowledge_types', array( 'guideline' => array( 'title' => _x( 'Guideline', 'knowledge type', 'gutenberg' ), ), 'memory' => array( 'title' => _x( 'Memory', 'knowledge type', 'gutenberg' ), ), 'note' => array( 'title' => _x( 'Note', 'knowledge type', 'gutenberg' ), ), ) );
  • lib/class-wp-theme-json-resolver-gutenberg.php line 421
    /**
     * Filters the data provided by the blocks for global styles & settings.
     */
    apply_filters( 'wp_theme_json_data_blocks', new WP_Theme_JSON_Data_Gutenberg( $config, 'blocks' ) );
  • lib/class-wp-theme-json-resolver-gutenberg.php line 185
    /**
     * Filters the default data provided by WordPress for global styles & settings.
     */
    apply_filters( 'wp_theme_json_data_default', new WP_Theme_JSON_Data_Gutenberg( $config, 'default' ) );
  • lib/class-wp-theme-json-resolver-gutenberg.php line 293
    /**
     * Filters the data provided by the theme for global styles and settings.
     */
    apply_filters( 'wp_theme_json_data_theme', new WP_Theme_JSON_Data_Gutenberg( $theme_json_data, 'theme' ) );
  • lib/class-wp-theme-json-gutenberg.php line 3520
    /**
     * Filters the list of style nodes with metadata.
     */
    apply_filters( 'wp_theme_json_get_style_nodes', $nodes );
  • lib/experimental/class-wp-rest-block-editor-settings-controller.php line 427
    do_action( 'admin_enqueue_scripts', $hook_suffix );
  • lib/experimental/class-wp-rest-block-editor-settings-controller.php line 431
    do_action( 'admin_print_scripts' );
  • lib/experimental/class-wp-rest-block-editor-settings-controller.php line 430
    do_action( "admin_print_scripts-{$hook_suffix}" );
  • lib/experimental/class-wp-rest-block-editor-settings-controller.php line 429
    do_action( 'admin_print_styles' );
  • lib/experimental/class-wp-rest-block-editor-settings-controller.php line 428
    do_action( "admin_print_styles-{$hook_suffix}" );
  • lib/experimental/class-wp-rest-block-editor-settings-controller.php line 419
    do_action( 'enqueue_block_editor_assets' );
  • lib/compat/wordpress-7.2/class-wp-entity-actions-registry.php line 480
    do_action( 'wp_entity_actions_api_init' );

Generated from Gutenberg's GPL-licensed source code. Hooks inside bundled third-party libraries are not listed.

Can't find the right hook?

We can build the customisation for you. Describe what you need: