JDocument/setMetaData
From Joomla! Documentation
< JDocument(Difference between revisions)
m (Missed & in code sample. Changed double-quotes to single-quotes for some strings.) |
m |
||
| Line 1: | Line 1: | ||
| + | Sets the value of a meta data item. | ||
===Syntax=== | ===Syntax=== | ||
void setMetaData( $name, $content, $http-equiv ) | void setMetaData( $name, $content, $http-equiv ) | ||
| Line 11: | Line 12: | ||
|$name | |$name | ||
|string | |string | ||
| − | |Name of meta data item. If $name is 'description' or 'generator' then the effect is the same as calling [[JDocument/setDescription|setDescription]] or [[JDocument/setGenerator|setGenerator]] respectively. | + | |Name of meta data item. If $name is 'description' or 'generator' then the effect is the same as calling [[JDocument/setDescription|setDescription]] or [[JDocument/setGenerator|setGenerator]] respectively. Meta data names are always folded to lowercase. |
| | | | ||
|- | |- | ||
|$content | |$content | ||
|string | |string | ||
| − | |Content of meta data item. | + | |Content of meta data item. If there is already a meta data item with the same value of $name (case independent) then this value will replace it. |
| | | | ||
|- | |- | ||
Latest revision as of 08:53, 18 September 2008
Sets the value of a meta data item.
Contents |
[edit] Syntax
void setMetaData( $name, $content, $http-equiv )
where:
| Argument | Data type | Description | Default |
|---|---|---|---|
| $name | string | Name of meta data item. If $name is 'description' or 'generator' then the effect is the same as calling setDescription or setGenerator respectively. Meta data names are always folded to lowercase. | |
| $content | string | Content of meta data item. If there is already a meta data item with the same value of $name (case independent) then this value will replace it. | |
| $http-equiv | Boolean | True if meta data item is equivalent to an HTTP header field. | false |
[edit] Example 1
$doc =& JFactory::getDocument(); $doc->setMetaData( 'tag-name', 'tag-content' );
Metadata is rendered differently depending on the document type. For HTML documents a meta tag is produced in the <head> section of the document, so the above example will produce:
<meta name="tag-name" content="tag-content" />[edit] Example 2
$doc =& JFactory::getDocument(); $doc->setMetaData( 'tag-name', 'tag-content', true );
Metadata is rendered differently depending on the document type. For HTML documents a meta tag is produced in the <head> section of the document, so the above example will produce:
<meta http-equiv="tag-name" content="tag-content" />
