| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Server-side registering and rendering of the `core/navigation-link` block. 4 * 5 * @package WordPress 6 */ 7 8 require_once __DIR__ . '/navigation-link/shared/item-should-render.php'; 9 require_once __DIR__ . '/navigation-link/shared/render-submenu-icon.php'; 10 11 /** 12 * Build an array with CSS classes and inline styles defining the colors 13 * which will be applied to the navigation markup in the front-end. 14 * 15 * @since 5.9.0 16 * 17 * @param array $context Navigation block context. 18 * @param array $attributes Block attributes. 19 * @param bool $is_sub_menu Whether the link is part of a sub-menu. Default false. 20 * @return array Colors CSS classes and inline styles. 21 */ 22 function block_core_navigation_link_build_css_colors( $context, $attributes, $is_sub_menu = false ) { 23 $colors = array( 24 'css_classes' => array(), 25 'inline_styles' => '', 26 ); 27 28 // Text color. 29 $named_text_color = null; 30 $custom_text_color = null; 31 32 if ( $is_sub_menu && array_key_exists( 'customOverlayTextColor', $context ) ) { 33 $custom_text_color = $context['customOverlayTextColor']; 34 } elseif ( $is_sub_menu && array_key_exists( 'overlayTextColor', $context ) ) { 35 $named_text_color = $context['overlayTextColor']; 36 } elseif ( array_key_exists( 'customTextColor', $context ) ) { 37 $custom_text_color = $context['customTextColor']; 38 } elseif ( array_key_exists( 'textColor', $context ) ) { 39 $named_text_color = $context['textColor']; 40 } elseif ( isset( $context['style']['color']['text'] ) ) { 41 $custom_text_color = $context['style']['color']['text']; 42 } 43 44 // If has text color. 45 if ( ! is_null( $named_text_color ) ) { 46 // Add the color class. 47 array_push( $colors['css_classes'], 'has-text-color', sprintf( 'has-%s-color', $named_text_color ) ); 48 } elseif ( ! is_null( $custom_text_color ) ) { 49 // Add the custom color inline style. 50 $colors['css_classes'][] = 'has-text-color'; 51 $colors['inline_styles'] .= sprintf( 'color: %s;', $custom_text_color ); 52 } 53 54 // Background color. 55 $named_background_color = null; 56 $custom_background_color = null; 57 58 if ( $is_sub_menu && array_key_exists( 'customOverlayBackgroundColor', $context ) ) { 59 $custom_background_color = $context['customOverlayBackgroundColor']; 60 } elseif ( $is_sub_menu && array_key_exists( 'overlayBackgroundColor', $context ) ) { 61 $named_background_color = $context['overlayBackgroundColor']; 62 } elseif ( array_key_exists( 'customBackgroundColor', $context ) ) { 63 $custom_background_color = $context['customBackgroundColor']; 64 } elseif ( array_key_exists( 'backgroundColor', $context ) ) { 65 $named_background_color = $context['backgroundColor']; 66 } elseif ( isset( $context['style']['color']['background'] ) ) { 67 $custom_background_color = $context['style']['color']['background']; 68 } 69 70 // If has background color. 71 if ( ! is_null( $named_background_color ) ) { 72 // Add the background-color class. 73 array_push( $colors['css_classes'], 'has-background', sprintf( 'has-%s-background-color', $named_background_color ) ); 74 } elseif ( ! is_null( $custom_background_color ) ) { 75 // Add the custom background-color inline style. 76 $colors['css_classes'][] = 'has-background'; 77 $colors['inline_styles'] .= sprintf( 'background-color: %s;', $custom_background_color ); 78 } 79 80 return $colors; 81 } 82 83 /** 84 * Build an array with CSS classes and inline styles defining the font sizes 85 * which will be applied to the navigation markup in the front-end. 86 * 87 * This function is no longer used internally and is kept only for backward 88 * compatibility with third-party code that may call it directly. 89 * 90 * @since 5.9.0 91 * @deprecated 7.0.0 92 * 93 * @param array $context Navigation block context. 94 * @return array Font size CSS classes and inline styles. 95 */ 96 function block_core_navigation_link_build_css_font_sizes( $context ) { 97 _deprecated_function( __FUNCTION__, '7.0.0' ); 98 99 // CSS classes. 100 $font_sizes = array( 101 'css_classes' => array(), 102 'inline_styles' => '', 103 ); 104 105 $has_named_font_size = array_key_exists( 'fontSize', $context ); 106 $has_custom_font_size = isset( $context['style']['typography']['fontSize'] ); 107 108 if ( $has_named_font_size ) { 109 // Add the font size class. 110 $font_sizes['css_classes'][] = sprintf( 'has-%s-font-size', $context['fontSize'] ); 111 } elseif ( $has_custom_font_size ) { 112 // Add the custom font size inline style. 113 $font_sizes['inline_styles'] = sprintf( 114 'font-size: %s;', 115 wp_get_typography_font_size_value( 116 array( 117 'size' => $context['style']['typography']['fontSize'], 118 ) 119 ) 120 ); 121 } 122 123 return $font_sizes; 124 } 125 126 /** 127 * Returns the top-level submenu SVG chevron icon. 128 * 129 * @since 5.9.0 130 * @deprecated 7.0.0 Use block_core_shared_navigation_render_submenu_icon() instead. 131 * 132 * @return string 133 */ 134 function block_core_navigation_link_render_submenu_icon() { 135 _deprecated_function( 136 __FUNCTION__, 137 '7.0.0', 138 'block_core_shared_navigation_render_submenu_icon()' 139 ); 140 return block_core_shared_navigation_render_submenu_icon(); 141 } 142 143 /** 144 * Decodes a url if it's encoded, returning the same url if not. 145 * 146 * @since 6.2.0 147 * 148 * @param string $url The url to decode. 149 * 150 * @return string $url Returns the decoded url. 151 */ 152 function block_core_navigation_link_maybe_urldecode( $url ) { 153 $is_url_encoded = false; 154 $query = parse_url( $url, PHP_URL_QUERY ); 155 $query_params = wp_parse_args( $query ); 156 157 foreach ( $query_params as $query_param ) { 158 $can_query_param_be_encoded = is_string( $query_param ) && ! empty( $query_param ); 159 if ( ! $can_query_param_be_encoded ) { 160 continue; 161 } 162 if ( rawurldecode( $query_param ) !== $query_param ) { 163 $is_url_encoded = true; 164 break; 165 } 166 } 167 168 if ( $is_url_encoded ) { 169 return rawurldecode( $url ); 170 } 171 172 return $url; 173 } 174 175 176 /** 177 * Renders the `core/navigation-link` block. 178 * 179 * @since 5.9.0 180 * 181 * @param array $attributes The block attributes. 182 * @param string $content The saved content. 183 * @param WP_Block $block The parsed block. 184 * 185 * @return string Returns the post content with the legacy widget added. 186 */ 187 function render_block_core_navigation_link( $attributes, $content, $block ) { 188 // Check if this navigation item should render based on post status. 189 if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ) { 190 $should_render = gutenberg_block_core_shared_navigation_item_should_render( $attributes, $block ); 191 } else { 192 $should_render = block_core_shared_navigation_item_should_render( $attributes, $block ); 193 } 194 if ( ! $should_render ) { 195 return ''; 196 } 197 198 // Don't render the block's subtree if it has no label. 199 if ( empty( $attributes['label'] ) ) { 200 return ''; 201 } 202 203 $classes = array(); 204 205 // Render inner blocks first to check if any menu items will actually display. 206 $inner_blocks_html = ''; 207 foreach ( $block->inner_blocks as $inner_block ) { 208 $inner_blocks_html .= $inner_block->render(); 209 } 210 $has_submenu = ! empty( trim( $inner_blocks_html ) ); 211 212 $css_classes = trim( implode( ' ', $classes ) ); 213 $kind = empty( $attributes['kind'] ) ? 'post_type' : str_replace( '-', '_', $attributes['kind'] ); 214 $is_active = ! empty( $attributes['id'] ) && get_queried_object_id() === (int) $attributes['id'] && ! empty( get_queried_object()->$kind ); 215 216 if ( is_post_type_archive() && ! empty( $attributes['url'] ) ) { 217 $queried_archive_link = get_post_type_archive_link( get_queried_object()->name ); 218 if ( $attributes['url'] === $queried_archive_link ) { 219 $is_active = true; 220 } 221 } 222 223 $wrapper_attributes = get_block_wrapper_attributes( 224 array( 225 'class' => $css_classes . ' wp-block-navigation-item' . ( $has_submenu ? ' has-child' : '' ) . 226 ( $is_active ? ' current-menu-item' : '' ), 227 ) 228 ); 229 $html = '<li ' . $wrapper_attributes . '>' . 230 '<a class="wp-block-navigation-item__content" '; 231 232 // Start appending HTML attributes to anchor tag. 233 if ( isset( $attributes['url'] ) ) { 234 $html .= ' href="' . esc_url( block_core_navigation_link_maybe_urldecode( $attributes['url'] ) ) . '"'; 235 } 236 237 if ( $is_active ) { 238 $html .= ' aria-current="page"'; 239 } 240 241 if ( isset( $attributes['opensInNewTab'] ) && true === $attributes['opensInNewTab'] ) { 242 $html .= ' target="_blank" '; 243 } 244 245 if ( isset( $attributes['rel'] ) ) { 246 $html .= ' rel="' . esc_attr( $attributes['rel'] ) . '"'; 247 } elseif ( isset( $attributes['nofollow'] ) && $attributes['nofollow'] ) { 248 $html .= ' rel="nofollow"'; 249 } 250 251 if ( isset( $attributes['title'] ) ) { 252 $html .= ' title="' . esc_attr( $attributes['title'] ) . '"'; 253 } 254 255 // End appending HTML attributes to anchor tag. 256 257 // Start anchor tag content. 258 $html .= '>' . 259 // Wrap title with span to isolate it from submenu icon. 260 '<span class="wp-block-navigation-item__label">'; 261 262 if ( isset( $attributes['label'] ) ) { 263 $html .= wp_kses_post( $attributes['label'] ); 264 } 265 266 $html .= '</span>'; 267 268 // Add description if available. 269 if ( ! empty( $attributes['description'] ) ) { 270 $html .= '<span class="wp-block-navigation-item__description">'; 271 $html .= wp_kses_post( $attributes['description'] ); 272 $html .= '</span>'; 273 } 274 275 $html .= '</a>'; 276 // End anchor tag content. 277 278 if ( isset( $block->context['showSubmenuIcon'] ) && $block->context['showSubmenuIcon'] && $has_submenu ) { 279 // The submenu icon can be hidden by a CSS rule on the Navigation Block. 280 $html .= '<span class="wp-block-navigation__submenu-icon">'; 281 if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ) { 282 $html .= gutenberg_block_core_shared_navigation_render_submenu_icon(); 283 } else { 284 $html .= block_core_shared_navigation_render_submenu_icon(); 285 } 286 $html .= '</span>'; 287 } 288 289 if ( $has_submenu ) { 290 $html .= sprintf( 291 '<ul class="wp-block-navigation__submenu-container">%s</ul>', 292 $inner_blocks_html 293 ); 294 } 295 296 $html .= '</li>'; 297 298 return $html; 299 } 300 301 /** 302 * Returns a navigation link variation 303 * 304 * @since 5.9.0 305 * 306 * @param WP_Taxonomy|WP_Post_Type $entity post type or taxonomy entity. 307 * @param string $kind string of value 'taxonomy' or 'post-type'. 308 * 309 * @return array 310 */ 311 function build_variation_for_navigation_link( $entity, $kind ) { 312 $title = ''; 313 $description = ''; 314 315 // Get default labels based on entity type 316 $default_labels = null; 317 if ( $entity instanceof WP_Post_Type ) { 318 $default_labels = WP_Post_Type::get_default_labels(); 319 } elseif ( $entity instanceof WP_Taxonomy ) { 320 $default_labels = WP_Taxonomy::get_default_labels(); 321 } 322 323 // Get title and check if it's default 324 $is_default_title = false; 325 if ( property_exists( $entity->labels, 'item_link' ) ) { 326 $title = $entity->labels->item_link; 327 if ( isset( $default_labels['item_link'] ) ) { 328 $is_default_title = in_array( $title, $default_labels['item_link'], true ); 329 } 330 } 331 332 // Get description and check if it's default 333 $is_default_description = false; 334 if ( property_exists( $entity->labels, 'item_link_description' ) ) { 335 $description = $entity->labels->item_link_description; 336 if ( isset( $default_labels['item_link_description'] ) ) { 337 $is_default_description = in_array( $description, $default_labels['item_link_description'], true ); 338 } 339 } 340 341 // Calculate singular name once (used for both title and description) 342 $singular = $entity->labels->singular_name ?? ucfirst( $entity->name ); 343 344 // Set default title if needed 345 if ( $is_default_title || '' === $title ) { 346 /* translators: %s: Singular label of the entity. */ 347 $title = sprintf( __( '%s link' ), $singular ); 348 } 349 350 // Default description if needed. 351 // Use a single space character instead of an empty string to prevent fallback to the 352 // block.json default description ("Add a page, link, or another item to your navigation."). 353 // An empty string would be treated as missing and trigger the fallback, while a single 354 // space appears blank in the UI but prevents the fallback behavior. 355 // We avoid generating descriptions like "A link to a %s" to prevent grammatical errors 356 // (e.g., "A link to a event" should be "A link to an event"). 357 if ( $is_default_description || '' === $description ) { 358 $description = ' '; 359 } 360 361 $variation = array( 362 'name' => $entity->name, 363 'title' => $title, 364 'description' => $description, 365 'attributes' => array( 366 'type' => $entity->name, 367 'kind' => $kind, 368 ), 369 ); 370 371 // Tweak some value for the variations. 372 $variation_overrides = array( 373 'post_tag' => array( 374 'name' => 'tag', 375 'attributes' => array( 376 'type' => 'tag', 377 'kind' => $kind, 378 ), 379 ), 380 'post_format' => array( 381 // The item_link and item_link_description for post formats is the 382 // same as for tags, so need to be overridden. 383 'title' => __( 'Post Format Link' ), 384 'description' => __( 'A link to a post format' ), 385 'attributes' => array( 386 'type' => 'post_format', 387 'kind' => $kind, 388 ), 389 ), 390 ); 391 392 if ( array_key_exists( $entity->name, $variation_overrides ) ) { 393 $variation = array_merge( 394 $variation, 395 $variation_overrides[ $entity->name ] 396 ); 397 } 398 399 return $variation; 400 } 401 402 /** 403 * Filters the registered variations for a block type. 404 * Returns the dynamically built variations for all post-types and taxonomies. 405 * 406 * @since 6.5.0 407 * 408 * @param array $variations Array of registered variations for a block type. 409 * @param WP_Block_Type $block_type The full block type object. 410 * @return array Numerically indexed array of block variations. 411 */ 412 function block_core_navigation_link_filter_variations( $variations, $block_type ) { 413 if ( 'core/navigation-link' !== $block_type->name ) { 414 return $variations; 415 } 416 417 $generated_variations = block_core_navigation_link_build_variations(); 418 419 /* 420 * IMPORTANT: Order matters for deduplication. 421 * 422 * The variations returned from this filter are bootstrapped to JavaScript and 423 * processed by the block variations reducer. The reducer uses `getUniqueItemsByName()` 424 * (packages/blocks/src/store/reducer.js:51-57) which keeps the FIRST variation with 425 * a given 'name' and discards later duplicates when processing the array in order. 426 * 427 * By placing generated variations first in `array_merge()`, the improved 428 * labels (e.g., "Product link" instead of generic "Post Link") are processed first 429 * and preserved. The generic incoming variations are then discarded as duplicates. 430 * 431 * Why `array_merge()` instead of manual deduplication? 432 * - Both arrays use numeric indices (0, 1, 2...), so `array_merge()` concatenates 433 * and re-indexes them sequentially, preserving order 434 * - The reducer handles deduplication, so it is not needed here 435 * - This keeps the PHP code simple and relies on the established JavaScript behavior 436 * 437 * See: https://github.com/WordPress/gutenberg/pull/72517 438 */ 439 return array_merge( $generated_variations, $variations ); 440 } 441 442 /** 443 * Returns an array of variations for the navigation link block. 444 * 445 * @since 6.5.0 446 * 447 * @return array 448 */ 449 function block_core_navigation_link_build_variations() { 450 $post_types = get_post_types( array( 'show_in_nav_menus' => true ), 'objects' ); 451 $taxonomies = get_taxonomies( array( 'show_in_nav_menus' => true ), 'objects' ); 452 453 /* 454 * Use two separate arrays as a way to order the variations in the UI. 455 * Known variations (like Post Link and Page Link) are added to the 456 * `built_ins` array. Variations for custom post types and taxonomies are 457 * added to the `variations` array and will always appear after `built-ins. 458 */ 459 $built_ins = array(); 460 $variations = array(); 461 462 if ( $post_types ) { 463 foreach ( $post_types as $post_type ) { 464 $variation = build_variation_for_navigation_link( $post_type, 'post-type' ); 465 if ( $post_type->_builtin ) { 466 $built_ins[] = $variation; 467 } else { 468 $variations[] = $variation; 469 } 470 } 471 } 472 if ( $taxonomies ) { 473 foreach ( $taxonomies as $taxonomy ) { 474 $variation = build_variation_for_navigation_link( $taxonomy, 'taxonomy' ); 475 if ( $taxonomy->_builtin ) { 476 $built_ins[] = $variation; 477 } else { 478 $variations[] = $variation; 479 } 480 } 481 } 482 483 $all_variations = array_merge( $built_ins, $variations ); 484 485 return $all_variations; 486 } 487 488 /** 489 * Registers the navigation link block. 490 * 491 * @since 5.9.0 492 * 493 * @uses render_block_core_navigation_link() 494 * @throws WP_Error An WP_Error exception parsing the block definition. 495 */ 496 function register_block_core_navigation_link() { 497 register_block_type_from_metadata( 498 __DIR__ . '/navigation-link', 499 array( 500 'render_callback' => 'render_block_core_navigation_link', 501 ) 502 ); 503 } 504 add_action( 'init', 'register_block_core_navigation_link' ); 505 /** 506 * Creates all variations for post types / taxonomies dynamically (= each time when variations are requested). 507 * Do not use variation_callback, to also account for unregistering post types/taxonomies later on. 508 */ 509 add_filter( 'get_block_type_variations', 'block_core_navigation_link_filter_variations', 10, 2 );
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sun Jul 26 08:20:18 2026 | Cross-referenced by PHPXref |