<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WP_Navigation_Fallback class

[2] Fix | Delete

*

[3] Fix | Delete

* Manages fallback behavior for Navigation menus.

[4] Fix | Delete

*

[5] Fix | Delete

* @package WordPress

[6] Fix | Delete

* @subpackage Navigation

[7] Fix | Delete

* @since 6.3.0

[8] Fix | Delete

*/

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Manages fallback behavior for Navigation menus.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 6.3.0

[14] Fix | Delete

*/

[15] Fix | Delete

class WP_Navigation_Fallback {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Updates the wp_navigation custom post type schema, in order to expose

[19] Fix | Delete

* additional fields in the embeddable links of WP_REST_Navigation_Fallback_Controller.

[20] Fix | Delete

*

[21] Fix | Delete

* The Navigation Fallback endpoint may embed the full Navigation Menu object

[22] Fix | Delete

* into the response as the `self` link. By default, the Posts Controller

[23] Fix | Delete

* will only expose a limited subset of fields but the editor requires

[24] Fix | Delete

* additional fields to be available in order to utilize the menu.

[25] Fix | Delete

*

[26] Fix | Delete

* Used with the `rest_wp_navigation_item_schema` hook.

[27] Fix | Delete

*

[28] Fix | Delete

* @since 6.4.0

[29] Fix | Delete

*

[30] Fix | Delete

* @param array $schema The schema for the `wp_navigation` post.

[31] Fix | Delete

* @return array The modified schema.

[32] Fix | Delete

*/

[33] Fix | Delete

public static function update_wp_navigation_post_schema( $schema ) {

[34] Fix | Delete

// Expose top level fields.

[35] Fix | Delete

$schema['properties']['status']['context'] = array_merge( $schema['properties']['status']['context'], array( 'embed' ) );

[36] Fix | Delete

$schema['properties']['content']['context'] = array_merge( $schema['properties']['content']['context'], array( 'embed' ) );

[37] Fix | Delete

[38] Fix | Delete

/*

[39] Fix | Delete

* Exposes sub properties of content field.

[40] Fix | Delete

* These sub properties aren't exposed by the posts controller by default,

[41] Fix | Delete

* for requests where context is `embed`.

[42] Fix | Delete

*

[43] Fix | Delete

* @see WP_REST_Posts_Controller::get_item_schema()

[44] Fix | Delete

*/

[45] Fix | Delete

$schema['properties']['content']['properties']['raw']['context'] = array_merge( $schema['properties']['content']['properties']['raw']['context'], array( 'embed' ) );

[46] Fix | Delete

$schema['properties']['content']['properties']['rendered']['context'] = array_merge( $schema['properties']['content']['properties']['rendered']['context'], array( 'embed' ) );

[47] Fix | Delete

$schema['properties']['content']['properties']['block_version']['context'] = array_merge( $schema['properties']['content']['properties']['block_version']['context'], array( 'embed' ) );

[48] Fix | Delete

[49] Fix | Delete

/*

[50] Fix | Delete

* Exposes sub properties of title field.

[51] Fix | Delete

* These sub properties aren't exposed by the posts controller by default,

[52] Fix | Delete

* for requests where context is `embed`.

[53] Fix | Delete

*

[54] Fix | Delete

* @see WP_REST_Posts_Controller::get_item_schema()

[55] Fix | Delete

*/

[56] Fix | Delete

$schema['properties']['title']['properties']['raw']['context'] = array_merge( $schema['properties']['title']['properties']['raw']['context'], array( 'embed' ) );

[57] Fix | Delete

[58] Fix | Delete

return $schema;

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Gets (and/or creates) an appropriate fallback Navigation Menu.

[63] Fix | Delete

*

[64] Fix | Delete

* @since 6.3.0

[65] Fix | Delete

*

[66] Fix | Delete

* @return WP_Post|null the fallback Navigation Post or null.

[67] Fix | Delete

*/

[68] Fix | Delete

public static function get_fallback() {

[69] Fix | Delete

/**

[70] Fix | Delete

* Filters whether or not a fallback should be created.

[71] Fix | Delete

*

[72] Fix | Delete

* @since 6.3.0

[73] Fix | Delete

*

[74] Fix | Delete

* @param bool $create Whether to create a fallback navigation menu. Default true.

[75] Fix | Delete

*/

[76] Fix | Delete

$should_create_fallback = apply_filters( 'wp_navigation_should_create_fallback', true );

[77] Fix | Delete

[78] Fix | Delete

$fallback = static::get_most_recently_published_navigation();

[79] Fix | Delete

[80] Fix | Delete

if ( $fallback || ! $should_create_fallback ) {

[81] Fix | Delete

return $fallback;

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

$fallback = static::create_classic_menu_fallback();

[85] Fix | Delete

[86] Fix | Delete

if ( $fallback && ! is_wp_error( $fallback ) ) {

[87] Fix | Delete

// Return the newly created fallback post object which will now be the most recently created navigation menu.

[88] Fix | Delete

return $fallback instanceof WP_Post ? $fallback : static::get_most_recently_published_navigation();

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

$fallback = static::create_default_fallback();

[92] Fix | Delete

[93] Fix | Delete

if ( $fallback && ! is_wp_error( $fallback ) ) {

[94] Fix | Delete

// Return the newly created fallback post object which will now be the most recently created navigation menu.

[95] Fix | Delete

return $fallback instanceof WP_Post ? $fallback : static::get_most_recently_published_navigation();

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

return null;

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* Finds the most recently published `wp_navigation` post type.

[103] Fix | Delete

*

[104] Fix | Delete

* @since 6.3.0

[105] Fix | Delete

*

[106] Fix | Delete

* @return WP_Post|null the first non-empty Navigation or null.

[107] Fix | Delete

*/

[108] Fix | Delete

private static function get_most_recently_published_navigation() {

[109] Fix | Delete

[110] Fix | Delete

$parsed_args = array(

[111] Fix | Delete

'post_type' => 'wp_navigation',

[112] Fix | Delete

'no_found_rows' => true,

[113] Fix | Delete

'update_post_meta_cache' => false,

[114] Fix | Delete

'update_post_term_cache' => false,

[115] Fix | Delete

'order' => 'DESC',

[116] Fix | Delete

'orderby' => 'date',

[117] Fix | Delete

'post_status' => 'publish',

[118] Fix | Delete

'posts_per_page' => 1,

[119] Fix | Delete

);

[120] Fix | Delete

[121] Fix | Delete

$navigation_post = new WP_Query( $parsed_args );

[122] Fix | Delete

[123] Fix | Delete

if ( count( $navigation_post->posts ) > 0 ) {

[124] Fix | Delete

return $navigation_post->posts[0];

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

return null;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Creates a Navigation Menu post from a Classic Menu.

[132] Fix | Delete

*

[133] Fix | Delete

* @since 6.3.0

[134] Fix | Delete

*

[135] Fix | Delete

* @return int|WP_Error The post ID of the default fallback menu or a WP_Error object.

[136] Fix | Delete

*/

[137] Fix | Delete

private static function create_classic_menu_fallback() {

[138] Fix | Delete

// See if we have a classic menu.

[139] Fix | Delete

$classic_nav_menu = static::get_fallback_classic_menu();

[140] Fix | Delete

[141] Fix | Delete

if ( ! $classic_nav_menu ) {

[142] Fix | Delete

return new WP_Error( 'no_classic_menus', __( 'No Classic Menus found.' ) );

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

// If there is a classic menu then convert it to blocks.

[146] Fix | Delete

$classic_nav_menu_blocks = WP_Classic_To_Block_Menu_Converter::convert( $classic_nav_menu );

[147] Fix | Delete

[148] Fix | Delete

if ( is_wp_error( $classic_nav_menu_blocks ) ) {

[149] Fix | Delete

return $classic_nav_menu_blocks;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

if ( empty( $classic_nav_menu_blocks ) ) {

[153] Fix | Delete

return new WP_Error( 'cannot_convert_classic_menu', __( 'Unable to convert Classic Menu to blocks.' ) );

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

// Create a new navigation menu from the classic menu.

[157] Fix | Delete

$classic_menu_fallback = wp_insert_post(

[158] Fix | Delete

array(

[159] Fix | Delete

'post_content' => $classic_nav_menu_blocks,

[160] Fix | Delete

'post_title' => $classic_nav_menu->name,

[161] Fix | Delete

'post_name' => $classic_nav_menu->slug,

[162] Fix | Delete

'post_status' => 'publish',

[163] Fix | Delete

'post_type' => 'wp_navigation',

[164] Fix | Delete

),

[165] Fix | Delete

true // So that we can check whether the result is an error.

[166] Fix | Delete

);

[167] Fix | Delete

[168] Fix | Delete

return $classic_menu_fallback;

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

/**

[172] Fix | Delete

* Determines the most appropriate classic navigation menu to use as a fallback.

[173] Fix | Delete

*

[174] Fix | Delete

* @since 6.3.0

[175] Fix | Delete

*

[176] Fix | Delete

* @return WP_Term|null The most appropriate classic navigation menu to use as a fallback.

[177] Fix | Delete

*/

[178] Fix | Delete

private static function get_fallback_classic_menu() {

[179] Fix | Delete

$classic_nav_menus = wp_get_nav_menus();

[180] Fix | Delete

[181] Fix | Delete

if ( ! $classic_nav_menus || is_wp_error( $classic_nav_menus ) ) {

[182] Fix | Delete

return null;

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

$nav_menu = static::get_nav_menu_at_primary_location();

[186] Fix | Delete

[187] Fix | Delete

if ( $nav_menu ) {

[188] Fix | Delete

return $nav_menu;

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

$nav_menu = static::get_nav_menu_with_primary_slug( $classic_nav_menus );

[192] Fix | Delete

[193] Fix | Delete

if ( $nav_menu ) {

[194] Fix | Delete

return $nav_menu;

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

return static::get_most_recently_created_nav_menu( $classic_nav_menus );

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

[201] Fix | Delete

/**

[202] Fix | Delete

* Sorts the classic menus and returns the most recently created one.

[203] Fix | Delete

*

[204] Fix | Delete

* @since 6.3.0

[205] Fix | Delete

*

[206] Fix | Delete

* @param WP_Term[] $classic_nav_menus Array of classic nav menu term objects.

[207] Fix | Delete

* @return WP_Term The most recently created classic nav menu.

[208] Fix | Delete

*/

[209] Fix | Delete

private static function get_most_recently_created_nav_menu( $classic_nav_menus ) {

[210] Fix | Delete

usort(

[211] Fix | Delete

$classic_nav_menus,

[212] Fix | Delete

static function ( $a, $b ) {

[213] Fix | Delete

return $b->term_id - $a->term_id;

[214] Fix | Delete

}

[215] Fix | Delete

);

[216] Fix | Delete

[217] Fix | Delete

return $classic_nav_menus[0];

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

/**

[221] Fix | Delete

* Returns the classic menu with the slug `primary` if it exists.

[222] Fix | Delete

*

[223] Fix | Delete

* @since 6.3.0

[224] Fix | Delete

*

[225] Fix | Delete

* @param WP_Term[] $classic_nav_menus Array of classic nav menu term objects.

[226] Fix | Delete

* @return WP_Term|null The classic nav menu with the slug `primary` or null.

[227] Fix | Delete

*/

[228] Fix | Delete

private static function get_nav_menu_with_primary_slug( $classic_nav_menus ) {

[229] Fix | Delete

foreach ( $classic_nav_menus as $classic_nav_menu ) {

[230] Fix | Delete

if ( 'primary' === $classic_nav_menu->slug ) {

[231] Fix | Delete

return $classic_nav_menu;

[232] Fix | Delete

}

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

return null;

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

[239] Fix | Delete

/**

[240] Fix | Delete

* Gets the classic menu assigned to the `primary` navigation menu location

[241] Fix | Delete

* if it exists.

[242] Fix | Delete

*

[243] Fix | Delete

* @since 6.3.0

[244] Fix | Delete

*

[245] Fix | Delete

* @return WP_Term|null The classic nav menu assigned to the `primary` location or null.

[246] Fix | Delete

*/

[247] Fix | Delete

private static function get_nav_menu_at_primary_location() {

[248] Fix | Delete

$locations = get_nav_menu_locations();

[249] Fix | Delete

[250] Fix | Delete

if ( isset( $locations['primary'] ) ) {

[251] Fix | Delete

$primary_menu = wp_get_nav_menu_object( $locations['primary'] );

[252] Fix | Delete

[253] Fix | Delete

if ( $primary_menu ) {

[254] Fix | Delete

return $primary_menu;

[255] Fix | Delete

}

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

return null;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

/**

[262] Fix | Delete

* Creates a default Navigation Block Menu fallback.

[263] Fix | Delete

*

[264] Fix | Delete

* @since 6.3.0

[265] Fix | Delete

*

[266] Fix | Delete

* @return int|WP_Error The post ID of the default fallback menu or a WP_Error object.

[267] Fix | Delete

*/

[268] Fix | Delete

private static function create_default_fallback() {

[269] Fix | Delete

[270] Fix | Delete

$default_blocks = static::get_default_fallback_blocks();

[271] Fix | Delete

[272] Fix | Delete

// Create a new navigation menu from the fallback blocks.

[273] Fix | Delete

$default_fallback = wp_insert_post(

[274] Fix | Delete

array(

[275] Fix | Delete

'post_content' => $default_blocks,

[276] Fix | Delete

'post_title' => _x( 'Navigation', 'Title of a Navigation menu' ),

[277] Fix | Delete

'post_name' => 'navigation',

[278] Fix | Delete

'post_status' => 'publish',

[279] Fix | Delete

'post_type' => 'wp_navigation',

[280] Fix | Delete

),

[281] Fix | Delete

true // So that we can check whether the result is an error.

[282] Fix | Delete

);

[283] Fix | Delete

[284] Fix | Delete

return $default_fallback;

[285] Fix | Delete

}

[286] Fix | Delete

[287] Fix | Delete

/**

[288] Fix | Delete

* Gets the rendered markup for the default fallback blocks.

[289] Fix | Delete

*

[290] Fix | Delete

* @since 6.3.0

[291] Fix | Delete

*

[292] Fix | Delete

* @return string default blocks markup to use a the fallback.

[293] Fix | Delete

*/

[294] Fix | Delete

private static function get_default_fallback_blocks() {

[295] Fix | Delete

$registry = WP_Block_Type_Registry::get_instance();

[296] Fix | Delete

[297] Fix | Delete

// If `core/page-list` is not registered then use empty blocks.

[298] Fix | Delete

return $registry->is_registered( 'core/page-list' ) ? '<!-- wp:page-list /-->' : '';

[299] Fix | Delete

}

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete