.. _fgetlooprecords:

################
get_loop_records
################

:doc:`Loop-related functions </Reference/packages/Function/View/Body/Loop/index>`

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

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

.. php:function:: get_loop_records(string $recordsVar, $throwException = 1)

    Get records from the view for iteration.
    
    Note that this function will return an empty array if it is set to therecords variable. Use has_loop_records() to check if records exist.
    
    :param string $recordsVar: 
    :param unknown $throwException: 
    :returns: array|bool

*****
Usage
*****

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

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

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

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

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