mirror of
https://github.com/WordPress/WordPress.git
synced 2024-10-30 07:20:01 +01:00
935058d178
Update packages to include these bug fixes from Gutenberg: - Image block: Set image display to grid when no alignment sent to properly align caption on resize - Update and align template descriptions - Site Editor - prevent loading state from showing the admin menu. - Add client side routing for Site Editor - Navigation: Add clearance for appender in submenus. - Fix CSS Custom Properties for presets in the site editor - Add/navigation blocks post processing after migration from menu items - Allow selector ordering to ensure theme.json root selector margin takes precedence - Do not remove theme presets if defaults are hidden - Format library: fix unsetting highlight color - FSE: Fix template resolution to give precedence to child theme PHP templates over parent theme block templates with equal specificity - ColorPalette: Improving accessibility and visibility - Update: Make the color popover on the gradient picker appear as expected - Site Editor: Display a notice if export fails - Fix docs and function naming for gallery block registration in PHP - Switch to addEventListener for load event in the navigation block view script - Fix mistake in _remove_theme_attribute_in_block_template_content - Better synchronisation between Gutenberg and Core code - Move the block page templates hook into compat/5.9 folder - Moves to the template loader hooks and functions into lib/compat folder - Refactor the gutenberg_is_fse_theme function to use wp_is_block_theme - Site Editor: Update support doc URL in Welcome Guide - Global Styles: Add Welcome Guide toggle - Hide remove control point when removing would break gradient control - Don't request the deprecated navigation areas endpoint outside of the Gutenberg plugin - Image: Fix resizer controls being hidden in Safari when switching between alignments - Remove Navigation Menus from WP Admin sidebar - Site Editor: Hide the block appender in the Template Part editor - Site Editor: Use server definition for the Template Areas - Synchronize wp_is_block_theme and block-templates block support with Core - E2E: Retry login again after a bad nonce request to prevent intermittent test failures - Fix theme requirement validation with WP 5.8 - Fix WP 5.9 check for conditionally running code - Fix post comment form input width - Border Style Control: Update styling for consistency with border width control - Fix form-submit styles by adding button classes to the submit-button in post-comments block - Site Editor: Fix edit template part link in header dropdown - Move duotone palette to the bottom of global styles gradients - Fix how appearanceTools works - Move WP 5.9 wp-admin menus compatibility code to lib/compat folder - Revert "Site Editor: Set the <title> on the list page to be same as the CPT name" - Site Editor: Document Actions: add SR text to heading 1 - Do not register global styles CPT in WordPress 5.9 - Global Styles: Move the 'Edit colors' button to a standard menu item - Fix styles for previews and patterns - Site Editor: Fix failing E2E test - Templates: Search for old template names in the parent theme too - Remove 4 instances of 'gutenberg' text domain from WordPress core - Fix content loss when ungrouping template parts or reusable blocks - Simplify the RESET_BLOCK action to fix template part focus mode content loss - [Global Styles]: Make Blocks section more distinguishable - Only use block markup for comment form button when using a block theme - Navigation: Fix vertical alignment of page list in modal. - Fix: ToggleGroupControl active state - Remove gutenberg_ prefix from @wordpress/block-library Props ocean90, oandregal, hellofromtonya, youknowriad. See #54487. Built from https://develop.svn.wordpress.org/trunk@52364 git-svn-id: http://core.svn.wordpress.org/trunk@51956 1a063a9b-81f0-0310-95a4-ce76da25c4cd
338 lines
13 KiB
PHP
338 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* Server-side rendering of the `core/pages` block.
|
|
*
|
|
* @package WordPress
|
|
*/
|
|
|
|
/**
|
|
* Build an array with CSS classes and inline styles defining the colors
|
|
* which will be applied to the pages markup in the front-end when it is a descendant of navigation.
|
|
*
|
|
* @param array $attributes Block attributes.
|
|
* @param array $context Navigation block context.
|
|
* @return array Colors CSS classes and inline styles.
|
|
*/
|
|
function block_core_page_list_build_css_colors( $attributes, $context ) {
|
|
$colors = array(
|
|
'css_classes' => array(),
|
|
'inline_styles' => '',
|
|
'overlay_css_classes' => array(),
|
|
'overlay_inline_styles' => '',
|
|
);
|
|
|
|
// Text color.
|
|
$has_named_text_color = array_key_exists( 'textColor', $context );
|
|
$has_picked_text_color = array_key_exists( 'customTextColor', $context );
|
|
$has_custom_text_color = isset( $context['style']['color']['text'] );
|
|
|
|
// If has text color.
|
|
if ( $has_custom_text_color || $has_picked_text_color || $has_named_text_color ) {
|
|
// Add has-text-color class.
|
|
$colors['css_classes'][] = 'has-text-color';
|
|
}
|
|
|
|
if ( $has_named_text_color ) {
|
|
// Add the color class.
|
|
$colors['css_classes'][] = sprintf( 'has-%s-color', _wp_to_kebab_case( $context['textColor'] ) );
|
|
} elseif ( $has_picked_text_color ) {
|
|
$colors['inline_styles'] .= sprintf( 'color: %s;', $context['customTextColor'] );
|
|
} elseif ( $has_custom_text_color ) {
|
|
// Add the custom color inline style.
|
|
$colors['inline_styles'] .= sprintf( 'color: %s;', $context['style']['color']['text'] );
|
|
}
|
|
|
|
// Background color.
|
|
$has_named_background_color = array_key_exists( 'backgroundColor', $context );
|
|
$has_picked_background_color = array_key_exists( 'customBackgroundColor', $context );
|
|
$has_custom_background_color = isset( $context['style']['color']['background'] );
|
|
|
|
// If has background color.
|
|
if ( $has_custom_background_color || $has_picked_background_color || $has_named_background_color ) {
|
|
// Add has-background class.
|
|
$colors['css_classes'][] = 'has-background';
|
|
}
|
|
|
|
if ( $has_named_background_color ) {
|
|
// Add the background-color class.
|
|
$colors['css_classes'][] = sprintf( 'has-%s-background-color', _wp_to_kebab_case( $context['backgroundColor'] ) );
|
|
} elseif ( $has_picked_background_color ) {
|
|
$colors['inline_styles'] .= sprintf( 'background-color: %s;', $context['customBackgroundColor'] );
|
|
} elseif ( $has_custom_background_color ) {
|
|
// Add the custom background-color inline style.
|
|
$colors['inline_styles'] .= sprintf( 'background-color: %s;', $context['style']['color']['background'] );
|
|
}
|
|
|
|
// Overlay text color.
|
|
$has_named_overlay_text_color = array_key_exists( 'overlayTextColor', $context );
|
|
$has_picked_overlay_text_color = array_key_exists( 'customOverlayTextColor', $context );
|
|
|
|
// If it has a text color.
|
|
if ( $has_named_overlay_text_color || $has_picked_overlay_text_color ) {
|
|
$colors['overlay_css_classes'][] = 'has-text-color';
|
|
}
|
|
|
|
// Give overlay colors priority, fall back to Navigation block colors, then global styles.
|
|
if ( $has_named_overlay_text_color ) {
|
|
$colors['overlay_css_classes'][] = sprintf( 'has-%s-color', _wp_to_kebab_case( $context['overlayTextColor'] ) );
|
|
} elseif ( $has_picked_overlay_text_color ) {
|
|
$colors['overlay_inline_styles'] .= sprintf( 'color: %s;', $context['customOverlayTextColor'] );
|
|
}
|
|
|
|
// Overlay background colors.
|
|
$has_named_overlay_background_color = array_key_exists( 'overlayBackgroundColor', $context );
|
|
$has_picked_overlay_background_color = array_key_exists( 'customOverlayBackgroundColor', $context );
|
|
|
|
// If has background color.
|
|
if ( $has_named_overlay_background_color || $has_picked_overlay_background_color ) {
|
|
$colors['overlay_css_classes'][] = 'has-background';
|
|
}
|
|
|
|
if ( $has_named_overlay_background_color ) {
|
|
$colors['overlay_css_classes'][] = sprintf( 'has-%s-background-color', _wp_to_kebab_case( $context['overlayBackgroundColor'] ) );
|
|
} elseif ( $has_picked_overlay_background_color ) {
|
|
$colors['overlay_inline_styles'] .= sprintf( 'background-color: %s;', $context['customOverlayBackgroundColor'] );
|
|
}
|
|
|
|
return $colors;
|
|
}
|
|
|
|
/**
|
|
* Build an array with CSS classes and inline styles defining the font sizes
|
|
* which will be applied to the pages markup in the front-end when it is a descendant of navigation.
|
|
*
|
|
* @param array $context Navigation block context.
|
|
* @return array Font size CSS classes and inline styles.
|
|
*/
|
|
function block_core_page_list_build_css_font_sizes( $context ) {
|
|
// CSS classes.
|
|
$font_sizes = array(
|
|
'css_classes' => array(),
|
|
'inline_styles' => '',
|
|
);
|
|
|
|
$has_named_font_size = array_key_exists( 'fontSize', $context );
|
|
$has_custom_font_size = isset( $context['style']['typography']['fontSize'] );
|
|
|
|
if ( $has_named_font_size ) {
|
|
// Add the font size class.
|
|
$font_sizes['css_classes'][] = sprintf( 'has-%s-font-size', $context['fontSize'] );
|
|
} elseif ( $has_custom_font_size ) {
|
|
// Add the custom font size inline style.
|
|
$font_sizes['inline_styles'] = sprintf( 'font-size: %spx;', $context['style']['typography']['fontSize'] );
|
|
}
|
|
|
|
return $font_sizes;
|
|
}
|
|
|
|
/**
|
|
* Outputs Page list markup from an array of pages with nested children.
|
|
*
|
|
* @param boolean $open_submenus_on_click Whether to open submenus on click instead of hover.
|
|
* @param boolean $show_submenu_icons Whether to show submenu indicator icons.
|
|
* @param boolean $is_navigation_child If block is a child of Navigation block.
|
|
* @param array $nested_pages The array of nested pages.
|
|
* @param array $active_page_ancestor_ids An array of ancestor ids for active page.
|
|
* @param array $colors Color information for overlay styles.
|
|
* @param integer $depth The nesting depth.
|
|
*
|
|
* @return string List markup.
|
|
*/
|
|
function block_core_page_list_render_nested_page_list( $open_submenus_on_click, $show_submenu_icons, $is_navigation_child, $nested_pages, $active_page_ancestor_ids = array(), $colors = array(), $depth = 0 ) {
|
|
if ( empty( $nested_pages ) ) {
|
|
return;
|
|
}
|
|
$markup = '';
|
|
foreach ( (array) $nested_pages as $page ) {
|
|
$css_class = $page['is_active'] ? ' current-menu-item' : '';
|
|
$aria_current = $page['is_active'] ? ' aria-current="page"' : '';
|
|
$style_attribute = '';
|
|
|
|
$css_class .= in_array( $page['page_id'], $active_page_ancestor_ids, true ) ? ' current-menu-ancestor' : '';
|
|
if ( isset( $page['children'] ) ) {
|
|
$css_class .= ' has-child';
|
|
}
|
|
|
|
if ( $is_navigation_child ) {
|
|
$css_class .= ' wp-block-navigation-item';
|
|
|
|
if ( $open_submenus_on_click ) {
|
|
$css_class .= ' open-on-click';
|
|
} elseif ( $show_submenu_icons ) {
|
|
$css_class .= ' open-on-hover-click';
|
|
}
|
|
}
|
|
|
|
$navigation_child_content_class = $is_navigation_child ? ' wp-block-navigation-item__content' : '';
|
|
|
|
// If this is the first level of submenus, include the overlay colors.
|
|
if ( 1 === $depth && isset( $colors['overlay_css_classes'], $colors['overlay_inline_styles'] ) ) {
|
|
$css_class .= ' ' . trim( implode( ' ', $colors['overlay_css_classes'] ) );
|
|
if ( '' !== $colors['overlay_inline_styles'] ) {
|
|
$style_attribute = sprintf( ' style="%s"', esc_attr( $colors['overlay_inline_styles'] ) );
|
|
}
|
|
}
|
|
|
|
$title = wp_kses( $page['title'], wp_kses_allowed_html( 'post' ) );
|
|
$aria_label = sprintf(
|
|
/* translators: Accessibility text. %s: Parent page title. */
|
|
__( '%s submenu' ),
|
|
$title
|
|
);
|
|
|
|
$markup .= '<li class="wp-block-pages-list__item' . $css_class . '"' . $style_attribute . '>';
|
|
|
|
if ( isset( $page['children'] ) && $is_navigation_child && $open_submenus_on_click ) {
|
|
$markup .= '<button aria-label="' . $aria_label . '" class="' . $navigation_child_content_class . ' wp-block-navigation-submenu__toggle" aria-expanded="false">' . $title . '<span class="wp-block-page-list__submenu-icon wp-block-navigation__submenu-icon"><svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 12 12" fill="none" role="img" aria-hidden="true" focusable="false"><path d="M1.50002 4L6.00002 8L10.5 4" stroke-width="1.5"></path></svg></span>' .
|
|
'</button>';
|
|
} else {
|
|
$markup .= '<a class="wp-block-pages-list__item__link' . $navigation_child_content_class . '" href="' . esc_url( $page['link'] ) . '"' . $aria_current . '>' . $title . '</a>';
|
|
}
|
|
|
|
if ( isset( $page['children'] ) ) {
|
|
if ( $is_navigation_child && $show_submenu_icons && ! $open_submenus_on_click ) {
|
|
$markup .= '<button aria-label="' . $aria_label . '" class="wp-block-navigation__submenu-icon wp-block-navigation-submenu__toggle" aria-expanded="false">';
|
|
$markup .= '<span class="wp-block-page-list__submenu-icon wp-block-navigation__submenu-icon"><svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 12 12" fill="none" role="img" aria-hidden="true" focusable="false"><path d="M1.50002 4L6.00002 8L10.5 4" stroke-width="1.5"></path></svg></span>';
|
|
$markup .= '</button>';
|
|
}
|
|
$markup .= '<ul class="submenu-container';
|
|
// Extra classname is added when the block is a child of Navigation.
|
|
if ( $is_navigation_child ) {
|
|
$markup .= ' wp-block-navigation__submenu-container';
|
|
}
|
|
$markup .= '">' . block_core_page_list_render_nested_page_list( $open_submenus_on_click, $show_submenu_icons, $is_navigation_child, $page['children'], $active_page_ancestor_ids, $colors, $depth + 1 ) . '</ul>';
|
|
}
|
|
$markup .= '</li>';
|
|
}
|
|
return $markup;
|
|
}
|
|
|
|
/**
|
|
* Outputs nested array of pages
|
|
*
|
|
* @param array $current_level The level being iterated through.
|
|
* @param array $children The children grouped by parent post ID.
|
|
*
|
|
* @return array The nested array of pages.
|
|
*/
|
|
function block_core_page_list_nest_pages( $current_level, $children ) {
|
|
if ( empty( $current_level ) ) {
|
|
return;
|
|
}
|
|
foreach ( (array) $current_level as $key => $current ) {
|
|
if ( isset( $children[ $key ] ) ) {
|
|
$current_level[ $key ]['children'] = block_core_page_list_nest_pages( $children[ $key ], $children );
|
|
}
|
|
}
|
|
return $current_level;
|
|
}
|
|
|
|
/**
|
|
* Renders the `core/page-list` block on server.
|
|
*
|
|
* @param array $attributes The block attributes.
|
|
* @param array $content The saved content.
|
|
* @param array $block The parsed block.
|
|
*
|
|
* @return string Returns the page list markup.
|
|
*/
|
|
function render_block_core_page_list( $attributes, $content, $block ) {
|
|
static $block_id = 0;
|
|
$block_id++;
|
|
|
|
$all_pages = get_pages(
|
|
array(
|
|
'sort_column' => 'menu_order,post_title',
|
|
'order' => 'asc',
|
|
)
|
|
);
|
|
|
|
// If thare are no pages, there is nothing to show.
|
|
if ( empty( $all_pages ) ) {
|
|
return;
|
|
}
|
|
|
|
$top_level_pages = array();
|
|
|
|
$pages_with_children = array();
|
|
|
|
$active_page_ancestor_ids = array();
|
|
|
|
foreach ( (array) $all_pages as $page ) {
|
|
$is_active = ! empty( $page->ID ) && ( get_the_ID() === $page->ID );
|
|
|
|
if ( $is_active ) {
|
|
$active_page_ancestor_ids = get_post_ancestors( $page->ID );
|
|
}
|
|
|
|
if ( $page->post_parent ) {
|
|
$pages_with_children[ $page->post_parent ][ $page->ID ] = array(
|
|
'page_id' => $page->ID,
|
|
'title' => $page->post_title,
|
|
'link' => get_permalink( $page->ID ),
|
|
'is_active' => $is_active,
|
|
);
|
|
} else {
|
|
$top_level_pages[ $page->ID ] = array(
|
|
'page_id' => $page->ID,
|
|
'title' => $page->post_title,
|
|
'link' => get_permalink( $page->ID ),
|
|
'is_active' => $is_active,
|
|
);
|
|
|
|
}
|
|
}
|
|
|
|
$colors = block_core_page_list_build_css_colors( $attributes, $block->context );
|
|
$font_sizes = block_core_page_list_build_css_font_sizes( $block->context );
|
|
$classes = array_merge(
|
|
$colors['css_classes'],
|
|
$font_sizes['css_classes']
|
|
);
|
|
$style_attribute = ( $colors['inline_styles'] . $font_sizes['inline_styles'] );
|
|
$css_classes = trim( implode( ' ', $classes ) );
|
|
|
|
$nested_pages = block_core_page_list_nest_pages( $top_level_pages, $pages_with_children );
|
|
|
|
// Limit the number of items to be visually displayed.
|
|
if ( ! empty( $attributes['__unstableMaxPages'] ) ) {
|
|
$nested_pages = array_slice( $nested_pages, 0, $attributes['__unstableMaxPages'] );
|
|
}
|
|
|
|
$is_navigation_child = array_key_exists( 'showSubmenuIcon', $block->context );
|
|
|
|
$open_submenus_on_click = array_key_exists( 'openSubmenusOnClick', $block->context ) ? $block->context['openSubmenusOnClick'] : false;
|
|
|
|
$show_submenu_icons = array_key_exists( 'showSubmenuIcon', $block->context ) ? $block->context['showSubmenuIcon'] : false;
|
|
|
|
$wrapper_markup = '<ul %1$s>%2$s</ul>';
|
|
|
|
$items_markup = block_core_page_list_render_nested_page_list( $open_submenus_on_click, $show_submenu_icons, $is_navigation_child, $nested_pages, $active_page_ancestor_ids, $colors );
|
|
|
|
$wrapper_attributes = get_block_wrapper_attributes(
|
|
array(
|
|
'class' => $css_classes,
|
|
'style' => $style_attribute,
|
|
)
|
|
);
|
|
|
|
return sprintf(
|
|
$wrapper_markup,
|
|
$wrapper_attributes,
|
|
$items_markup
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Registers the `core/pages` block on server.
|
|
*/
|
|
function register_block_core_page_list() {
|
|
register_block_type_from_metadata(
|
|
__DIR__ . '/page-list',
|
|
array(
|
|
'render_callback' => 'render_block_core_page_list',
|
|
)
|
|
);
|
|
}
|
|
add_action( 'init', 'register_block_core_page_list' );
|