test_block_name = null;
$this->theme_root = realpath( __DIR__ . '/../data/themedir1' );
$this->orig_theme_dir = $GLOBALS['wp_theme_directories'];
// /themes is necessary as theme.php functions assume /themes is the root if there is only one root.
$GLOBALS['wp_theme_directories'] = array( WP_CONTENT_DIR . '/themes', $this->theme_root );
add_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) );
add_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) );
add_filter( 'template_root', array( $this, 'filter_set_theme_root' ) );
// Clear caches.
wp_clean_themes_cache();
unset( $GLOBALS['wp_themes'] );
WP_Style_Engine_CSS_Rules_Store::remove_all_stores();
}
public function tear_down() {
$GLOBALS['wp_theme_directories'] = $this->orig_theme_dir;
// Clear up the filters to modify the theme root.
remove_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) );
remove_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) );
remove_filter( 'template_root', array( $this, 'filter_set_theme_root' ) );
wp_clean_themes_cache();
unset( $GLOBALS['wp_themes'] );
WP_Style_Engine_CSS_Rules_Store::remove_all_stores();
unregister_block_type( $this->test_block_name );
$this->test_block_name = null;
parent::tear_down();
}
public function filter_set_theme_root() {
return $this->theme_root;
}
private function get_apostrophe_entity() {
// WP 6.9+ has get_block_bindings_supported_attributes() and uses '
// WP 6.8 and earlier use '
return function_exists( 'get_block_bindings_supported_attributes' ) ? ''' : ''';
}
/**
* Tests that background image block support works as expected.
*
* @covers ::gutenberg_render_background_support
*
* @dataProvider data_background_block_support
*
* @param string $theme_name The theme to switch to.
* @param string $block_name The test block name to register.
* @param mixed $background_settings The background block support settings.
* @param mixed $background_style The background styles within the block attributes.
* @param string $expected_wrapper Expected markup for the block wrapper.
* @param string $wrapper Existing markup for the block wrapper.
*/
public function test_background_block_support( $theme_name, $block_name, $background_settings, $background_style, $expected_wrapper, $wrapper ) {
switch_theme( $theme_name );
$this->test_block_name = $block_name;
register_block_type(
$this->test_block_name,
array(
'api_version' => 2,
'attributes' => array(
'style' => array(
'type' => 'object',
),
),
'supports' => array(
'background' => $background_settings,
),
)
);
$block = array(
'blockName' => $block_name,
'attrs' => array(
'style' => array(
'background' => $background_style,
),
),
);
$actual = gutenberg_render_background_support( $wrapper, $block );
$this->assertSame(
$expected_wrapper,
$actual,
'Background block wrapper markup should be correct'
);
}
/**
* Data provider.
*
* @return array
*/
public function data_background_block_support() {
// Get the appropriate apostrophe encoding based on WordPress version.
// function_exists() works in data providers, unlike get_bloginfo().
$apos = $this->get_apostrophe_entity();
return array(
'background image style is applied' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-rules-are-output',
'background_settings' => array(
'backgroundImage' => true,
),
'background_style' => array(
'backgroundImage' => array(
'url' => 'https://example.com/image.jpg',
),
),
'expected_wrapper' => '
Content
',
'wrapper' => 'Content
',
),
'background image style is applied when backgroundImage is a string' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-rules-are-output',
'background_settings' => array(
'backgroundImage' => true,
),
'background_style' => array(
'backgroundImage' => "url('https://example.com/image.jpg')",
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background image style with contain, position, attachment, and repeat is applied' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-rules-are-output',
'background_settings' => array(
'backgroundImage' => true,
),
'background_style' => array(
'backgroundImage' => array(
'url' => 'https://example.com/image.jpg',
),
'backgroundRepeat' => 'no-repeat',
'backgroundSize' => 'contain',
'backgroundAttachment' => 'fixed',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background image style is appended if a style attribute already exists' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-rules-are-output',
'background_settings' => array(
'backgroundImage' => true,
),
'background_style' => array(
'backgroundImage' => array(
'url' => 'https://example.com/image.jpg',
),
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background image style is appended if a style attribute containing multiple styles already exists' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-rules-are-output',
'background_settings' => array(
'backgroundImage' => true,
),
'background_style' => array(
'backgroundImage' => array(
'url' => 'https://example.com/image.jpg',
),
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background gradient style is applied' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-gradient-rules-are-output',
'background_settings' => array(
'gradient' => true,
),
'background_style' => array(
'gradient' => 'linear-gradient(135deg,rgb(255,0,0) 0%,rgb(0,0,255) 100%)',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background gradient style is not applied if the block does not support it' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-gradient-rules-are-not-output',
'background_settings' => array(
'gradient' => false,
),
'background_style' => array(
'gradient' => 'linear-gradient(135deg,rgb(255,0,0) 0%,rgb(0,0,255) 100%)',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background gradient style with preset slug is applied' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-gradient-preset-slug',
'background_settings' => array(
'gradient' => true,
),
'background_style' => array(
'gradient' => 'var:preset|gradient|vivid-cyan-blue',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background gradient and image combined' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-gradient-and-image-combined',
'background_settings' => array(
'backgroundImage' => true,
'gradient' => true,
),
'background_style' => array(
'backgroundImage' => array(
'url' => 'https://example.com/image.jpg',
),
'gradient' => 'linear-gradient(135deg,rgb(255,0,0) 0%,rgb(0,0,255) 100%)',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background gradient with hsl colors and image combined' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-gradient-hsl-and-image',
'background_settings' => array(
'backgroundImage' => true,
'gradient' => true,
),
'background_style' => array(
'backgroundImage' => array(
'url' => 'https://example.com/image.jpg',
),
'gradient' => 'linear-gradient(135deg,hsl(0,100%,50%) 0%,hsl(240,100%,50%) 100%)',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background gradient is applied without the image when the image skips serialization' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-image-skipped-gradient-applied',
'background_settings' => array(
'backgroundImage' => true,
'gradient' => true,
'__experimentalSkipSerialization' => array( 'backgroundImage' ),
),
'background_style' => array(
'backgroundImage' => array(
'url' => 'https://example.com/image.jpg',
),
'gradient' => 'linear-gradient(135deg,rgb(255,0,0) 0%,rgb(0,0,255) 100%)',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background image style is not applied if the block does not support background image' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-rules-are-not-output',
'background_settings' => array(
'backgroundImage' => false,
),
'background_style' => array(
'backgroundImage' => array(
'url' => 'https://example.com/image.jpg',
),
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background clip alone does not add has-background' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-clip-is-output',
'background_settings' => array(
'backgroundClip' => true,
),
'background_style' => array(
'backgroundClip' => 'border-box',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background clip text style is applied with vendor prefixes' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-clip-text-is-output',
'background_settings' => array(
'backgroundClip' => true,
),
'background_style' => array(
'backgroundClip' => 'text',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background clip alone does not add has-background for block with only backgroundClip support' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-clip-only-support',
'background_settings' => array(
'backgroundClip' => true,
),
'background_style' => array(
'backgroundClip' => 'padding-box',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background clip style is not applied if the block does not support it' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-clip-not-supported',
'background_settings' => array(
'backgroundClip' => false,
),
'background_style' => array(
'backgroundClip' => 'text',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background clip keeps has-background when a background is painted into a box' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-clip-with-gradient',
'background_settings' => array(
'gradient' => true,
'backgroundClip' => true,
),
'background_style' => array(
'gradient' => 'linear-gradient(135deg,rgb(255,0,0) 0%,rgb(0,0,255) 100%)',
'backgroundClip' => 'padding-box',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background clipped to text drops has-background from a gradient' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-clip-text-with-gradient',
'background_settings' => array(
'gradient' => true,
'backgroundClip' => true,
),
'background_style' => array(
'gradient' => 'linear-gradient(135deg,rgb(255,0,0) 0%,rgb(0,0,255) 100%)',
'backgroundClip' => 'text',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background clipped to text keeps has-background when the block does not support the clip' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-clip-text-without-clip-support',
'background_settings' => array(
'gradient' => true,
'backgroundClip' => false,
),
'background_style' => array(
'gradient' => 'linear-gradient(135deg,rgb(255,0,0) 0%,rgb(0,0,255) 100%)',
'backgroundClip' => 'text',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
'background clip style is appended to existing styles' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-clip-appends-styles',
'background_settings' => array(
'backgroundClip' => true,
),
'background_style' => array(
'backgroundClip' => 'content-box',
),
'expected_wrapper' => 'Content
',
'wrapper' => 'Content
',
),
);
}
/**
* @covers ::gutenberg_get_background_classes_and_styles
*
* @dataProvider data_get_background_classes_and_styles
*
* @param mixed $block_attributes Block attributes.
* @param array $expected Expected classes and styles.
*/
public function test_get_background_classes_and_styles( $block_attributes, $expected ) {
$this->assertSame( $expected, gutenberg_get_background_classes_and_styles( $block_attributes ) );
}
/**
* Data provider.
*
* @return array
*/
public function data_get_background_classes_and_styles() {
return array(
'custom image gets default size' => array(
'block_attributes' => array(
'style' => array(
'background' => array(
'backgroundImage' => array( 'url' => 'https://example.com/image.jpg' ),
),
),
),
'expected' => array(
'class' => 'has-background',
'style' => "background-image:url('https://example.com/image.jpg');background-size:cover;",
),
),
'contain without position is centered' => array(
'block_attributes' => array(
'style' => array(
'background' => array(
'backgroundImage' => array( 'url' => 'https://example.com/image.jpg' ),
'backgroundSize' => 'contain',
'backgroundRepeat' => 'no-repeat',
'backgroundAttachment' => 'fixed',
),
),
),
'expected' => array(
'class' => 'has-background',
'style' => "background-image:url('https://example.com/image.jpg');background-position:50% 50%;background-repeat:no-repeat;background-size:contain;background-attachment:fixed;",
),
),
'clip alone has no class' => array(
'block_attributes' => array(
'style' => array(
'background' => array(
'backgroundClip' => 'padding-box',
),
),
),
'expected' => array(
'style' => 'background-clip:padding-box;-webkit-text-fill-color:currentColor;',
),
),
'image clipped to text has no class' => array(
'block_attributes' => array(
'style' => array(
'background' => array(
'backgroundImage' => array( 'url' => 'https://example.com/image.jpg' ),
'backgroundClip' => 'text',
),
),
),
'expected' => array(
'style' => "background-image:url('https://example.com/image.jpg');background-size:cover;background-clip:text;-webkit-background-clip:text;-webkit-text-fill-color:transparent;",
),
),
'background is not an array' => array(
'block_attributes' => array(
'style' => array(
'background' => 'linear-gradient(red, blue)',
),
),
'expected' => array(),
),
'attributes are a string' => array(
'block_attributes' => 'style',
'expected' => array(),
),
'attributes are an object' => array(
'block_attributes' => (object) array( 'style' => array() ),
'expected' => array(),
),
);
}
/**
* Tests that background gradients using functions beyond rgb()/rgba(), and
* gradients combined with a url() image, survive KSES sanitization.
*
* @covers ::gutenberg_allow_extended_gradient_backgrounds
*
* @dataProvider data_background_gradient_values_pass_kses
*
* @param string $css The CSS declaration to test.
*/
public function test_background_gradient_values_pass_kses( $css ) {
$result = safecss_filter_attr( $css );
$this->assertNotEmpty( $result, "Expected CSS to be allowed: $css" );
$this->assertStringContainsString( 'background-image', $result );
}
/**
* Data provider for gradient background-image KSES tests.
*
* @return array[]
*/
public function data_background_gradient_values_pass_kses() {
return array(
'gradient first with rgb colors' => array(
'background-image: linear-gradient(135deg, rgb(255,0,0) 0%, rgb(0,0,255) 100%), url(https://example.com/image.jpg)',
),
'url first with rgb colors' => array(
'background-image: url(https://example.com/image.jpg), linear-gradient(135deg, rgb(255,0,0) 0%, rgb(0,0,255) 100%)',
),
'gradient first with rgba colors' => array(
'background-image: linear-gradient(135deg, rgba(0,0,0,0.8) 0%, rgba(255,255,255,0.2) 100%), url(https://example.com/image.jpg)',
),
'gradient first with hsl colors' => array(
'background-image: linear-gradient(135deg, hsl(0, 100%, 50%) 0%, hsl(240, 100%, 50%) 100%), url(https://example.com/image.jpg)',
),
'gradient first with hsla colors' => array(
'background-image: linear-gradient(135deg, hsla(0, 100%, 50%, 0.8) 0%, hsla(240, 100%, 50%, 0.5) 100%), url(https://example.com/image.jpg)',
),
'gradient first with oklch colors' => array(
'background-image: linear-gradient(135deg, oklch(0.7 0.15 30) 0%, oklch(0.5 0.2 260) 100%), url(https://example.com/image.jpg)',
),
'gradient first with lab colors' => array(
'background-image: linear-gradient(135deg, lab(50% 40 59.5) 0%, lab(70% -45 0) 100%), url(https://example.com/image.jpg)',
),
'radial gradient with url' => array(
'background-image: radial-gradient(circle, rgb(255,0,0) 0%, rgb(0,0,255) 100%), url(https://example.com/image.jpg)',
),
'conic gradient with url' => array(
'background-image: conic-gradient(rgb(255,0,0), rgb(0,0,255)), url(https://example.com/image.jpg)',
),
'repeating-linear gradient with url' => array(
'background-image: repeating-linear-gradient(45deg, rgb(255,0,0) 0px, rgb(0,0,255) 40px), url(https://example.com/image.jpg)',
),
'var preset gradient first with url' => array(
'background-image: var(--wp--preset--gradient--vivid-cyan-blue), url(https://example.com/image.jpg)',
),
'url first with var preset gradient' => array(
'background-image: url(https://example.com/image.jpg), var(--wp--preset--gradient--vivid-cyan-blue)',
),
'gradient with hex colors' => array(
'background-image: linear-gradient(135deg, #ff0000 0%, #0000ff 100%), url(https://example.com/image.jpg)',
),
'standalone hsl gradient' => array(
'background-image: linear-gradient(135deg, hsl(0, 100%, 50%) 0%, hsl(240, 100%, 50%) 100%)',
),
'standalone oklch gradient' => array(
'background-image: linear-gradient(oklch(0.7 0.15 30), oklch(0.5 0.2 260))',
),
'standalone gradient with calc' => array(
'background-image: linear-gradient(red 0%, blue calc(50% + 10px))',
),
);
}
}