[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/SimplePie/src/ -> Sanitize.php (summary)

(no description)

File Size: 831 lines (30 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Sanitize:: (28 methods):
  __construct()
  remove_div()
  set_image_handler()
  set_registry()
  pass_cache_data()
  set_http_client()
  pass_file_data()
  strip_htmltags()
  encode_instead_of_strip()
  rename_attributes()
  strip_attributes()
  add_attributes()
  strip_comments()
  set_output_encoding()
  set_url_replacements()
  set_https_domains()
  is_https_domain()
  https_url()
  sanitize()
  preprocess()
  replace_urls()
  do_strip_htmltags()
  strip_tag()
  strip_attr()
  rename_attr()
  add_attr()
  get_cache()
  get_http_client()


Class: Sanitize  - X-Ref

Used for data cleanup and post-processing

This class can be overloaded with {@see \SimplePie\SimplePie::set_sanitize_class()}

__construct()   X-Ref


remove_div(bool $enable = true)   X-Ref

return: void

set_image_handler($page = false)   X-Ref

return: void
param: string|false $page

set_registry(\SimplePie\Registry $registry)   X-Ref

return: void

pass_cache_data(bool $enable_cache = true, string $cache_location = './cache', $cache_name_function = 'md5', string $cache_class = Cache::class, ?DataCache $cache = null)   X-Ref

return: void
param: (string&(callable(string): string))|NameFilter $cache_name_function
param: class-string<Cache> $cache_class

set_http_client(ClientInterface $http_client,RequestFactoryInterface $request_factory,UriFactoryInterface $uri_factory)   X-Ref
Set a PSR-18 client and PSR-17 factories

Allows you to use your own HTTP client implementations.

pass_file_data(string $file_class = File::class, int $timeout = 10, string $useragent = '', bool $force_fsockopen = false, array $curl_options = [])   X-Ref

return: void
param: class-string<File> $file_class
param: array<int, mixed> $curl_options

strip_htmltags($tags = ['base', 'blink', 'body', 'doctype', 'embed', 'font', 'form', 'frame', 'frameset', 'html', 'iframe', 'input', 'marquee', 'meta', 'noscript', 'object', 'param', 'script', 'style'])   X-Ref

return: void
param: string[]|string|false $tags Set a list of tags to strip, or set empty string to use default tags, or false to strip nothing.

encode_instead_of_strip(bool $encode = false)   X-Ref

return: void

rename_attributes($attribs = [])   X-Ref

return: void
param: string[]|string $attribs

strip_attributes($attribs = ['bgsound', 'expr', 'id', 'style', 'onclick', 'onerror', 'onfinish', 'onmouseover', 'onmouseout', 'onfocus', 'onblur', 'lowsrc', 'dynsrc'])   X-Ref

return: void
param: string[]|string $attribs

add_attributes(array $attribs = ['audio' => ['preload' => 'none'], 'iframe' => ['sandbox' => 'allow-scripts allow-same-origin'], 'video' => ['preload' => 'none']])   X-Ref

return: void
param: array<string, array<string, string>> $attribs

strip_comments(bool $strip = false)   X-Ref

return: void

set_output_encoding(string $encoding = 'UTF-8')   X-Ref

return: void

set_url_replacements(?array $element_attribute = null)   X-Ref
Set element/attribute key/value pairs of HTML attributes
containing URLs that need to be resolved relative to the feed

Defaults to |a|@href, |area|@href, |audio|@src, |blockquote|@cite,
|del|@cite, |form|@action, |img|@longdesc, |img|@src, |input|@src,
|ins|@cite, |q|@cite, |source|@src, |video|@src

return: void
param: array<string, string|string[]>|null $element_attribute Element/attribute key/value pairs, null for default

set_https_domains(array $domains)   X-Ref
Set the list of domains for which to force HTTPS.

return: void
param: string[] $domains list of domain names ['biz', 'example.com', 'example.org', 'www.example.net']

is_https_domain(string $domain)   X-Ref
Check if the domain is in the list of forced HTTPS.

return: bool

https_url(string $url)   X-Ref
Force HTTPS for selected Web sites.

return: string

sanitize(string $data, int $type, string $base = '')   X-Ref

return: string Sanitized data; false if output encoding is changed to something other than UTF-8 and conversion fails
param: int-mask-of<SimplePie::CONSTRUCT_*> $type
param: string $base

preprocess(string $html, int $type)   X-Ref

return: string
param: int-mask-of<SimplePie::CONSTRUCT_*> $type

replace_urls(DOMDocument $document, string $tag, $attributes)   X-Ref

return: void
param: array<string>|string $attributes

do_strip_htmltags(array $match)   X-Ref

return: string
param: array<int, string> $match

strip_tag(string $tag, DOMDocument $document, DOMXPath $xpath, int $type)   X-Ref

return: void
param: int-mask-of<SimplePie::CONSTRUCT_*> $type

strip_attr(string $attrib, DOMXPath $xpath)   X-Ref

return: void

rename_attr(string $attrib, DOMXPath $xpath)   X-Ref

return: void

add_attr(string $tag, array $valuePairs, DOMDocument $document)   X-Ref

return: void
param: array<string, string> $valuePairs

get_cache(string $image_url = '')   X-Ref
Get a DataCache

return: DataCache
param: string $image_url Only needed for BC, can be removed in SimplePie 2.0.0

get_http_client()   X-Ref
Get a HTTP client




Generated : Wed Sep 17 08:20:04 2025 Cross-referenced by PHPXref