.. _floop:

##################################################################
``loop`` — Get an iterator for looping over an array of records.
##################################################################

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

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

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

.. php:function:: loop($recordsVar, $records = null)

    Get an iterator for looping over an array of records.
    
    :type $recordsVar: string
    :param $recordsVar: The name of the variable the records are stored in.
    :type $records: array|null
    :param $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