# gutenberg/12.1.0/lib/navigation.php Gutenberg, version 12.1.0. 452 lines. - Page: https://pluginprobe.com/plugins/gutenberg/12.1.0/code/lib/navigation.php - Raw: https://pluginprobe.com/plugins/gutenberg/12.1.0/raw/lib/navigation.php - Modified: 2021-11-24T16:50:38+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/gutenberg/12.1.0/code/lib/navigation.php#L10-L20`. ```php __( 'Navigation Menus', 'gutenberg' ), 'singular_name' => __( 'Navigation Menu', 'gutenberg' ), 'menu_name' => _x( 'Navigation Menus', 'Admin Menu text', 'gutenberg' ), 'add_new' => _x( 'Add New', 'Navigation Menu', 'gutenberg' ), 'add_new_item' => __( 'Add New Navigation Menu', 'gutenberg' ), 'new_item' => __( 'New Navigation Menu', 'gutenberg' ), 'edit_item' => __( 'Edit Navigation Menu', 'gutenberg' ), 'view_item' => __( 'View Navigation Menu', 'gutenberg' ), 'all_items' => __( 'All Navigation Menus', 'gutenberg' ), 'search_items' => __( 'Search Navigation Menus', 'gutenberg' ), 'parent_item_colon' => __( 'Parent Navigation Menu:', 'gutenberg' ), 'not_found' => __( 'No Navigation Menu found.', 'gutenberg' ), 'not_found_in_trash' => __( 'No Navigation Menu found in Trash.', 'gutenberg' ), 'archives' => __( 'Navigation Menu archives', 'gutenberg' ), 'insert_into_item' => __( 'Insert into Navigation Menu', 'gutenberg' ), 'uploaded_to_this_item' => __( 'Uploaded to this Navigation Menu', 'gutenberg' ), // Some of these are a bit weird, what are they for? 'filter_items_list' => __( 'Filter Navigation Menu list', 'gutenberg' ), 'items_list_navigation' => __( 'Navigation Menus list navigation', 'gutenberg' ), 'items_list' => __( 'Navigation Menus list', 'gutenberg' ), ); $args = array( 'labels' => $labels, 'description' => __( 'Navigation menus.', 'gutenberg' ), 'public' => false, 'has_archive' => false, // We should disable UI for non-FSE themes. 'show_ui' => gutenberg_is_fse_theme(), 'show_in_menu' => 'themes.php', 'show_in_admin_bar' => false, 'show_in_rest' => true, 'map_meta_cap' => true, 'rest_base' => 'navigation', 'rest_controller_class' => WP_REST_Posts_Controller::class, 'supports' => array( 'title', 'editor', 'revisions', ), ); register_post_type( 'wp_navigation', $args ); } add_action( 'init', 'gutenberg_register_navigation_post_type' ); /** * Disable "Post Attributes" for wp_navigation post type. * * The attributes are also conditionally enabled when a site has custom templates. * Block Theme templates can be available for every post type. */ add_filter( 'theme_wp_navigation_templates', '__return_empty_array' ); /** * Disable block editor for wp_navigation type posts so they can be managed via the UI. * * @param bool $value Whether the CPT supports block editor or not. * @param string $post_type Post type. * * @return bool */ function gutenberg_disable_block_editor_for_navigation_post_type( $value, $post_type ) { if ( 'wp_navigation' === $post_type ) { return false; } return $value; } add_filter( 'use_block_editor_for_post_type', 'gutenberg_disable_block_editor_for_navigation_post_type', 10, 2 ); /** * This callback disables the content editor for wp_navigation type posts. * Content editor cannot handle wp_navigation type posts correctly. * We cannot disable the "editor" feature in the wp_navigation's CPT definition * because it disables the ability to save navigation blocks via REST API. * * @param WP_Post $post An instance of WP_Post class. */ function gutenberg_disable_content_editor_for_navigation_post_type( $post ) { $post_type = get_post_type( $post ); if ( 'wp_navigation' !== $post_type ) { return; } remove_post_type_support( $post_type, 'editor' ); } add_action( 'edit_form_after_title', 'gutenberg_disable_content_editor_for_navigation_post_type', 10, 1 ); /** * This callback enables content editor for wp_navigation type posts. * We need to enable it back because we disable it to hide * the content editor for wp_navigation type posts. * * @see gutenberg_disable_content_editor_for_navigation_post_type * * @param WP_Post $post An instance of WP_Post class. */ function gutenberg_enable_content_editor_for_navigation_post_type( $post ) { $post_type = get_post_type( $post ); if ( 'wp_navigation' !== $post_type ) { return; } add_post_type_support( $post_type, 'editor' ); } add_action( 'edit_form_after_editor', 'gutenberg_enable_content_editor_for_navigation_post_type', 10, 1 ); /** * Rename the menu title from "All Navigation Menus" to "Navigation Menus". */ function gutenberg_rename_navigation_post_type_admin_menu_entry() { global $submenu; if ( ! isset( $submenu['themes.php'] ) ) { return; } $post_type = get_post_type_object( 'wp_navigation' ); if ( ! $post_type ) { return; } $menu_title_index = 0; foreach ( $submenu['themes.php'] as $key => $menu_item ) { if ( $post_type->labels->all_items === $menu_item[ $menu_title_index ] ) { $submenu['themes.php'][ $key ][ $menu_title_index ] = $post_type->labels->menu_name; // phpcs:ignore WordPress.WP.GlobalVariablesOverride return; } } } add_action( 'admin_menu', 'gutenberg_rename_navigation_post_type_admin_menu_entry' ); /** * Registers the navigation areas supported by the current theme. The expected * shape of the argument is: * array( * 'primary' => 'Primary', * 'secondary' => 'Secondary', * 'tertiary' => 'Tertiary', * ) * * @param array $new_areas Supported navigation areas. */ function gutenberg_register_navigation_areas( $new_areas ) { global $gutenberg_navigation_areas; $gutenberg_navigation_areas = $new_areas; } // Register the default navigation areas. gutenberg_register_navigation_areas( array( 'primary' => 'Primary', 'secondary' => 'Secondary', 'tertiary' => 'Tertiary', ) ); /** * Returns the available navigation areas. * * @return array Registered navigation areas. */ function gutenberg_get_navigation_areas() { global $gutenberg_navigation_areas; return $gutenberg_navigation_areas; } /** * Returns the API paths to preload to make the navigation area block load fast. * * @return array A list of paths. */ function gutenberg_get_navigation_areas_paths_to_preload() { $areas = gutenberg_get_navigation_areas_menus(); $active_areas = array_intersect_key( $areas, gutenberg_get_navigation_areas() ); $paths = array( '/wp/v2/block-navigation-areas?context=edit', ); foreach ( $active_areas as $post_id ) { if ( 0 !== $post_id ) { $paths[] = "/wp/v2/navigation/$post_id?context=edit"; } } return $paths; } /** * Migrates classic menus to a block-based navigation post on theme switch. * Assigns the created navigation post to the corresponding navigation area. * * @param string $new_name Name of the new theme. * @param WP_Theme $new_theme New theme. * @param WP_Theme $old_theme Old theme. * @see switch_theme WordPress action. */ function gutenberg_migrate_menu_to_navigation_post( $new_name, $new_theme, $old_theme ) { // Do nothing when switching to a theme that does not support site editor. if ( ! gutenberg_experimental_is_site_editor_available() ) { return; } // get_nav_menu_locations() calls get_theme_mod() which depends on the stylesheet option. // At the same time, switch_theme runs only after the stylesheet option was updated to $new_theme. // To retrieve theme mods of the old theme, the getter is hooked to get_option( 'stylesheet' ) so that we // get the old theme, which causes the get_nav_menu_locations to get the locations of the old theme. $get_old_theme_stylesheet = function() use ( $old_theme ) { return $old_theme->get_stylesheet(); }; add_filter( 'option_stylesheet', $get_old_theme_stylesheet ); $locations = get_nav_menu_locations(); $area_mapping = gutenberg_get_navigation_areas_menus(); foreach ( $locations as $location_name => $menu_id ) { // Get the menu from the location, skipping if there is no // menu or there was an error. $menu = wp_get_nav_menu_object( $menu_id ); if ( ! $menu || is_wp_error( $menu ) ) { continue; } $menu_items = gutenberg_get_menu_items_at_location( $location_name ); if ( empty( $menu_items ) ) { continue; } $post_name = 'classic_menu_' . $menu_id; $post_status = 'publish'; // Get or create to avoid creating too many wp_navigation posts. $query = new WP_Query; $matching_posts = $query->query( array( 'name' => $post_name, 'post_status' => $post_status, 'post_type' => 'wp_navigation', 'posts_per_page' => 1, ) ); if ( count( $matching_posts ) ) { $navigation_post_id = $matching_posts[0]->ID; } else { $menu_items_by_parent_id = gutenberg_sort_menu_items_by_parent_id( $menu_items ); $parsed_blocks = gutenberg_parse_blocks_from_menu_items( $menu_items_by_parent_id[0], $menu_items_by_parent_id ); $post_data = array( 'post_type' => 'wp_navigation', 'post_title' => sprintf( /* translators: %s: the name of the menu, e.g. "Main Menu". */ __( 'Classic menu: %s', 'gutenberg' ), $menu->name ), 'post_name' => $post_name, 'post_content' => serialize_blocks( $parsed_blocks ), 'post_status' => $post_status, ); $navigation_post_id = wp_insert_post( $post_data, true ); // If wp_insert_post fails *at any time*, then bale out of the entire // migration attempt returning the WP_Error object. if ( is_wp_error( $navigation_post_id ) ) { return $navigation_post_id; } } $area_mapping[ $location_name ] = $navigation_post_id; } remove_filter( 'option_stylesheet', $get_old_theme_stylesheet ); update_option( 'wp_navigation_areas', $area_mapping ); } add_action( 'switch_theme', 'gutenberg_migrate_menu_to_navigation_post', 99, 3 ); /** * Retrieves navigation areas. * * @return array Navigation areas. */ function gutenberg_get_navigation_areas_menus() { $areas = get_option( 'wp_navigation_areas', array() ); if ( ! $areas ) { // Original key used `fse` prefix but Core options should use `wp`. // We fallback to the legacy option to catch sites with values in the // original location. $legacy_option_key = 'fse_navigation_areas'; $areas = get_option( $legacy_option_key, array() ); } return $areas; } // The functions below are copied over from packages/block-library/src/navigation/index.php // Let's figure out a better way of managing these global PHP dependencies. /** * Returns the menu items for a WordPress menu location. * * @param string $location The menu location. * @return array Menu items for the location. */ function gutenberg_get_menu_items_at_location( $location ) { if ( empty( $location ) ) { return; } // Build menu data. The following approximates the code in // `wp_nav_menu()` and `gutenberg_output_block_nav_menu`. // Find the location in the list of locations, returning early if the // location can't be found. $locations = get_nav_menu_locations(); if ( ! isset( $locations[ $location ] ) ) { return; } // Get the menu from the location, returning early if there is no // menu or there was an error. $menu = wp_get_nav_menu_object( $locations[ $location ] ); if ( ! $menu || is_wp_error( $menu ) ) { return; } $menu_items = wp_get_nav_menu_items( $menu->term_id, array( 'update_post_term_cache' => false ) ); _wp_menu_item_classes_by_context( $menu_items ); return $menu_items; } /** * Sorts a standard array of menu items into a nested structure keyed by the * id of the parent menu. * * @param array $menu_items Menu items to sort. * @return array An array keyed by the id of the parent menu where each element * is an array of menu items that belong to that parent. */ function gutenberg_sort_menu_items_by_parent_id( $menu_items ) { $sorted_menu_items = array(); foreach ( (array) $menu_items as $menu_item ) { $sorted_menu_items[ $menu_item->menu_order ] = $menu_item; } unset( $menu_items, $menu_item ); $menu_items_by_parent_id = array(); foreach ( $sorted_menu_items as $menu_item ) { $menu_items_by_parent_id[ $menu_item->menu_item_parent ][] = $menu_item; } return $menu_items_by_parent_id; } /** * Turns menu item data into a nested array of parsed blocks * * @param array $menu_items An array of menu items that represent * an individual level of a menu. * @param array $menu_items_by_parent_id An array keyed by the id of the * parent menu where each element is an * array of menu items that belong to * that parent. * @return array An array of parsed block data. */ function gutenberg_parse_blocks_from_menu_items( $menu_items, $menu_items_by_parent_id ) { if ( empty( $menu_items ) ) { return array(); } $blocks = array(); foreach ( $menu_items as $menu_item ) { $class_name = ! empty( $menu_item->classes ) ? implode( ' ', (array) $menu_item->classes ) : null; $id = ( null !== $menu_item->object_id && 'custom' !== $menu_item->object ) ? $menu_item->object_id : null; $opens_in_new_tab = null !== $menu_item->target && '_blank' === $menu_item->target; $rel = ( null !== $menu_item->xfn && '' !== $menu_item->xfn ) ? $menu_item->xfn : null; $kind = null !== $menu_item->type ? str_replace( '_', '-', $menu_item->type ) : 'custom'; $block = array( 'blockName' => isset( $menu_items_by_parent_id[ $menu_item->ID ] ) ? 'core/navigation-submenu' : 'core/navigation-link', 'attrs' => array( 'className' => $class_name, 'description' => $menu_item->description, 'id' => $id, 'kind' => $kind, 'label' => $menu_item->title, 'opensInNewTab' => $opens_in_new_tab, 'rel' => $rel, 'title' => $menu_item->attr_title, 'type' => $menu_item->object, 'url' => $menu_item->url, ), ); $block['innerBlocks'] = isset( $menu_items_by_parent_id[ $menu_item->ID ] ) ? gutenberg_parse_blocks_from_menu_items( $menu_items_by_parent_id[ $menu_item->ID ], $menu_items_by_parent_id ) : array(); $block['innerContent'] = array_map( 'serialize_block', $block['innerBlocks'] ); $blocks[] = $block; } return $blocks; } /** * Shim that hides ability to edit visibility and status for wp_navigation type posts. * When merged to Core, the CSS below should be moved to wp-admin/css/edit.css. * * 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/54407 * * @param string $hook The current admin page. */ function gutenberg_hide_visibility_and_status_for_navigation_posts( $hook ) { $allowed_hooks = array( 'post.php', 'post-new.php' ); if ( ! in_array( $hook, $allowed_hooks, true ) ) { return; } /** * HACK: We're hiding the description field using CSS because this * cannot be done using a filter or an action. */ $css = <<