Skip to content
PHP Ecosystem
Explore

Filter

API reference › HTML SVG › Filter

Represents the SVG <filter> (filter) element for defining filter effects.

Provides a concrete <filter> element implementation that returns SvgBlock::FILTER and provides filter and geometry attribute methods.

The <filter> element defines a filter that can be applied to other elements.

Usage example:

use UIAwesome\Html\Svg\Filter;
echo Filter::tag()
->id('shadow')
->content('<feDropShadow dx="0" dy="2" stdDeviation="2" flood-opacity="0.25" />')
->render();

See also: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/filter (BaseBlock for the base block-level implementation.).

PropertyTypeDescriptionDefined by
$attributes protectedmixed[]HTML attributes array used by the implementing class. Default: [].UIAwesome\Html\Mixin\HasAttributes
$content protectedstringContent string assigned to the element. Default: ''.UIAwesome\Html\Mixin\HasContent
MethodDescriptionDefined by
__construct() finalInitializes a new tag instance.UIAwesome\Html\Core\Base\BaseTag
__toString()Returns the rendered tag string.UIAwesome\Html\Core\Base\BaseTag
accesskey()Sets the accesskey attribute.UIAwesome\Html\Attribute\Global\HasAccesskey
addAriaAttribute()Sets an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
addAttribute()Adds or updates a single HTML attribute for the element.UIAwesome\Html\Mixin\HasAttributes
addDataAttribute()Sets a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
addEvent()Sets an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
ariaAttributes()Sets multiple aria-* attributes.UIAwesome\Html\Attribute\Global\HasAria
attributes()Adds or updates multiple HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
autofocus()Sets the autofocus attribute.UIAwesome\Html\Attribute\Global\CanBeAutofocus
begin() finalStarts begin/end rendering for this instance.UIAwesome\Html\Core\Element\BaseBlock
class()Sets the class attribute.UIAwesome\Html\Attribute\Global\HasClass
clearContent()Clears encoded and raw content without changing other component state.UIAwesome\Html\Mixin\HasContent
config()Applies application-scoped config recipes to this tag.UIAwesome\Html\Core\Base\BaseTag
content()Appends encoded content.UIAwesome\Html\Mixin\HasContent
contentEditable()Sets the contenteditable attribute.UIAwesome\Html\Attribute\Global\HasContentEditable
dataAttributes()Sets multiple data-* attributes.UIAwesome\Html\Attribute\Global\HasData
dir()Sets the dir attribute.UIAwesome\Html\Attribute\Global\HasDir
draggable()Sets the draggable attribute.UIAwesome\Html\Attribute\Global\HasDraggable
end() static finalEnds the most recent begin/end rendering block for the current class.UIAwesome\Html\Core\Element\BaseBlock
events()Sets multiple on* event attributes.UIAwesome\Html\Attribute\Global\HasEvents
filterUnits()Sets the filterUnits attribute for the <filter> element.Filter
getAttribute()Returns the value of a single HTML attribute.UIAwesome\Html\Mixin\HasAttributes
getAttributes()Returns the array of HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
getContent()Returns the content assigned to the element.UIAwesome\Html\Mixin\HasContent
height()Sets the height attribute.Filter
hidden()Sets the hidden attribute.UIAwesome\Html\Attribute\Global\CanBeHidden
html()Appends trusted raw HTML content without encoding or sanitizing it.UIAwesome\Html\Mixin\HasContent
id()Sets the id attribute.UIAwesome\Html\Attribute\Global\HasId
itemId()Sets the itemid attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemProp()Sets the itemprop attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemRef()Sets the itemref attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemScope()Sets the itemscope attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemType()Sets the itemtype attribute.UIAwesome\Html\Attribute\Global\HasMicroData
lang()Sets the lang attribute.UIAwesome\Html\Attribute\Global\HasLang
primitiveUnits()Sets the primitiveUnits attribute for the <filter> element.Filter
removeAriaAttribute()Removes an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
removeAttribute()Removes a specific HTML attribute from the element.UIAwesome\Html\Mixin\HasAttributes
removeDataAttribute()Removes a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
removeEvent()Removes an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
render() finalRenders the tag with lifecycle hooks.UIAwesome\Html\Core\Base\BaseTag
replaceAttributes()Replaces all HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
role()Sets the role attribute.UIAwesome\Html\Attribute\Global\HasRole
spellcheck()Sets the spellcheck attribute.UIAwesome\Html\Attribute\Global\HasSpellcheck
style()Sets the style attribute.UIAwesome\Html\Attribute\Global\HasStyle
tabIndex()Sets the tabindex attribute.UIAwesome\Html\Attribute\Global\HasTabindex
tag() staticCreates and configures a new tag instance.UIAwesome\Html\Core\Base\BaseTag
title()Sets the title attribute.UIAwesome\Html\Attribute\Global\HasTitle
translate()Sets the translate attribute.UIAwesome\Html\Attribute\Global\HasTranslate
width()Sets the width attribute.Filter
x()Sets the SVG x attribute for the element.Filter
y()Sets the SVG y attribute for the element.Filter
afterRun() protectedPost-processes rendered output.UIAwesome\Html\Core\Event\HasAfterRun
beforeRun() protectedValidates state before rendering.UIAwesome\Html\Core\Event\HasBeforeRun
getTag() protectedReturns the tag enumeration for the <filter> element.Filter
isBeginExecuted() protectedIndicates whether this instance has an open or closing operation in the current context.UIAwesome\Html\Core\Element\BaseBlock
loadDefault() protectedReturns class-level default definitions.UIAwesome\Html\Core\Base\BaseTag
run() protectedRenders the block element.UIAwesome\Html\Core\Element\BaseBlock
runBegin() protectedReturns the opening tag for begin/end rendering.UIAwesome\Html\Core\Element\BaseBlock
public function filterUnits(UIAwesome\Html\Svg\Values\CoordinateUnits|string|null $value): static

