Laravel Tutorials

Process Markdown Securely with Laravel's inlineMarkdown Method

Published
Process Markdown Securely with Laravel's inlineMarkdown Method image

Laravel enhances string processing capabilities with the inlineMarkdown method, providing secure transformation of GitHub-flavored Markdown into inline HTML with built-in XSS protection and customizable security options.

The inlineMarkdown method enables safe Markdown conversion with granular control over security settings:

use Illuminate\Support\Str;
 
// Basic conversion
$html = Str::inlineMarkdown('**Laravel**');
// Result: <strong>Laravel</strong>
 
// Secure conversion with options
$html = Str::inlineMarkdown(
'Inject: <script>alert("Hello XSS!");</script>',
[
'html_input' => 'strip',
'allow_unsafe_links' => false,
]
);
// Result: Inject: alert("Hello XSS!");

This method proves particularly valuable in user-generated content systems:

class ContentProcessor
{
protected $secureOptions = [
'html_input' => 'strip',
'allow_unsafe_links' => false
];
 
public function formatPost(string $content)
{
return Str::inlineMarkdown(
$content,
$this->secureOptions
);
}
 
public function processHashtags(string $content)
{
// Convert #hashtag to links while preserving markdown
$processed = preg_replace(
'/#(\w+)/',
'[#$1](/tags/$1)',
$content
);
 
return Str::inlineMarkdown(
$processed,
$this->secureOptions
);
}
 
public function formatSystemMessage(string $template, array $variables)
{
$content = strtr($template, $variables);
 
return Str::inlineMarkdown(
$content,
[
'html_input' => 'escape',
'allow_unsafe_links' => false
]
);
}
}
 
// Usage
$processor = new ContentProcessor();
 
$post = $processor->formatPost('**Breaking** news update!');
$hashtag = $processor->processHashtags('Love #Laravel development!');

The method excels in forum and discussion systems where rich formatting needs security:

class ForumPostService
{
public function processReply(string $content, User $author)
{
// Handle code blocks and formatting
$formatted = Str::inlineMarkdown($content, [
'html_input' => 'strip',
'allow_unsafe_links' => false,
'use_autolinks' => true
]);
 
return $this->addAuthorContext($formatted, $author);
}
 
public function formatQuote(string $originalContent, string $newContent)
{
$quote = "> " . str_replace("\n", "\n> ", $originalContent);
$combined = $quote . "\n\n" . $newContent;
 
return Str::inlineMarkdown($combined, [
'html_input' => 'strip',
'allow_unsafe_links' => false
]);
}
 
public function processCodeSnippet(string $content)
{
return Str::inlineMarkdown($content, [
'html_input' => 'strip',
'allow_unsafe_links' => false,
'use_underline' => false // Prevent conflicts with code
]);
}
}

For notification systems requiring formatted messages:

class NotificationFormatter
{
public function formatActivityUpdate(Activity $activity)
{
$template = '**{user}** {action} in *{project}*';
 
$message = strtr($template, [
'{user}' => $activity->user->name,
'{action}' => $activity->description,
'{project}' => $activity->project->title
]);
 
return Str::inlineMarkdown($message, [
'html_input' => 'escape',
'allow_unsafe_links' => false
]);
}
 
public function formatSystemAlert(string $message, array $context = [])
{
$processed = strtr($message, $context);
 
return Str::inlineMarkdown($processed, [
'html_input' => 'strip',
'allow_unsafe_links' => false,
'use_autolinks' => false // Disable for security
]);
}
}

The inlineMarkdown method ensures secure Markdown processing by providing comprehensive XSS protection while maintaining the flexibility to format user content with common Markdown syntax like bold, italic, links, and code spans.

Harris Raftopoulos photo

Senior Software Engineer • Staff & Educator @ Laravel News • Co-organizer @ Laravel Greece Meetup

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
CPX: The Composer Package Executor for PHP image

CPX: The Composer Package Executor for PHP

Read article
Laravel AI SDK Adds Human-in-the-Loop Tool Approval image

Laravel AI SDK Adds Human-in-the-Loop Tool Approval

Read article
Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals image

Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals

Read article
Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs image

Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs

Read article
Blade Formatting in Laravel Pint image

Blade Formatting in Laravel Pint

Read article
Inertia DevTools Is Now on the Chrome Web Store image

Inertia DevTools Is Now on the Chrome Web Store

Read article