<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56614] trunk: Editor: add background image support.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56614">56614</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56614","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>isabel_brison</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-19 01:27:43 +0000 (Tue, 19 Sep 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Editor: add background image support.
Adds a new background block support with the ability to set a background image on blocks that opt into it.
Props andrewserong, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/59357">#59357</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpthemejsonphp">trunk/src/wp-includes/class-wp-theme-json.php</a></li>
<li><a href="#trunksrcwpincludesstyleengineclasswpstyleenginephp">trunk/src/wp-includes/style-engine/class-wp-style-engine.php</a></li>
<li><a href="#trunksrcwpsettingsphp">trunk/src/wp-settings.php</a></li>
<li><a href="#trunktestsphpunittestsstyleenginestyleEnginephp">trunk/tests/phpunit/tests/style-engine/styleEngine.php</a></li>
<li><a href="#trunktestsphpunitteststhemewpThemeJsonphp">trunk/tests/phpunit/tests/theme/wpThemeJson.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksupportsbackgroundphp">trunk/src/wp-includes/block-supports/background.php</a></li>
<li><a href="#trunktestsphpunittestsblocksupportswpRenderBackgroundSupportphp">trunk/tests/phpunit/tests/block-supports/wpRenderBackgroundSupport.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocksupportsbackgroundphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/block-supports/background.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-supports/background.php (rev 0)
+++ trunk/src/wp-includes/block-supports/background.php 2023-09-19 01:27:43 UTC (rev 56614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,112 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Background block support flag.
+ *
+ * @package WordPress
+ * @since 6.4.0
+ */
+
+/**
+ * Registers the style block attribute for block types that support it.
+ *
+ * @since 6.4.0
+ * @access private
+ *
+ * @param WP_Block_Type $block_type Block Type.
+ */
+function wp_register_background_support( $block_type ) {
+ // Setup attributes and styles within that if needed.
+ if ( ! $block_type->attributes ) {
+ $block_type->attributes = array();
+ }
+
+ // Check for existing style attribute definition e.g. from block.json.
+ if ( array_key_exists( 'style', $block_type->attributes ) ) {
+ return;
+ }
+
+ $has_background_support = block_has_support( $block_type, array( 'background' ), false );
+
+ if ( $has_background_support ) {
+ $block_type->attributes['style'] = array(
+ 'type' => 'object',
+ );
+ }
+}
+
+/**
+ * Renders the background styles to the block wrapper.
+ * This block support uses the `render_block` hook to ensure that
+ * it is also applied to non-server-rendered blocks.
+ *
+ * @since 6.4.0
+ * @access private
+ *
+ * @param string $block_content Rendered block content.
+ * @param array $block Block object.
+ * @return string Filtered block content.
+ */
+function wp_render_background_support( $block_content, $block ) {
+ $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
+ $block_attributes = $block['attrs'];
+ $has_background_image_support = block_has_support( $block_type, array( 'background', 'backgroundImage' ), false );
+
+ if (
+ ! $has_background_image_support ||
+ wp_should_skip_block_supports_serialization( $block_type, 'background', 'backgroundImage' )
+ ) {
+ return $block_content;
+ }
+
+ $background_image_source = _wp_array_get( $block_attributes, array( 'style', 'background', 'backgroundImage', 'source' ), null );
+ $background_image_url = _wp_array_get( $block_attributes, array( 'style', 'background', 'backgroundImage', 'url' ), null );
+ $background_size = _wp_array_get( $block_attributes, array( 'style', 'background', 'backgroundSize' ), 'cover' );
+
+ $background_block_styles = array();
+
+ if (
+ 'file' === $background_image_source &&
+ $background_image_url
+ ) {
+ // Set file based background URL.
+ $background_block_styles['backgroundImage']['url'] = $background_image_url;
+ // Only output the background size when an image url is set.
+ $background_block_styles['backgroundSize'] = $background_size;
+ }
+
+ $styles = wp_style_engine_get_styles( array( 'background' => $background_block_styles ) );
+
+ if ( ! empty( $styles['css'] ) ) {
+ // Inject background styles to the first element, presuming it's the wrapper, if it exists.
+ $tags = new WP_HTML_Tag_Processor( $block_content );
+
+ if ( $tags->next_tag() ) {
+ $existing_style = $tags->get_attribute( 'style' );
+ $updated_style = '';
+
+ if ( ! empty( $existing_style ) ) {
+ $updated_style = $existing_style;
+ if ( ! str_ends_with( $existing_style, ';' ) ) {
+ $updated_style .= ';';
+ }
+ }
+
+ $updated_style .= $styles['css'];
+ $tags->set_attribute( 'style', $updated_style );
+ }
+
+ return $tags->get_updated_html();
+ }
+
+ return $block_content;
+}
+
+// Register the block support.
+WP_Block_Supports::get_instance()->register(
+ 'background',
+ array(
+ 'register_attribute' => 'wp_register_background_support',
+ )
+);
+
+add_filter( 'render_block', 'wp_render_background_support', 10, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/src/wp-includes/block-supports/background.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunksrcwpincludesclasswpthemejsonphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-theme-json.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-theme-json.php 2023-09-18 17:36:51 UTC (rev 56613)
+++ trunk/src/wp-includes/class-wp-theme-json.php 2023-09-19 01:27:43 UTC (rev 56614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -342,13 +342,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0 Added `dimensions.minHeight`, 'shadow.presets', 'shadow.defaultPresets',
</span><span class="cx" style="display: block; padding: 0 10px"> * `position.fixed` and `position.sticky`.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.3.0 Added support for `typography.textColumns`, removed `layout.definitions`.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 6.4.0 Added `layout.allowEditing` and `typography.writingMode`.
- *
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.4.0 Added support for `layout.allowEditing`, `background.backgroundImage`,
+ * and `typography.writingMode`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> const VALID_SETTINGS = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'appearanceTools' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> 'useRootPaddingAwareAlignments' => null,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'background' => array(
+ 'backgroundImage' => null,
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'border' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'color' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> 'radius' => null,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -563,9 +566,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0 Added `dimensions.minHeight` and `position.sticky`.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.4.0 Added `background.backgroundImage`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> const APPEARANCE_TOOLS_OPT_INS = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array( 'background', 'backgroundImage' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> array( 'border', 'color' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'border', 'radius' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'border', 'style' ),
</span></span></pre></div>
<a id="trunksrcwpincludesstyleengineclasswpstyleenginephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/style-engine/class-wp-style-engine.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/style-engine/class-wp-style-engine.php 2023-09-18 17:36:51 UTC (rev 56613)
+++ trunk/src/wp-includes/style-engine/class-wp-style-engine.php 2023-09-19 01:27:43 UTC (rev 56614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,6 +22,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.3.0 Added support for text-columns.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.4.0 Added support for background.backgroundImage.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> #[AllowDynamicProperties]
</span><span class="cx" style="display: block; padding: 0 10px"> final class WP_Style_Engine {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,6 +52,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> const BLOCK_STYLE_DEFINITIONS_METADATA = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'background' => array(
+ 'backgroundImage' => array(
+ 'property_keys' => array(
+ 'default' => 'background-image',
+ ),
+ 'value_func' => array( self::class, 'get_url_or_value_css_declaration' ),
+ 'path' => array( 'background', 'backgroundImage' ),
+ ),
+ 'backgroundSize' => array(
+ 'property_keys' => array(
+ 'default' => 'background-size',
+ ),
+ 'path' => array( 'background', 'backgroundSize' ),
+ ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'color' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'text' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'property_keys' => array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -590,6 +606,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Style value parser that constructs a CSS definition array comprising a single CSS property and value.
+ * If the provided value is an array containing a `url` property, the function will return a CSS definition array
+ * with a single property and value, with `url` escaped and injected into a CSS `url()` function,
+ * e.g., array( 'background-image' => "url( '...' )" ).
+ *
+ * @since 6.4.0
+ *
+ * @param array $style_value A single raw style value from $block_styles array.
+ * @param array $style_definition A single style definition from BLOCK_STYLE_DEFINITIONS_METADATA.
+ * @return string[] An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ).
+ */
+ protected static function get_url_or_value_css_declaration( $style_value, $style_definition ) {
+ if ( empty( $style_value ) ) {
+ return array();
+ }
+
+ $css_declarations = array();
+
+ if ( isset( $style_definition['property_keys']['default'] ) ) {
+ $value = null;
+
+ if ( ! empty( $style_value['url'] ) ) {
+ $value = "url('" . $style_value['url'] . "')";
+ } elseif ( is_string( $style_value ) ) {
+ $value = $style_value;
+ }
+
+ if ( null !== $value ) {
+ $css_declarations[ $style_definition['property_keys']['default'] ] = $value;
+ }
+ }
+
+ return $css_declarations;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Returns compiled CSS from CSS declarations.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.0
</span></span></pre></div>
<a id="trunksrcwpsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-settings.php 2023-09-18 17:36:51 UTC (rev 56613)
+++ trunk/src/wp-settings.php 2023-09-19 01:27:43 UTC (rev 56614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -340,6 +340,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/class-wp-block-supports.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/block-supports/utils.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/block-supports/align.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require ABSPATH . WPINC . '/block-supports/background.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/block-supports/border.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/block-supports/colors.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/block-supports/custom-classname.php';
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksupportswpRenderBackgroundSupportphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/block-supports/wpRenderBackgroundSupport.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-supports/wpRenderBackgroundSupport.php (rev 0)
+++ trunk/tests/phpunit/tests/block-supports/wpRenderBackgroundSupport.php 2023-09-19 01:27:43 UTC (rev 56614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,188 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * @group block-supports
+ *
+ * @covers ::wp_render_background_support
+ */
+class Tests_Block_Supports_WpRenderBackgroundSupport extends WP_UnitTestCase {
+ /**
+ * @var string|null
+ */
+ private $test_block_name;
+
+ /**
+ * Theme root directory.
+ *
+ * @var string
+ */
+ private $theme_root;
+
+ /**
+ * Original theme directory.
+ *
+ * @var string
+ */
+ private $orig_theme_dir;
+
+ public function set_up() {
+ parent::set_up();
+ $this->test_block_name = null;
+ $this->theme_root = realpath( DIR_TESTDATA . '/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;
+ }
+
+ /**
+ * Tests that background image block support works as expected.
+ *
+ * @ticket 59357
+ *
+ * @covers ::wp_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 = wp_render_background_support( $wrapper, $block );
+
+ $this->assertEquals(
+ $expected_wrapper,
+ $actual,
+ 'Background block wrapper markup should be correct'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_background_block_support() {
+ 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',
+ 'source' => 'file',
+ ),
+ ),
+ 'expected_wrapper' => '<div style="background-image:url('https://example.com/image.jpg');background-size:cover;">Content</div>',
+ 'wrapper' => '<div>Content</div>',
+ ),
+ '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',
+ 'source' => 'file',
+ ),
+ ),
+ 'expected_wrapper' => '<div classname="wp-block-test" style="color: red;background-image:url('https://example.com/image.jpg');background-size:cover;">Content</div>',
+ 'wrapper' => '<div classname="wp-block-test" style="color: red">Content</div>',
+ ),
+ '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',
+ 'source' => 'file',
+ ),
+ ),
+ 'expected_wrapper' => '<div classname="wp-block-test" style="color: red;font-size: 15px;background-image:url('https://example.com/image.jpg');background-size:cover;">Content</div>',
+ 'wrapper' => '<div classname="wp-block-test" style="color: red;font-size: 15px;">Content</div>',
+ ),
+ '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',
+ 'source' => 'file',
+ ),
+ ),
+ 'expected_wrapper' => '<div>Content</div>',
+ 'wrapper' => '<div>Content</div>',
+ ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/block-supports/wpRenderBackgroundSupport.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestsstyleenginestyleEnginephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/style-engine/styleEngine.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/style-engine/styleEngine.php 2023-09-18 17:36:51 UTC (rev 56613)
+++ trunk/tests/phpunit/tests/style-engine/styleEngine.php 2023-09-19 01:27:43 UTC (rev 56614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -509,6 +509,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ 'inline_background_image_url_with_background_size' => array(
+ 'block_styles' => array(
+ 'background' => array(
+ 'backgroundImage' => array(
+ 'url' => 'https://example.com/image.jpg',
+ ),
+ 'backgroundSize' => 'cover',
+ ),
+ ),
+ 'options' => array(),
+ 'expected_output' => array(
+ 'css' => "background-image:url('https://example.com/image.jpg');background-size:cover;",
+ 'declarations' => array(
+ 'background-image' => "url('https://example.com/image.jpg')",
+ 'background-size' => 'cover',
+ ),
+ ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunitteststhemewpThemeJsonphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/theme/wpThemeJson.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/wpThemeJson.php 2023-09-18 17:36:51 UTC (rev 56613)
+++ trunk/tests/phpunit/tests/theme/wpThemeJson.php 2023-09-19 01:27:43 UTC (rev 56614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -262,6 +262,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $actual = $theme_json->get_settings();
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'background' => array(
+ 'backgroundImage' => true,
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'border' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'width' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'style' => true,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -295,6 +298,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'core/group' => array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'background' => array(
+ 'backgroundImage' => true,
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'border' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'width' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'style' => true,
</span></span></pre>
</div>
</div>
</body>
</html>