Merge pull request #3662 from avenirer/patch-8
[ci skip] HTML helper docs: additional info on heading()
diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index d35be39..8861101 100644
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -29,7 +29,7 @@
:param string $data: Content
:param string $h: Heading level
- :param array $attributes: HTML attributes
+ :param mixed $attributes: HTML attributes
:returns: HTML heading tag
:rtype: string
@@ -41,15 +41,18 @@
The above would produce: <h3>Welcome!</h3>
Additionally, in order to add attributes to the heading tag such as HTML
- classes, ids or inline styles, a third parameter is available::
+ classes, ids or inline styles, a third parameter accepts either a string
+ or an array::
- echo heading('Welcome!', 3, 'class="pink"')
+ echo heading('Welcome!', 3, 'class="pink"');
+ echo heading('How are you?', 4, array('id' => 'question', 'class' => 'green'));
The above code produces:
.. code-block:: html
<h3 class="pink">Welcome!<h3>
+ <h4 id="question" class="green">How are you?</h4>
.. php:function:: img([$src = ''[, $index_page = FALSE[, $attributes = '']]])
@@ -401,4 +404,4 @@
.. note:: This function is DEPRECATED. Use the native ``str_repeat()``
- in combination with `` `` instead.
\ No newline at end of file
+ in combination with `` `` instead.