'editor-script', 'script' => 'script', 'editorStyle' => 'editor-style', 'style' => 'style', ); return str_replace( '/', '-', $block_name ) . '-' . $field_mappings[ $field_name ]; } /** * Finds a script handle for the selected block metadata field. It detects * when a path to file was provided and finds a corresponding * asset file with details necessary to register the script under * automatically generated handle name. It returns unprocessed script handle * otherwise. * * @since 5.5.0 * * @param array $metadata Block metadata. * @param string $field_name Field name to pick from metadata. * * @return string|boolean Script handle provided directly or created through * script's registration, or false on failure. */ function register_block_script_handle( $metadata, $field_name ) { if ( empty( $metadata[ $field_name ] ) ) { return false; } $script_handle = $metadata[ $field_name ]; $script_path = remove_block_asset_path_prefix( $metadata[ $field_name ] ); if ( $script_handle === $script_path ) { return $script_handle; } $script_handle = generate_block_asset_handle( $metadata['name'], $field_name ); $script_asset_path = realpath( dirname( $metadata['file'] ) . '/' . substr_replace( $script_path, '.asset.php', - strlen( '.js' ) ) ); if ( ! file_exists( $script_asset_path ) ) { $message = sprintf( /* translators: %1: field name. %2: block name */ __( 'The asset file for the "%1$s" defined in "%2$s" block definition is missing.', 'default' ), $field_name, $metadata['name'] ); _doing_it_wrong( __FUNCTION__, $message, '5.5.0' ); return false; } $script_asset = require( $script_asset_path ); $result = wp_register_script( $script_handle, plugins_url( $script_path, $metadata['file'] ), $script_asset['dependencies'], $script_asset['version'] ); return $result ? $script_handle : false; } /** * Finds a style handle for the block metadata field. It detects when a path * to file was provided and registers the style under automatically * generated handle name. It returns unprocessed style handle otherwise. * * @since 5.5.0 * * @param array $metadata Block metadata. * @param string $field_name Field name to pick from metadata. * * @return string|boolean Style handle provided directly or created through * style's registration, or false on failure. */ function register_block_style_handle( $metadata, $field_name ) { if ( empty( $metadata[ $field_name ] ) ) { return false; } $style_handle = $metadata[ $field_name ]; $style_path = remove_block_asset_path_prefix( $metadata[ $field_name ] ); if ( $style_handle === $style_path ) { return $style_handle; } $style_handle = generate_block_asset_handle( $metadata['name'], $field_name ); $block_dir = dirname( $metadata['file'] ); $result = wp_register_style( $style_handle, plugins_url( $style_path, $metadata['file'] ), array(), filemtime( realpath( "$block_dir/$style_path" ) ) ); return $result ? $style_handle : false; } /** * Registers a block type from metadata stored in the `block.json` file. * * @since 7.9.0 * * @param string $file_or_folder Path to the JSON file with metadata definition for * the block or path to the folder where the `block.json` file is located. * @param array $args { * Optional. Array of block type arguments. Any arguments may be defined, however the * ones described below are supported by default. Default empty array. * * @type callable $render_callback Callback used to render blocks of this block type. * } * @return WP_Block_Type|false The registered block type on success, or false on failure. */ function register_block_type_from_metadata( $file_or_folder, $args = array() ) { $filename = 'block.json'; $metadata_file = ( substr( $file_or_folder, -strlen( $filename ) ) !== $filename ) ? trailingslashit( $file_or_folder ) . $filename : $file_or_folder; if ( ! file_exists( $metadata_file ) ) { return false; } $metadata = json_decode( file_get_contents( $metadata_file ), true ); if ( ! is_array( $metadata ) || empty( $metadata['name'] ) ) { return false; } $metadata['file'] = $metadata_file; $settings = array(); $property_mappings = array( 'title' => 'title', 'category' => 'category', 'parent' => 'parent', 'icon' => 'icon', 'description' => 'description', 'keywords' => 'keywords', 'attributes' => 'attributes', 'providesContext' => 'provides_context', 'usesContext' => 'uses_context', // Deprecated: remove with Gutenberg 8.6 release. 'context' => 'context', 'supports' => 'supports', 'styles' => 'styles', 'example' => 'example', ); foreach ( $property_mappings as $key => $mapped_key ) { if ( isset( $metadata[ $key ] ) ) { $settings[ $mapped_key ] = $metadata[ $key ]; } } if ( ! empty( $metadata['editorScript'] ) ) { $settings['editor_script'] = register_block_script_handle( $metadata, 'editorScript' ); } if ( ! empty( $metadata['script'] ) ) { $settings['script'] = register_block_script_handle( $metadata, 'script' ); } if ( ! empty( $metadata['editorStyle'] ) ) { $settings['editor_style'] = register_block_style_handle( $metadata, 'editorStyle' ); } if ( ! empty( $metadata['style'] ) ) { $settings['style'] = register_block_style_handle( $metadata, 'style' ); } return register_block_type( $metadata['name'], array_merge( $settings, $args ) ); } } /** * Extends block editor settings to include a list of image dimensions per size. * * This can be removed when plugin support requires WordPress 5.4.0+. * * @see https://core.trac.wordpress.org/ticket/49389 * @see https://core.trac.wordpress.org/changeset/47240 * * @param array $settings Default editor settings. * * @return array Filtered editor settings. */ function gutenberg_extend_settings_image_dimensions( $settings ) { /* * Only filter settings if: * 1. `imageDimensions` is not already assigned, in which case it can be * assumed to have been set from WordPress 5.4.0+ default settings. * 2. `imageSizes` is an array. Plugins may run `block_editor_settings` * directly and not provide all properties of the settings array. */ if ( ! isset( $settings['imageDimensions'] ) && ! empty( $settings['imageSizes'] ) ) { $image_dimensions = array(); $all_sizes = wp_get_registered_image_subsizes(); foreach ( $settings['imageSizes'] as $size ) { $key = $size['slug']; if ( isset( $all_sizes[ $key ] ) ) { $image_dimensions[ $key ] = $all_sizes[ $key ]; } } $settings['imageDimensions'] = $image_dimensions; } return $settings; } add_filter( 'block_editor_settings', 'gutenberg_extend_settings_image_dimensions' ); /** * Adds a polyfill for the WHATWG URL in environments which do not support it. * The intention in how this action is handled is under the assumption that this * code would eventually be placed at `wp_default_packages_vendor`, which is * called as a result of `wp_default_packages` via the `wp_default_scripts`. * * This can be removed when plugin support requires WordPress 5.4.0+. * * The script registration occurs in `gutenberg_register_vendor_scripts`, which * should be removed in coordination with this function. * * @see gutenberg_register_vendor_scripts * @see https://core.trac.wordpress.org/ticket/49360 * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/URL * @see https://developer.wordpress.org/reference/functions/wp_default_packages_vendor/ * * @since 7.3.0 * * @param WP_Scripts $scripts WP_Scripts object. */ function gutenberg_add_url_polyfill( $scripts ) { did_action( 'init' ) && $scripts->add_inline_script( 'wp-polyfill', wp_get_script_polyfill( $scripts, array( 'window.URL && window.URL.prototype && window.URLSearchParams' => 'wp-polyfill-url', ) ) ); } add_action( 'wp_default_scripts', 'gutenberg_add_url_polyfill', 20 ); /** * Adds a polyfill for DOMRect in environments which do not support it. * * This can be removed when plugin support requires WordPress 5.4.0+. * * The script registration occurs in `gutenberg_register_vendor_scripts`, which * should be removed in coordination with this function. * * @see gutenberg_register_vendor_scripts * @see gutenberg_add_url_polyfill * @see https://core.trac.wordpress.org/ticket/49360 * @see https://developer.mozilla.org/en-US/docs/Web/API/DOMRect * @see https://developer.wordpress.org/reference/functions/wp_default_packages_vendor/ * * @since 7.5.0 * * @param WP_Scripts $scripts WP_Scripts object. */ function gutenberg_add_dom_rect_polyfill( $scripts ) { did_action( 'init' ) && $scripts->add_inline_script( 'wp-polyfill', wp_get_script_polyfill( $scripts, array( 'window.DOMRect' => 'wp-polyfill-dom-rect', ) ) ); } add_action( 'wp_default_scripts', 'gutenberg_add_dom_rect_polyfill', 20 ); /** * Adds a wp.date.setSettings with timezone abbr parameter * * This can be removed when plugin support requires WordPress 5.6.0+. * * The script registration occurs in core wp-includes/script-loader.php * wp_default_packages_inline_scripts() * * @since 8.6.0 * * @param WP_Scripts $scripts WP_Scripts object. */ function gutenberg_add_date_settings_timezone( $scripts ) { if ( ! did_action( 'init' ) ) { return; } global $wp_locale; // Calculate the timezone abbr (EDT, PST) if possible. $timezone_string = get_option( 'timezone_string', 'UTC' ); $timezone_abbr = ''; if ( ! empty( $timezone_string ) ) { $timezone_date = new DateTime( null, new DateTimeZone( $timezone_string ) ); $timezone_abbr = $timezone_date->format( 'T' ); } $scripts->add_inline_script( 'wp-date', sprintf( 'wp.date.setSettings( %s );', wp_json_encode( array( 'l10n' => array( 'locale' => get_user_locale(), 'months' => array_values( $wp_locale->month ), 'monthsShort' => array_values( $wp_locale->month_abbrev ), 'weekdays' => array_values( $wp_locale->weekday ), 'weekdaysShort' => array_values( $wp_locale->weekday_abbrev ), 'meridiem' => (object) $wp_locale->meridiem, 'relative' => array( /* translators: %s: Duration. */ 'future' => __( '%s from now', 'default' ), /* translators: %s: Duration. */ 'past' => __( '%s ago', 'default' ), ), ), 'formats' => array( /* translators: Time format, see https://www.php.net/date */ 'time' => get_option( 'time_format', __( 'g:i a', 'default' ) ), /* translators: Date format, see https://www.php.net/date */ 'date' => get_option( 'date_format', __( 'F j, Y', 'default' ) ), /* translators: Date/Time format, see https://www.php.net/date */ 'datetime' => __( 'F j, Y g:i a', 'default' ), /* translators: Abbreviated date/time format, see https://www.php.net/date */ 'datetimeAbbreviated' => __( 'M j, Y g:i a', 'default' ), ), 'timezone' => array( 'offset' => get_option( 'gmt_offset', 0 ), 'string' => $timezone_string, 'abbr' => $timezone_abbr, ), ) ) ), 'after' ); } add_action( 'wp_default_scripts', 'gutenberg_add_date_settings_timezone', 20 ); /** * Filters default block categories to substitute legacy category names with new * block categories. * * This can be removed when plugin support requires WordPress 5.5.0+. * * @see https://core.trac.wordpress.org/ticket/50278 * @see https://core.trac.wordpress.org/changeset/48177 * * @param array[] $default_categories Array of block categories. * * @return array[] Filtered block categories. */ function gutenberg_replace_default_block_categories( $default_categories ) { $substitution = array( 'common' => array( 'slug' => 'text', 'title' => __( 'Text', 'gutenberg' ), 'icon' => null, ), 'formatting' => array( 'slug' => 'media', 'title' => __( 'Media', 'gutenberg' ), 'icon' => null, ), 'layout' => array( 'slug' => 'design', 'title' => __( 'Design', 'gutenberg' ), 'icon' => null, ), ); // Loop default categories to perform in-place substitution by legacy slug. foreach ( $default_categories as $i => $default_category ) { $slug = $default_category['slug']; if ( isset( $substitution[ $slug ] ) ) { $default_categories[ $i ] = $substitution[ $slug ]; unset( $substitution[ $slug ] ); } } /* * At this point, `$substitution` should contain only the categories which * could not be in-place substituted with a default category, likely in the * case that core has since been updated to use the default categories. * Check to verify they exist. */ $default_category_slugs = wp_list_pluck( $default_categories, 'slug' ); foreach ( $substitution as $i => $substitute_category ) { if ( in_array( $substitute_category['slug'], $default_category_slugs, true ) ) { unset( $substitution[ $i ] ); } } /* * Any substitutes remaining should be appended, as they are not yet * assigned in the default categories array. */ return array_merge( $default_categories, array_values( $substitution ) ); } add_filter( 'block_categories', 'gutenberg_replace_default_block_categories' ); /** * Shim that hooks into `pre_render_block` so as to override `render_block` with * a function that assigns block context. * * This can be removed when plugin support requires WordPress 5.5.0+. * * @see https://core.trac.wordpress.org/ticket/49927 * @see https://core.trac.wordpress.org/changeset/48243 * * @param string|null $pre_render The pre-rendered content. Defaults to null. * @param array $parsed_block The parsed block being rendered. * * @return string String of rendered HTML. */ function gutenberg_render_block_with_assigned_block_context( $pre_render, $parsed_block ) { global $post, $wp_query; /* * If a non-null value is provided, a filter has run at an earlier priority * and has already handled custom rendering and should take precedence. */ if ( null !== $pre_render ) { return $pre_render; } $source_block = $parsed_block; /** This filter is documented in src/wp-includes/blocks.php */ $parsed_block = apply_filters( 'render_block_data', $parsed_block, $source_block ); $context = array(); if ( $post instanceof WP_Post ) { $context['postId'] = $post->ID; /* * The `postType` context is largely unnecessary server-side, since the * ID is usually sufficient on its own. That being said, since a block's * manifest is expected to be shared between the server and the client, * it should be included to consistently fulfill the expectation. */ $context['postType'] = $post->post_type; } if ( isset( $wp_query->tax_query->queried_terms['category'] ) ) { $context['query'] = array( 'categoryIds' => array() ); foreach ( $wp_query->tax_query->queried_terms['category']['terms'] as $category_slug_or_id ) { $context['query']['categoryIds'][] = 'slug' === $wp_query->tax_query->queried_terms['category']['field'] ? get_cat_ID( $category_slug_or_id ) : $category_slug_or_id; } } /** * Filters the default context provided to a rendered block. * * @param array $context Default context. * @param array $parsed_block Block being rendered, filtered by `render_block_data`. */ $context = apply_filters( 'render_block_context', $context, $parsed_block ); $block = new WP_Block( $parsed_block, $context ); return $block->render(); } add_filter( 'pre_render_block', 'gutenberg_render_block_with_assigned_block_context', 9, 2 ); /** * Shim that hooks into `wp_update_nav_menu_item` and makes it so that nav menu * items support a 'content' field. This field contains HTML and is used by nav * menu items with `type` set to `'html'`. * * Specifically, this shim makes it so that: * * 1) The `wp_update_nav_menu_item()` function supports setting * `'menu-item-content'` on a menu item. When merged to Core, this functionality * should exist in `wp_update_nav_menu_item()`. * * 2) The `customize_save` ajax action supports setting `'content'` on a nav * menu item. When merged to Core, this functionality should exist in * `WP_Customize_Manager::save()`. * * This shim can be removed when the Gutenberg plugin requires a WordPress * version that has the ticket below. * * @see https://core.trac.wordpress.org/ticket/50544 * * @param int $menu_id ID of the updated menu. * @param int $menu_item_db_id ID of the new menu item. * @param array $args An array of arguments used to update/add the menu item. */ function gutenberg_update_nav_menu_item_content( $menu_id, $menu_item_db_id, $args ) { global $wp_customize; // Support setting content in customize_save admin-ajax.php requests by // grabbing the unsanitized $_POST values. if ( isset( $wp_customize ) ) { $values = $wp_customize->unsanitized_post_values(); if ( isset( $values[ "nav_menu_item[$menu_item_db_id]" ]['content'] ) ) { if ( is_string( $values[ "nav_menu_item[$menu_item_db_id]" ]['content'] ) ) { $args['menu-item-content'] = $values[ "nav_menu_item[$menu_item_db_id]" ]['content']; } elseif ( isset( $values[ "nav_menu_item[$menu_item_db_id]" ]['content']['raw'] ) ) { $args['menu-item-content'] = $values[ "nav_menu_item[$menu_item_db_id]" ]['content']['raw']; } } } $defaults = array( 'menu-item-content' => '', ); $args = wp_parse_args( $args, $defaults ); update_post_meta( $menu_item_db_id, '_menu_item_content', wp_slash( $args['menu-item-content'] ) ); } add_action( 'wp_update_nav_menu_item', 'gutenberg_update_nav_menu_item_content', 10, 3 ); /** * Shim that hooks into `wp_setup_nav_menu_items` and makes it so that nav menu * items have a 'content' field. This field contains HTML and is used by nav * menu items with `type` set to `'html'`. * * Specifically, this shim makes it so that the `wp_setup_nav_menu_item()` * function sets `content` on the returned menu item. When merged to Core, this * functionality should exist in `wp_setup_nav_menu_item()`. * * This shim can be removed when the Gutenberg plugin requires a WordPress * version that has the ticket below. * * @see https://core.trac.wordpress.org/ticket/50544 * * @param object $menu_item The menu item object. */ function gutenberg_setup_html_nav_menu_item( $menu_item ) { if ( 'html' === $menu_item->type ) { $menu_item->type_label = __( 'HTML', 'gutenberg' ); $menu_item->content = ! isset( $menu_item->content ) ? get_post_meta( $menu_item->db_id, '_menu_item_content', true ) : $menu_item->content; } return $menu_item; } add_filter( 'wp_setup_nav_menu_item', 'gutenberg_setup_html_nav_menu_item' ); /** * Shim that hooks into `walker_nav_menu_start_el` and makes it so that the * default walker which renders a menu will correctly render the HTML associated * with any navigation menu item that has `type` set to `'html`'. * * Specifically, this shim makes it so that `Walker_Nav_Menu::start_el()` * renders the `content` of a nav menu item when its `type` is `'html'`. When * merged to Core, this functionality should exist in * `Walker_Nav_Menu::start_el()`. * * This shim can be removed when the Gutenberg plugin requires a WordPress * version that has the ticket below. * * @see https://core.trac.wordpress.org/ticket/50544 * * @param string $item_output The menu item's starting HTML output. * @param WP_Post $item Menu item data object. * @param int $depth Depth of menu item. Used for padding. * @param stdClass $args An object of wp_nav_menu() arguments. */ function gutenberg_output_html_nav_menu_item( $item_output, $item, $depth, $args ) { if ( 'html' === $item->type ) { $item_output = $args->before; /** This filter is documented in wp-includes/post-template.php */ $item_output .= apply_filters( 'the_content', $item->content ); $item_output .= $args->after; } return $item_output; } add_filter( 'walker_nav_menu_start_el', 'gutenberg_output_html_nav_menu_item', 10, 4 ); /** * Amends the paths to preload when initializing edit post. * * @see https://core.trac.wordpress.org/ticket/50606 * * @since 8.4.0 * * @param array $preload_paths Default path list that will be preloaded. * @return array Modified path list to preload. */ function gutenberg_preload_edit_post( $preload_paths ) { $additional_paths = array( '/?context=edit' ); return array_merge( $preload_paths, $additional_paths ); } add_filter( 'block_editor_preload_paths', 'gutenberg_preload_edit_post' ); /** * Override post type labels for Reusable Block custom post type. * * This shim can be removed when the Gutenberg plugin requires a WordPress * version that has the ticket below. * * @see https://core.trac.wordpress.org/ticket/50755 * * @since 8.6.0 * * @return array Array of new labels for Reusable Block post type. */ function gutenberg_override_reusable_block_post_type_labels() { return array( 'name' => _x( 'Reusable Blocks', 'post type general name', 'gutenberg' ), 'singular_name' => _x( 'Reusable Block', 'post type singular name', 'gutenberg' ), 'menu_name' => _x( 'Reusable Blocks', 'admin menu', 'gutenberg' ), 'name_admin_bar' => _x( 'Reusable Block', 'add new on admin bar', 'gutenberg' ), 'add_new' => _x( 'Add New', 'Reusable Block', 'gutenberg' ), 'add_new_item' => __( 'Add New Reusable Block', 'gutenberg' ), 'new_item' => __( 'New Reusable Block', 'gutenberg' ), 'edit_item' => __( 'Edit Reusable Block', 'gutenberg' ), 'view_item' => __( 'View Reusable Block', 'gutenberg' ), 'all_items' => __( 'All Reusable Blocks', 'gutenberg' ), 'search_items' => __( 'Search Reusable Blocks', 'gutenberg' ), 'not_found' => __( 'No reusable blocks found.', 'gutenberg' ), 'not_found_in_trash' => __( 'No reusable blocks found in Trash.', 'gutenberg' ), 'filter_items_list' => __( 'Filter reusable blocks list', 'gutenberg' ), 'items_list_navigation' => __( 'Reusable Blocks list navigation', 'gutenberg' ), 'items_list' => __( 'Reusable Blocks list', 'gutenberg' ), 'item_published' => __( 'Reusable Block published.', 'gutenberg' ), 'item_published_privately' => __( 'Reusable Block published privately.', 'gutenberg' ), 'item_reverted_to_draft' => __( 'Reusable Block reverted to draft.', 'gutenberg' ), 'item_scheduled' => __( 'Reusable Block scheduled.', 'gutenberg' ), 'item_updated' => __( 'Reusable Block updated.', 'gutenberg' ), ); } add_filter( 'post_type_labels_wp_block', 'gutenberg_override_reusable_block_post_type_labels', 10, 0 );