How can I set the Page Heading via the Joomla API?

Question

I can set meta descriptions and meta keywords as follows:

<?php
  $document = JFactory::getDocument();
  $document->setDescription("a meta description");
  $document->setMetaData('keywords', 'some,keywords');
?>

Is there a similar way to set the page heading? By "page heading" I am referring to the "Page Heading" field in the menu item (see below) which usually (depending on the template you are using) results in a H1 heading at the top of the content.

Answer 1

you can set this variable as so:

$this->params->set('page_heading', "garr, I be a page heading");

Make sure you insert this code before the page_header is loaded, as setting it after it has loaded will mean it loads first, with the existing value, and then you set it after, but you have not told it to update. If you need to set it after, then you would need to call the page_heading again. I suspect loading it before the original call is better in most cases.

To understand where the page_header is loaded, look at the other answer to this question, which shows you how to load the page_header. For example on my blog page it is

echo $this->escape($this->params->get('page_heading'));

Answer 2

Joomla Dynamic page title

$document = JFactory::getDocument();

$document->setTitle('your title');      

Answer 3

This is the standard code that you can find in joomla's core components (like com_content):

<?php if($this->params->get('show_page_heading')){ ?>
    <div class="page-header">
        <h1><?php echo $this->escape($this->params->get('page_heading')); ?></h1>
    </div>
<?php } ?>