Skip to content
PHP Ecosystem
Explore

Iframe

API reference › HTML › Embedded › Iframe

Renders the HTML <iframe> element for embedding a nested browsing context.

See also: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe (BaseBlock for the base 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
allow()Sets the allow attribute.Iframe
allowfullscreen()Sets the allowfullscreen attribute.Iframe
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
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.Iframe
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
loading()Sets the loading attribute.Iframe
name()Sets the name attribute.Iframe
referrerpolicy()Sets the referrerpolicy attribute.Iframe
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
sandbox()Sets the sandbox attribute.Iframe
spellcheck()Sets the spellcheck attribute.UIAwesome\Html\Attribute\Global\HasSpellcheck
src()Sets the src attribute.Iframe
srcdoc()Sets the srcdoc attribute.Iframe
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.Iframe
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 <iframe> element.Iframe
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 allow(string|Stringable|UnitEnum|null $value): static

Sets the allow attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullPermissions Policy applied to the embedded content, or null to remove the attribute.

Returns

static: New instance with the updated allow attribute.

public function allowfullscreen(bool $value): static

Sets the allowfullscreen attribute.

Parameters

ParameterTypeDescription
$valueboolWhether the embedded content can activate fullscreen mode.

Returns

static: New instance with the updated allowfullscreen attribute.

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

Sets the height attribute.

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 loading(string|Stringable|UnitEnum|null $value): static

Sets the loading attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullLoading strategy (‘eager’ or ‘lazy’), or null to remove the attribute.

Returns

static: New instance with the updated loading attribute. Loading for predefined enum values.

Throws

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

Sets the name attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullTargetable name for the embedded browsing context, or null to remove the attribute.

Returns

static: New instance with the updated name attribute.

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

Sets the referrerpolicy attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullReferrer policy token, or null to remove the attribute.

Returns

static: New instance with the updated referrerpolicy attribute. Referrerpolicy for predefined enum values.

Throws

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

Sets the sandbox attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullSpace-separated restriction tokens, an empty string to apply all restrictions, or null to remove the attribute.

Returns

static: New instance with the updated sandbox attribute.

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

Sets the src attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullURL of the page to embed, or null to remove the attribute.

Returns

static: New instance with the updated src attribute.

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

Sets the srcdoc attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullInline HTML to embed in place of the src attribute, or null to remove the attribute.

Returns

static: New instance with the updated srcdoc attribute.

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

Sets the width attribute.

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.

protected function getTag(): UIAwesome\Html\Interop\Block

Returns the tag enumeration for the <iframe> element.

Returns

Block: Tag enumeration instance for <iframe>. Block for valid block-level tags.