Repeater row count and row index function.

php/blocks/class-field.php

@@ -194,6 +194,17 @@ public function cast_value( $value ) {
 	 * @return string $value The value to echo.
 	 */
 	public function cast_value_to_string( $value ) {
+		/**
+		 * Filters the value of a field when being output as a string.
+		 *
+		 * The result of this filter should be a string. Even if it isn't, it will be run
+		 * through strval() anyway.
+		 *
+		 * @param mixed $value  The value to cast as a string.
+		 * @param Field $field  This field.
+		 */
+		$value = apply_filters( 'block_lab_cast_field_value_to_string', $value, $this );
+
 		if ( is_array( $value ) ) {
 			return implode( ', ', $value );
 		}

php/blocks/class-loader.php

@@ -308,7 +308,10 @@ public function render_block_template( $block, $attributes ) {
 			foreach ( $block->fields as $field ) {
 				if ( isset( $field->settings['sub_fields'] ) ) {
 					$sub_field_settings = $field->settings['sub_fields'];
-					$rows               = $attributes[ $field->name ]['rows'];
+				}
+
+				if ( isset( $attributes[ $field->name ]['rows'] ) ) {
+					$rows = $attributes[ $field->name ]['rows'];
 
 					// In each row, apply a field's default value if a value doesn't exist in the attributes.
 					foreach ( $rows as $row_index => $row ) {
@@ -463,6 +466,10 @@ public function block_template( $name, $type = 'block' ) {
 			if ( ! current_user_can( 'edit_posts' ) || ! isset( $templates[0] ) ) {
 				return;
 			}
+			// Hide the template not found notice on the frontend, unless WP_DEBUG is enabled.
+			if ( ! is_admin() && ! ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ) {
+				return;
+			}
 			printf(
 				'<div class="notice notice-warning">%s</div>',
 				wp_kses_post(

php/blocks/controls/class-repeater.php

@@ -24,19 +24,28 @@ class Repeater extends Control_Abstract {
 	/**
 	 * Field variable type.
 	 *
-	 * The Repeater control is an array of objects, with each row being an object.
-	 * For example, a repeater with one row might be [ { 'example-text': 'Foo', 'example-image': 4232 } ].
+	 * The Repeater control is an array of arrays, with each row being its own array.
+	 * For example, a repeater with two rows might be:
+	 * [ 'rows': [ 0: [ 'example-text': 'Foo', 'example-image': 42 ], 1: [ 'example-text': 'Bar', 'example-image': 32 ] ] ].
 	 *
 	 * @var string
 	 */
-	public $type = 'object';
+	public $type = 'array';
 
 	/**
 	 * Repeater constructor.
 	 */
 	public function __construct() {
 		parent::__construct();
 		$this->label = __( 'Repeater', 'block-lab' );
+		$this->register_hooks();
+	}
+
+	/**
+	 * Register all the hooks.
+	 */
+	public function register_hooks() {
+		add_filter( 'block_lab_cast_field_value_to_string', array( $this, 'cast_as_string' ), 10, 2 );
 	}
 
 	/**
@@ -63,4 +72,46 @@ public function register_settings() {
 			)
 		);
 	}
+
+	/**
+	 * Remove empty placeholder rows.
+	 *
+	 * @param mixed $value The value to either make available as a variable or echoed on the front-end template.
+	 * @param bool  $echo Whether this will be echoed.
+	 * @return mixed $value The value to be made available or echoed on the front-end template.
+	 */
+	public function validate( $value, $echo ) {
+		unset( $echo );
+
+		if ( isset( $value['rows'] ) ) {
+			foreach ( $value['rows'] as $key => $row ) {
+				unset( $value['rows'][ $key ][''] );
+				unset( $value['rows'][ $key ][0] );
+			}
+		}
+
+		return $value;
+	}
+
+	/**
+	 * Show a warning if someone tries to use block_field() with a repeater.
+	 *
+	 * @param mixed $value  The value to cast as a string.
+	 * @param Field $field  The field that is being cast.
+	 * @return string
+	 */
+	public function cast_as_string( $value, $field ) {
+		if ( 'repeater' === $field->control ) {
+			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
+				return sprintf(
+					// translators: Placeholders are the opening and closing anchor tags of a link.
+					__( '⚠️ Please use Block Lab\'s %1$srepeater functions%2$s to display repeater fields in your template.', 'block-lab' ),
+					'<a href="https://getblocklab.com/docs/fields/repeater/">',
+					'</a>'
+				);
+			}
+		}
+
+		return $value;
+	}
 }

php/helpers.php

@@ -165,6 +165,43 @@ function reset_block_rows( $name ) {
 	block_lab()->loop()->reset( $name );
 }
 
+/**
+ * Return the total amount of rows in a repeater.
+ *
+ * @param string $name The name of the repeater field.
+ * @return int|bool The total amount of rows. False if the repeater isn't found.
+ */
+function block_row_count( $name ) {
+	global $block_lab_attributes;
+
+	if ( ! isset( $block_lab_attributes[ $name ]['rows'] ) ) {
+		return false;
+	}
+
+	return count( $block_lab_attributes[ $name ]['rows'] );
+}
+
+/**
+ * Return the index of the current repeater row.
+ *
+ * Note: The index is zero-based, which means that the first row in a repeater has
+ * an index of 0, the second row has an index of 1, and so on.
+ *
+ * @param string $name (Optional) The name of the repeater field.
+ * @return int|bool The index of the row. False if the repeater isn't found.
+ */
+function block_row_index( $name = '' ) {
+	if ( '' === $name ) {
+		$name = block_lab()->loop()->active;
+	}
+
+	if ( ! isset( block_lab()->loop()->loops[ $name ] ) ) {
+		return false;
+	}
+
+	return block_lab()->loop()->loops[ $name ];
+}
+
 /**
  * Return the value of a sub-field.
  *

tests/php/unit/blocks/controls/test-class-repeater.php

@@ -46,7 +46,7 @@ public function setUp() {
 	public function test_construct() {
 		$this->assertEquals( 'Repeater', $this->instance->label );
 		$this->assertEquals( 'repeater', $this->instance->name );
-		$this->assertEquals( 'object', $this->instance->type );
+		$this->assertEquals( 'array', $this->instance->type );
 	}
 
 	/**