Actions

Difference between revisions of "JDocument/setMetaData"

From Joomla! Documentation

(New page: ===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...)
 
m (Added table formatting.)
Line 3: Line 3:
  
 
where:
 
where:
{|
+
{| class="wikitable"
 
!Argument
 
!Argument
 
!Data type
 
!Data type

Revision as of 17:35, 7 September 2008

Contents

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.
$content string Content of meta data item.
$http-equiv Boolean True if meta data item is equivalent to an HTTP header field. false

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" />

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" />

See also