Skip to content

fix: strip null values from theme.json output #892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ishitaj34 wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

fix: strip null values from theme.json output #892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions includes/create-theme/resolver_additions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,13 +116,40 @@ public static function get_user_data() {
: parent::get_user_data();
}

/**
* Recursively remove null values from an array.
*
* The theme.json schema rejects null values and WordPress ignores them.
* Empty arrays and non-null falsy values (false, 0, '') are preserved.
*
* @param mixed $data Data to filter.
* @return mixed Data without null values.
*/
public static function strip_null_values( $data ) {
if ( ! is_array( $data ) ) {
return $data;
}

$clean = array();
foreach ( $data as $key => $value ) {
if ( null === $value ) {
continue;
}
$clean[ $key ] = self::strip_null_values( $value );
}

return $clean;
}

/**
* Stringify the array data.
*
* $data is an array of data to be converted to a JSON string.
* Null values are stripped since they are invalid in theme.json.
* @return string JSON string.
*/
public static function stringify( $data ) {
$data = self::strip_null_values( $data );
$data = wp_json_encode( $data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE );
// Convert spaces to tabs
return preg_replace( '~(?:^|\G)\h{4}~m', "\t", $data );
Expand Down
55 changes: 55 additions & 0 deletions tests/test-theme-utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,59 @@ function oldslug_support() {
$this->assertStringContainsString( 'function new_slug_support', $updated_code_string );
$this->assertStringContainsString( "function_exists( 'new_slug_support' )", $updated_code_string );
}

public function test_stringify_strips_null_values() {
$data = array(
'version' => 3,
'styles' => array(
'blocks' => array(
'core/quote' => array(
'border' => array(
'color' => null,
'style' => null,
'width' => null,
'left' => array(
'color' => 'currentColor',
'style' => 'solid',
'width' => '4px',
),
),
),
),
),
);

$decoded = json_decode( CBT_Theme_JSON_Resolver::stringify( $data ), true );
$this->assertSame(
array(
'left' => array(
'color' => 'currentColor',
'style' => 'solid',
'width' => '4px',
),
),
$decoded['styles']['blocks']['core/quote']['border']
);
$this->assertStringNotContainsString( 'null', CBT_Theme_JSON_Resolver::stringify( $data ) );
}

public function test_strip_null_values_preserves_falsy_values() {
$data = array(
'custom' => false,
'zero' => 0,
'empty' => '',
'list' => array(),
'none' => null,
);

$this->assertSame(
array(
'custom' => false,
'zero' => 0,
'empty' => '',
'list' => array(),
),
CBT_Theme_JSON_Resolver::strip_null_values( $data )
);
}
}
Loading