Skip to content

[6.x] Add safe option to to_json for HTML-embedded JSON#15260

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

Merged
jasonvarga merged 1 commit into from
Aug 24, 2026
Merged

[6.x] Add safe option to to_json for HTML-embedded JSON #15260

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
10 changes: 9 additions & 1 deletion src/Modifiers/CoreModifiers.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2802,7 +2802,15 @@ public function toBool($value, $params)
*/
public function toJson($value, $params)
{
$options = Arr::get($params, 0) === 'pretty' ? JSON_PRETTY_PRINT : 0;
$options = 0;

if (in_array('pretty', $params)) {
$options |= JSON_PRETTY_PRINT;
}

if (in_array('safe', $params)) {
$options |= JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT;
}

if (Compare::isQueryBuilder($value)) {
$value = $value->get();
Expand Down
37 changes: 37 additions & 0 deletions tests/Modifiers/ToJsonTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,43 @@ public function it_pretty_prints($input, $expected): void
$this->assertEquals(json_encode(json_decode($expected, true), JSON_PRETTY_PRINT), $modified);
}

#[Test]
public function it_hex_encodes_html_sensitive_characters_when_safe(): void
{
$value = '</script><script>alert(1)</script>';
$modified = $this->modify($value, ['safe']);

$this->assertSame(
json_encode($value, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT),
$modified,
);
$this->assertStringNotContainsString('</script>', $modified);
$this->assertSame($value, json_decode($modified));
}

#[Test]
#[DataProvider('safeParamOrderProvider')]
public function it_can_combine_pretty_and_safe(array $params): void
{
$value = ['html' => '</script>'];
$modified = $this->modify($value, $params);

$this->assertSame(
json_encode($value, JSON_PRETTY_PRINT | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT),
$modified,
);
$this->assertStringNotContainsString('</script>', $modified);
$this->assertSame($value, json_decode($modified, true));
}

public static function safeParamOrderProvider(): array
{
return [
'pretty then safe' => [['pretty', 'safe']],
'safe then pretty' => [['safe', 'pretty']],
];
}

private function modify($value, $options = [])
{
return Modify::value($value)->toJson($options)->fetch();
Expand Down
Loading