Sets the filterUnits attribute for the <filter> element.

Creates a new instance with the specified filter units value for the rendered <filter> element.

Parameters

ParameterTypeDescription
$valueUIAwesome\Html\Svg\Values\CoordinateUnits|string|nullFilter units value (for example, ‘objectBoundingBox’ or ‘userSpaceOnUse’).

Returns

static: New instance with the updated filterUnits property.

Throws

public function height(int|string|Stringable|UnitEnum|null $value): static

Sets the height attribute.

Usage example:

$element->height(200);
$element->height('50%');
$element->height('auto');

Parameters

ParameterTypeDescription
$valueint|string|Stringable|UnitEnum|nullHeight value in pixels or CSS units, or null to remove the attribute.

Returns

static: New instance with the updated height attribute.

public function primitiveUnits(UIAwesome\Html\Svg\Values\CoordinateUnits|string|null $value): static

Sets the primitiveUnits attribute for the <filter> element.

Creates a new instance with the specified primitive units value for the rendered <filter> element.

Parameters

ParameterTypeDescription
$valueUIAwesome\Html\Svg\Values\CoordinateUnits|string|nullPrimitive units value (for example, ‘objectBoundingBox’ or ‘userSpaceOnUse’).

Returns

static: New instance with the updated primitiveUnits property.

Throws

public function width(int|string|Stringable|UnitEnum|null $value): static

Sets the width attribute.

Usage example:

$element->width(400);
$element->width('50%');
$element->width('auto');
$element->width(null);

Parameters

ParameterTypeDescription
$valueint|string|Stringable|UnitEnum|nullWidth value in pixels or CSS units, or null to remove the attribute.

Returns

static: New instance with the updated width attribute.

public function x(float|int|string|null $value): static

Sets the SVG x attribute for the element.

Creates a new instance with the specified x-coordinate value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullX coordinate value (for example, ‘10’, ‘10.3’, ‘50%’, or null to unset).

Returns

static: New instance with the updated x attribute.

public function y(float|int|string|null $value): static

Sets the SVG y attribute for the element.

Creates a new instance with the specified y-coordinate value for the rendered element.

Parameters

ParameterTypeDescription
$valuefloat|int|string|nullY coordinate value (for example, ‘20’, ‘10.3’, ‘50%’, or null to unset).

Returns

static: New instance with the updated y attribute.

protected function getTag(): BackedEnum

Returns the tag enumeration for the <filter> element.

Returns

BackedEnum: Tag enumeration instance for <filter>. SvgBlock for valid SVG block-level tags.