123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354 |
- <?php
- if ( ! defined( 'ABSPATH' ) ) {
- exit; // Exit if accessed directly
- }
- if ( ! class_exists( 'acf_loop' ) ) :
- class acf_loop {
- /*
- * __construct
- *
- * This function will setup the class functionality
- *
- * @type function
- * @date 5/03/2014
- * @since 5.0.0
- *
- * @param n/a
- * @return n/a
- */
- function __construct() {
- // vars
- $this->loops = array();
- }
- /*
- * is_empty
- *
- * This function will return true if no loops exist
- *
- * @type function
- * @date 3/03/2016
- * @since 5.3.2
- *
- * @param n/a
- * @return (boolean)
- */
- function is_empty() {
- return empty( $this->loops );
- }
- /*
- * is_loop
- *
- * This function will return true if a loop exists for the given array index
- *
- * @type function
- * @date 3/03/2016
- * @since 5.3.2
- *
- * @param $i (int)
- * @return (boolean)
- */
- function is_loop( $i = 0 ) {
- return isset( $this->loops[ $i ] );
- }
- /*
- * get_i
- *
- * This function will return a valid array index for the given $i
- *
- * @type function
- * @date 3/03/2016
- * @since 5.3.2
- *
- * @param $i (mixed)
- * @return (int)
- */
- function get_i( $i = 0 ) {
- // 'active'
- if ( $i === 'active' ) {
- $i = -1;
- }
- // 'previous'
- if ( $i === 'previous' ) {
- $i = -2;
- }
- // allow negative to look at end of loops
- if ( $i < 0 ) {
- $i = count( $this->loops ) + $i;
- }
- // return
- return $i;
- }
- /*
- * add_loop
- *
- * This function will add a new loop
- *
- * @type function
- * @date 3/03/2016
- * @since 5.3.2
- *
- * @param $loop (array)
- * @return n/a
- */
- function add_loop( $loop = array() ) {
- // defaults
- $loop = wp_parse_args(
- $loop,
- array(
- 'selector' => '',
- 'name' => '',
- 'value' => false,
- 'field' => false,
- 'i' => -1,
- 'post_id' => 0,
- 'key' => '',
- )
- );
- // ensure array
- $loop['value'] = acf_get_array( $loop['value'] );
- // Re-index values if this loop starts from index 0.
- // This allows ajax previews to work ($_POST data contains random unique array keys)
- if ( $loop['i'] == -1 ) {
- $loop['value'] = array_values( $loop['value'] );
- }
- // append
- $this->loops[] = $loop;
- // return
- return $loop;
- }
- /*
- * update_loop
- *
- * This function will update a loop's setting
- *
- * @type function
- * @date 3/03/2016
- * @since 5.3.2
- *
- * @param $i (mixed)
- * @param $key (string) the loop setting name
- * @param $value (mixed) the loop setting value
- * @return (boolean) true on success
- */
- function update_loop( $i = 'active', $key = null, $value = null ) {
- // i
- $i = $this->get_i( $i );
- // bail early if no set
- if ( ! $this->is_loop( $i ) ) {
- return false;
- }
- // set
- $this->loops[ $i ][ $key ] = $value;
- // return
- return true;
- }
- /*
- * get_loop
- *
- * This function will return a loop, or loop's setting for a given index & key
- *
- * @type function
- * @date 3/03/2016
- * @since 5.3.2
- *
- * @param $i (mixed)
- * @param $key (string) the loop setting name
- * @return (mixed) false on failure
- */
- function get_loop( $i = 'active', $key = null ) {
- // i
- $i = $this->get_i( $i );
- // bail early if no set
- if ( ! $this->is_loop( $i ) ) {
- return false;
- }
- // check for key
- if ( $key !== null ) {
- return $this->loops[ $i ][ $key ];
- }
- // return
- return $this->loops[ $i ];
- }
- /*
- * remove_loop
- *
- * This function will remove a loop
- *
- * @type function
- * @date 3/03/2016
- * @since 5.3.2
- *
- * @param $i (mixed)
- * @return (boolean) true on success
- */
- function remove_loop( $i = 'active' ) {
- // i
- $i = $this->get_i( $i );
- // bail early if no set
- if ( ! $this->is_loop( $i ) ) {
- return false;
- }
- // remove
- unset( $this->loops[ $i ] );
- // reset keys
- $this->loops = array_values( $this->loops );
- // PHP 7.2 no longer resets array keys for empty value
- if ( $this->is_empty() ) {
- $this->loops = array();
- }
- }
- }
- // initialize
- acf()->loop = new acf_loop();
- endif; // class_exists check
- /*
- * acf_add_loop
- *
- * alias of acf()->loop->add_loop()
- *
- * @type function
- * @date 6/10/13
- * @since 5.0.0
- *
- * @param n/a
- * @return n/a
- */
- function acf_add_loop( $loop = array() ) {
- return acf()->loop->add_loop( $loop );
- }
- /*
- * acf_update_loop
- *
- * alias of acf()->loop->update_loop()
- *
- * @type function
- * @date 6/10/13
- * @since 5.0.0
- *
- * @param n/a
- * @return n/a
- */
- function acf_update_loop( $i = 'active', $key = null, $value = null ) {
- return acf()->loop->update_loop( $i, $key, $value );
- }
- /*
- * acf_get_loop
- *
- * alias of acf()->loop->get_loop()
- *
- * @type function
- * @date 6/10/13
- * @since 5.0.0
- *
- * @param n/a
- * @return n/a
- */
- function acf_get_loop( $i = 'active', $key = null ) {
- return acf()->loop->get_loop( $i, $key );
- }
- /*
- * acf_remove_loop
- *
- * alias of acf()->loop->remove_loop()
- *
- * @type function
- * @date 6/10/13
- * @since 5.0.0
- *
- * @param n/a
- * @return n/a
- */
- function acf_remove_loop( $i = 'active' ) {
- return acf()->loop->remove_loop( $i );
- }
|