.. _floop:

####
loop
####

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

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

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

.. php:function:: loop(string $recordsVar, array|null $records)

    Return an iterator used for looping an array of records.
    
    :param string $recordsVar: 
    :param array|null $records: 
    :returns: Omeka_Record_Iterator

*****
Usage
*****

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

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

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

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

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