.. _fsnippetbywordcount:

#####################
snippet_by_word_count
#####################

:doc:`Text-related functions </Reference/packages/Function/Text/index>`

*******
Summary
*******

.. include:: /Reference/libraries/globals/summary/snippet_by_word_count.rst

.. php:function:: snippet_by_word_count(string $text, integer $maxWords = 20, string $ellipsis = ...)

    Return a substring of the text by limiting the word count.
    
    Note: it strips the HTML tags from the text before getting the snippet
    
    :param string $text: 
    :param integer $maxWords: 
    :param string $ellipsis: 
    :returns: string

*****
Usage
*****

.. include:: /Reference/libraries/globals/usage/snippet_by_word_count.rst

********
Examples
********

.. include:: /Reference/libraries/globals/examples/snippet_by_word_count.rst

********
See Also
********

.. include:: /Reference/libraries/globals/see_also/snippet_by_word_count.rst