2020-10-13 15:10:30 +02:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Colors block support flag.
|
|
|
|
*
|
|
|
|
* @package WordPress
|
2021-04-15 17:19:43 +02:00
|
|
|
* @since 5.6.0
|
2020-10-13 15:10:30 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Registers the style and colors block attributes for block types that support it.
|
|
|
|
*
|
2021-04-15 17:19:43 +02:00
|
|
|
* @since 5.6.0
|
2022-09-19 22:14:10 +02:00
|
|
|
* @since 6.1.0 Improved $color_support assignment optimization.
|
2020-10-20 15:36:16 +02:00
|
|
|
* @access private
|
|
|
|
*
|
2020-10-13 15:10:30 +02:00
|
|
|
* @param WP_Block_Type $block_type Block Type.
|
|
|
|
*/
|
|
|
|
function wp_register_colors_support( $block_type ) {
|
Editor: Reduce the use of the `_wp_array_get()` function to improve performance.
`_wp_array_get()` is an expensive function, and it's called thousands of times on each page view on the front end. While the function performance was slightly improved in #58376, it is still called more times than it should be.
This commit aims to further optimize its usage:
* In many cases, `_wp_array_get()` can be replaced with a much simpler and faster `isset()` check.
* The `isset()` function is capable of checking nested arrays, so `isset( $foo['a']['b']['c'] )` will return false even if `$foo['a']` is unset, without throwing any errors or warnings.
* When `_wp_array_get()` cannot be directly replaced with `isset()`, it would be good practice to wrap it in an `isset()` function so that `_wp_array_get()` only runs when it needs to.
Original PR from Gutenberg repository:
* [https://github.com/WordPress/gutenberg/pull/51116 #51116 Performance improvement: Reduce the use of the _wp_array_get() function]
Follow-up to [55851], [56382].
Props aristath, jrf, spacedmonkey, mukesh27, swissspidy, hellofromTonya.
Fixes #59405.
Built from https://develop.svn.wordpress.org/trunk@56709
git-svn-id: http://core.svn.wordpress.org/trunk@56221 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-26 15:47:20 +02:00
|
|
|
$color_support = false;
|
2023-09-29 12:20:30 +02:00
|
|
|
if ( $block_type instanceof WP_Block_Type ) {
|
Editor: Reduce the use of the `_wp_array_get()` function to improve performance.
`_wp_array_get()` is an expensive function, and it's called thousands of times on each page view on the front end. While the function performance was slightly improved in #58376, it is still called more times than it should be.
This commit aims to further optimize its usage:
* In many cases, `_wp_array_get()` can be replaced with a much simpler and faster `isset()` check.
* The `isset()` function is capable of checking nested arrays, so `isset( $foo['a']['b']['c'] )` will return false even if `$foo['a']` is unset, without throwing any errors or warnings.
* When `_wp_array_get()` cannot be directly replaced with `isset()`, it would be good practice to wrap it in an `isset()` function so that `_wp_array_get()` only runs when it needs to.
Original PR from Gutenberg repository:
* [https://github.com/WordPress/gutenberg/pull/51116 #51116 Performance improvement: Reduce the use of the _wp_array_get() function]
Follow-up to [55851], [56382].
Props aristath, jrf, spacedmonkey, mukesh27, swissspidy, hellofromTonya.
Fixes #59405.
Built from https://develop.svn.wordpress.org/trunk@56709
git-svn-id: http://core.svn.wordpress.org/trunk@56221 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-26 15:47:20 +02:00
|
|
|
$color_support = isset( $block_type->supports['color'] ) ? $block_type->supports['color'] : false;
|
|
|
|
}
|
|
|
|
$has_text_colors_support = true === $color_support ||
|
|
|
|
( isset( $color_support['text'] ) && $color_support['text'] ) ||
|
|
|
|
( is_array( $color_support ) && ! isset( $color_support['text'] ) );
|
|
|
|
$has_background_colors_support = true === $color_support ||
|
|
|
|
( isset( $color_support['background'] ) && $color_support['background'] ) ||
|
|
|
|
( is_array( $color_support ) && ! isset( $color_support['background'] ) );
|
|
|
|
$has_gradients_support = isset( $color_support['gradients'] ) ? $color_support['gradients'] : false;
|
|
|
|
$has_link_colors_support = isset( $color_support['link'] ) ? $color_support['link'] : false;
|
|
|
|
$has_button_colors_support = isset( $color_support['button'] ) ? $color_support['button'] : false;
|
|
|
|
$has_heading_colors_support = isset( $color_support['heading'] ) ? $color_support['heading'] : false;
|
2021-04-15 17:19:43 +02:00
|
|
|
$has_color_support = $has_text_colors_support ||
|
|
|
|
$has_background_colors_support ||
|
|
|
|
$has_gradients_support ||
|
2023-09-18 08:27:19 +02:00
|
|
|
$has_link_colors_support ||
|
|
|
|
$has_button_colors_support ||
|
|
|
|
$has_heading_colors_support;
|
2020-10-13 15:10:30 +02:00
|
|
|
|
|
|
|
if ( ! $block_type->attributes ) {
|
|
|
|
$block_type->attributes = array();
|
|
|
|
}
|
|
|
|
|
2021-04-15 17:19:43 +02:00
|
|
|
if ( $has_color_support && ! array_key_exists( 'style', $block_type->attributes ) ) {
|
2020-10-13 15:10:30 +02:00
|
|
|
$block_type->attributes['style'] = array(
|
|
|
|
'type' => 'object',
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $has_background_colors_support && ! array_key_exists( 'backgroundColor', $block_type->attributes ) ) {
|
|
|
|
$block_type->attributes['backgroundColor'] = array(
|
|
|
|
'type' => 'string',
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $has_text_colors_support && ! array_key_exists( 'textColor', $block_type->attributes ) ) {
|
|
|
|
$block_type->attributes['textColor'] = array(
|
|
|
|
'type' => 'string',
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $has_gradients_support && ! array_key_exists( 'gradient', $block_type->attributes ) ) {
|
|
|
|
$block_type->attributes['gradient'] = array(
|
|
|
|
'type' => 'string',
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
2022-11-24 23:36:11 +01:00
|
|
|
* Adds CSS classes and inline styles for colors to the incoming attributes array.
|
2020-10-13 15:10:30 +02:00
|
|
|
* This will be applied to the block markup in the front-end.
|
|
|
|
*
|
2021-04-15 17:19:43 +02:00
|
|
|
* @since 5.6.0
|
2022-09-19 22:14:10 +02:00
|
|
|
* @since 6.1.0 Implemented the style engine to generate CSS and classnames.
|
2020-10-20 15:36:16 +02:00
|
|
|
* @access private
|
|
|
|
*
|
2020-10-13 15:10:30 +02:00
|
|
|
* @param WP_Block_Type $block_type Block type.
|
2021-04-15 17:19:43 +02:00
|
|
|
* @param array $block_attributes Block attributes.
|
2020-10-13 15:10:30 +02:00
|
|
|
*
|
|
|
|
* @return array Colors CSS classes and inline styles.
|
|
|
|
*/
|
2020-10-20 15:36:16 +02:00
|
|
|
function wp_apply_colors_support( $block_type, $block_attributes ) {
|
Editor: Reduce the use of the `_wp_array_get()` function to improve performance.
`_wp_array_get()` is an expensive function, and it's called thousands of times on each page view on the front end. While the function performance was slightly improved in #58376, it is still called more times than it should be.
This commit aims to further optimize its usage:
* In many cases, `_wp_array_get()` can be replaced with a much simpler and faster `isset()` check.
* The `isset()` function is capable of checking nested arrays, so `isset( $foo['a']['b']['c'] )` will return false even if `$foo['a']` is unset, without throwing any errors or warnings.
* When `_wp_array_get()` cannot be directly replaced with `isset()`, it would be good practice to wrap it in an `isset()` function so that `_wp_array_get()` only runs when it needs to.
Original PR from Gutenberg repository:
* [https://github.com/WordPress/gutenberg/pull/51116 #51116 Performance improvement: Reduce the use of the _wp_array_get() function]
Follow-up to [55851], [56382].
Props aristath, jrf, spacedmonkey, mukesh27, swissspidy, hellofromTonya.
Fixes #59405.
Built from https://develop.svn.wordpress.org/trunk@56709
git-svn-id: http://core.svn.wordpress.org/trunk@56221 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-26 15:47:20 +02:00
|
|
|
$color_support = isset( $block_type->supports['color'] ) ? $block_type->supports['color'] : false;
|
2021-04-15 17:19:43 +02:00
|
|
|
|
|
|
|
if (
|
|
|
|
is_array( $color_support ) &&
|
2022-04-05 14:08:02 +02:00
|
|
|
wp_should_skip_block_supports_serialization( $block_type, 'color' )
|
2021-04-15 17:19:43 +02:00
|
|
|
) {
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
Editor: Reduce the use of the `_wp_array_get()` function to improve performance.
`_wp_array_get()` is an expensive function, and it's called thousands of times on each page view on the front end. While the function performance was slightly improved in #58376, it is still called more times than it should be.
This commit aims to further optimize its usage:
* In many cases, `_wp_array_get()` can be replaced with a much simpler and faster `isset()` check.
* The `isset()` function is capable of checking nested arrays, so `isset( $foo['a']['b']['c'] )` will return false even if `$foo['a']` is unset, without throwing any errors or warnings.
* When `_wp_array_get()` cannot be directly replaced with `isset()`, it would be good practice to wrap it in an `isset()` function so that `_wp_array_get()` only runs when it needs to.
Original PR from Gutenberg repository:
* [https://github.com/WordPress/gutenberg/pull/51116 #51116 Performance improvement: Reduce the use of the _wp_array_get() function]
Follow-up to [55851], [56382].
Props aristath, jrf, spacedmonkey, mukesh27, swissspidy, hellofromTonya.
Fixes #59405.
Built from https://develop.svn.wordpress.org/trunk@56709
git-svn-id: http://core.svn.wordpress.org/trunk@56221 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-26 15:47:20 +02:00
|
|
|
$has_text_colors_support = true === $color_support ||
|
|
|
|
( isset( $color_support['text'] ) && $color_support['text'] ) ||
|
|
|
|
( is_array( $color_support ) && ! isset( $color_support['text'] ) );
|
|
|
|
$has_background_colors_support = true === $color_support ||
|
|
|
|
( isset( $color_support['background'] ) && $color_support['background'] ) ||
|
|
|
|
( is_array( $color_support ) && ! isset( $color_support['background'] ) );
|
|
|
|
$has_gradients_support = isset( $color_support['gradients'] ) ? $color_support['gradients'] : false;
|
2022-09-19 22:14:10 +02:00
|
|
|
$color_block_styles = array();
|
2020-10-13 15:10:30 +02:00
|
|
|
|
2021-05-07 13:48:27 +02:00
|
|
|
// Text colors.
|
2022-04-05 14:08:02 +02:00
|
|
|
if ( $has_text_colors_support && ! wp_should_skip_block_supports_serialization( $block_type, 'color', 'text' ) ) {
|
2022-09-19 22:14:10 +02:00
|
|
|
$preset_text_color = array_key_exists( 'textColor', $block_attributes ) ? "var:preset|color|{$block_attributes['textColor']}" : null;
|
Editor: Reduce the use of the `_wp_array_get()` function to improve performance.
`_wp_array_get()` is an expensive function, and it's called thousands of times on each page view on the front end. While the function performance was slightly improved in #58376, it is still called more times than it should be.
This commit aims to further optimize its usage:
* In many cases, `_wp_array_get()` can be replaced with a much simpler and faster `isset()` check.
* The `isset()` function is capable of checking nested arrays, so `isset( $foo['a']['b']['c'] )` will return false even if `$foo['a']` is unset, without throwing any errors or warnings.
* When `_wp_array_get()` cannot be directly replaced with `isset()`, it would be good practice to wrap it in an `isset()` function so that `_wp_array_get()` only runs when it needs to.
Original PR from Gutenberg repository:
* [https://github.com/WordPress/gutenberg/pull/51116 #51116 Performance improvement: Reduce the use of the _wp_array_get() function]
Follow-up to [55851], [56382].
Props aristath, jrf, spacedmonkey, mukesh27, swissspidy, hellofromTonya.
Fixes #59405.
Built from https://develop.svn.wordpress.org/trunk@56709
git-svn-id: http://core.svn.wordpress.org/trunk@56221 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-26 15:47:20 +02:00
|
|
|
$custom_text_color = isset( $block_attributes['style']['color']['text'] ) ? $block_attributes['style']['color']['text'] : null;
|
2022-09-19 22:14:10 +02:00
|
|
|
$color_block_styles['text'] = $preset_text_color ? $preset_text_color : $custom_text_color;
|
2020-10-13 15:10:30 +02:00
|
|
|
}
|
|
|
|
|
2021-05-07 13:48:27 +02:00
|
|
|
// Background colors.
|
2022-04-05 14:08:02 +02:00
|
|
|
if ( $has_background_colors_support && ! wp_should_skip_block_supports_serialization( $block_type, 'color', 'background' ) ) {
|
2022-09-19 22:14:10 +02:00
|
|
|
$preset_background_color = array_key_exists( 'backgroundColor', $block_attributes ) ? "var:preset|color|{$block_attributes['backgroundColor']}" : null;
|
Editor: Reduce the use of the `_wp_array_get()` function to improve performance.
`_wp_array_get()` is an expensive function, and it's called thousands of times on each page view on the front end. While the function performance was slightly improved in #58376, it is still called more times than it should be.
This commit aims to further optimize its usage:
* In many cases, `_wp_array_get()` can be replaced with a much simpler and faster `isset()` check.
* The `isset()` function is capable of checking nested arrays, so `isset( $foo['a']['b']['c'] )` will return false even if `$foo['a']` is unset, without throwing any errors or warnings.
* When `_wp_array_get()` cannot be directly replaced with `isset()`, it would be good practice to wrap it in an `isset()` function so that `_wp_array_get()` only runs when it needs to.
Original PR from Gutenberg repository:
* [https://github.com/WordPress/gutenberg/pull/51116 #51116 Performance improvement: Reduce the use of the _wp_array_get() function]
Follow-up to [55851], [56382].
Props aristath, jrf, spacedmonkey, mukesh27, swissspidy, hellofromTonya.
Fixes #59405.
Built from https://develop.svn.wordpress.org/trunk@56709
git-svn-id: http://core.svn.wordpress.org/trunk@56221 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-26 15:47:20 +02:00
|
|
|
$custom_background_color = isset( $block_attributes['style']['color']['background'] ) ? $block_attributes['style']['color']['background'] : null;
|
2022-09-19 22:14:10 +02:00
|
|
|
$color_block_styles['background'] = $preset_background_color ? $preset_background_color : $custom_background_color;
|
2020-10-13 15:10:30 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// Gradients.
|
2022-04-05 14:08:02 +02:00
|
|
|
if ( $has_gradients_support && ! wp_should_skip_block_supports_serialization( $block_type, 'color', 'gradients' ) ) {
|
2022-09-19 22:14:10 +02:00
|
|
|
$preset_gradient_color = array_key_exists( 'gradient', $block_attributes ) ? "var:preset|gradient|{$block_attributes['gradient']}" : null;
|
Editor: Reduce the use of the `_wp_array_get()` function to improve performance.
`_wp_array_get()` is an expensive function, and it's called thousands of times on each page view on the front end. While the function performance was slightly improved in #58376, it is still called more times than it should be.
This commit aims to further optimize its usage:
* In many cases, `_wp_array_get()` can be replaced with a much simpler and faster `isset()` check.
* The `isset()` function is capable of checking nested arrays, so `isset( $foo['a']['b']['c'] )` will return false even if `$foo['a']` is unset, without throwing any errors or warnings.
* When `_wp_array_get()` cannot be directly replaced with `isset()`, it would be good practice to wrap it in an `isset()` function so that `_wp_array_get()` only runs when it needs to.
Original PR from Gutenberg repository:
* [https://github.com/WordPress/gutenberg/pull/51116 #51116 Performance improvement: Reduce the use of the _wp_array_get() function]
Follow-up to [55851], [56382].
Props aristath, jrf, spacedmonkey, mukesh27, swissspidy, hellofromTonya.
Fixes #59405.
Built from https://develop.svn.wordpress.org/trunk@56709
git-svn-id: http://core.svn.wordpress.org/trunk@56221 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-26 15:47:20 +02:00
|
|
|
$custom_gradient_color = isset( $block_attributes['style']['color']['gradient'] ) ? $block_attributes['style']['color']['gradient'] : null;
|
2022-09-19 22:14:10 +02:00
|
|
|
$color_block_styles['gradient'] = $preset_gradient_color ? $preset_gradient_color : $custom_gradient_color;
|
2020-10-13 15:10:30 +02:00
|
|
|
}
|
|
|
|
|
2020-10-20 15:36:16 +02:00
|
|
|
$attributes = array();
|
2022-09-19 22:14:10 +02:00
|
|
|
$styles = wp_style_engine_get_styles( array( 'color' => $color_block_styles ), array( 'convert_vars_to_classnames' => true ) );
|
|
|
|
|
|
|
|
if ( ! empty( $styles['classnames'] ) ) {
|
|
|
|
$attributes['class'] = $styles['classnames'];
|
2020-10-20 15:36:16 +02:00
|
|
|
}
|
2022-09-19 22:14:10 +02:00
|
|
|
|
|
|
|
if ( ! empty( $styles['css'] ) ) {
|
|
|
|
$attributes['style'] = $styles['css'];
|
2020-10-20 15:36:16 +02:00
|
|
|
}
|
|
|
|
|
2020-10-13 15:10:30 +02:00
|
|
|
return $attributes;
|
|
|
|
}
|
2020-10-20 15:36:16 +02:00
|
|
|
|
|
|
|
// Register the block support.
|
|
|
|
WP_Block_Supports::get_instance()->register(
|
|
|
|
'colors',
|
|
|
|
array(
|
|
|
|
'register_attribute' => 'wp_register_colors_support',
|
|
|
|
'apply' => 'wp_apply_colors_support',
|
|
|
|
)
|
|
|
|
);
|