GeminiLabs\SiteReviews\Modules\Sanitizers\SanitizeUserName

Complexity

Total Complexity

5

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Test Coverage

Coverage

94.12%

Importance

Changes	3
Bugs	2	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	sanitizeDisplayName()	0	8	1
A	run()	0	14	4

<?php

namespace GeminiLabs\SiteReviews\Modules\Sanitizers;

class SanitizeUserName extends StringSanitizer
{
    public function run(): string
    {
        $value = $this->sanitizeDisplayName($this->value());
        if (defined('WP_IMPORTING')) {
            return $value;
        }
        if (!empty($value)) {
            return $value;
        }
        $user = wp_get_current_user();
        if (!$user->exists()) {
            return $value;
        }
        return $this->sanitizeDisplayName($user->display_name);
    }

    /**
     * \p{L} = any kind of letter from any language.
     * \p{M} = any character intended to be combined with another character (e.g. accents, umlauts, enclosing boxes, etc.).
     * \p{N} = any kind of numeric character in any script.
     * \p{Pf} = any kind of closing quote.
     * @see https://www.regular-expressions.info/unicode.html
     */
    protected function sanitizeDisplayName(string $value): string
    {
        $value = wp_strip_all_tags($value);
        $value = preg_replace('/%([a-fA-F0-9][a-fA-F0-9])/', '', $value); // Remove percent-encoded characters.
        $value = preg_replace('/&.+?;/', '', $value); // Remove HTML entities.
        $value = preg_replace('/[^\p{L}\p{M}\p{N}\p{Pf}\'\.\,\- ]/u', '', $value);
        $value = sanitize_text_field($value); // Remove extra whitespace.
        return $value;
    }
}