ACF Table Field Pro Add-on Docs

Select plugin version:

Please note and understand

This page content is a preview/draft of an upcoming plugin version and is not yet applicable to the latest public plugin version. The content of this page may change or not be implemented.

ACFTablefield Class

This class allows reading, rendering and modifying a table as well as updating a table field.

Get ACFTablefield class instance

$tablefield = new ACFTablefield();

Field data

Set field data

$tablefield->set_field_data( $tablefield_data );

Get field

$tablefield->get_field( $selector, [$post_id = false] );

Get sub field

$tablefield->get_sub_field( $selector );

Cell content

Get cell content

$cell_content_string = $tablefield->get_cell_content( $column_index, $row_index, $table_section );

Cell walker

$tablefield->cell_walker( function( $param ) { 
 
	// $param['cell_content'] 
	// $param['section'] 
	// $param['row_index'] 
	// $param['cell_index'] 
	// $param['cell_options'] 
	// $param['row_options'] 
	// $param['column_options'] 
	// $param['table_options'] 
 
	return $param; 
} );

Update cell content

$tablefield->update_cell_content( $cell_content_string, $column_index, $row_index, $table_section );

Move

Move a column

$tablefield->move_column( $column_index, $target_index );

Move a row

$tablefield->move_row( $row_index, $target_index );

Add

Add a column

$tablefield->add_column( $column_index );

Add a row

$tablefield->add_row( $row_index );

Append

Append a column

$column_index = $tablefield->append_column();

Append a row

$row_index = $tablefield->append_row();

Remove

Remove a column

$tablefield->remove_column( $column_index );

Remove a row

$tablefield->remove_row( $row_index, $table_section );

Options

Table

Get table option

$all_table_options = 	$tablefield->get_table_option(); 
$content_type = 		$tablefield->get_table_option( 'content_type' ); 
$wp_editor_toolbar = 	$tablefield->get_table_option( 'wp_editor_toolbar' ); 
$use_header = 			$tablefield->get_table_option( 'use_header' ); 
$use_footer = 			$tablefield->get_table_option( 'use_footer' ); 
$use_stub_column = 		$tablefield->get_table_option( 'use_stub_column' ); 
$styles = 				$tablefield->get_table_option( 'styles' );

Update table option

$tablefield->update_table_option( $option_name, $option_value );

Column

Get column option

$all_column_options = $tablefield->get_column_option( '', $column_index ); 
$column_option = $tablefield->get_column_option( $option_name, $column_index );

Update column option

$tablefield->update_column_option( $option_name, $option_value, $column_index );

Body row

Get body row option

$all_body_row_options = $tablefield->get_body_row_option( '', $row_index ); 
$body_row_option = $tablefield->get_body_row_option( $option_name, $row_index );

Update body row option

$tablefield->update_body_row_option( $option_name, $option_value, $row_index );

Body cell

Get body cell option

$all_body_cell_options = $tablefield->get_body_cell_option( '', $row_index, $column_index ); 
$body_cell_option = $tablefield->get_body_cell_option( $option_name, $row_index, $column_index );

Update body cell option

$tablefield->update_body_cell_option( $option_name, $option_value, $row_index, $column_index );

Header row

Get header row option

$all_header_row_options = $tablefield->get_header_row_option(); 
$header_row_option = $tablefield->get_header_row_option( $option_name );

Update header row option

$tablefield->update_header_row_option( $option_name, $option_value );

Header cell

Get header cell option

$all_header_cell_options = $tablefield->get_header_cell_option( '', $cell_index ); 
$header_cell_option = $tablefield->get_header_cell_option( $option_name, $cell_index );

Update header cell option

$tablefield->update_header_cell_option( $option_name, $value, $cell_index );

Field metas

Get field meta

$all_field_metas =		$tablefield->get_field_meta(); 
$table_caption = 		$tablefield->get_field_meta( 'table_caption' ); 
$number_of_columns = 	$tablefield->get_field_meta( 'columns' ); 
$number_of_rows = 		$tablefield->get_field_meta( 'rows' ); 
$field_key = 			$tablefield->get_field_meta( 'field_key' ); 
$field_name = 			$tablefield->get_field_meta( 'field_name' ); 
$plugin_version = 		$tablefield->get_field_meta( 'plugin_version' );

Field settings

Get field setting

$all_field_seetings = $tablefield->get_field_setting(); 
 
// table 
$default_table = 					$tablefield->get_field_setting( 'default_table' ); // returns raw field data 
$min_columns = 						$tablefield->get_field_setting( 'min_columns' ); 
$max_columns = 						$tablefield->get_field_setting( 'max_columns' ); 
$min_rows = 						$tablefield->get_field_setting( 'min_rows' ); 
$max_rows = 						$tablefield->get_field_setting( 'max_rows' ); 
$move = 							$tablefield->get_field_setting( 'move' ); 
$move_columns = 					$tablefield->get_field_setting( 'move_columns' ); 
$move_rows = 						$tablefield->get_field_setting( 'move_rows' ); 
$body_content_type = 				$tablefield->get_field_setting( 'body_content_type' ); 
$body_content_type_editor = 		$tablefield->get_field_setting( 'body_content_type_editor' ); 
$stub_column = 						$tablefield->get_field_setting( 'stub_column' ); 
$table_header = 					$tablefield->get_field_setting( 'table_header' ); 
$table_footer = 					$tablefield->get_field_setting( 'table_footer' ); 
$table_styles = 					$tablefield->get_field_setting( 'table_styles' ); 
 
// columns 
$column_size = 						$tablefield->get_field_setting( 'column_size' ); 
$column_content_type = 				$tablefield->get_field_setting( 'column_content_type' ); 
$column_content_type_editor =		$tablefield->get_field_setting( 'column_content_type_editor' ); 
$column_styles = 					$tablefield->get_field_setting( 'column_styles' ); 
 
// body 
$body_row_content_type = 			$tablefield->get_field_setting( 'body_row_content_type' ); 
$body_row_content_type_editor =		$tablefield->get_field_setting( 'body_row_content_type_editor' ); 
$body_cell_span = 					$tablefield->get_field_setting( 'body_cell_span' ); 
$body_cell_span_column = 			$tablefield->get_field_setting( 'body_cell_span_column' ); 
$body_cell_span_row = 				$tablefield->get_field_setting( 'body_cell_span_row' ); 
$body_cell_content_type = 			$tablefield->get_field_setting( 'body_cell_content_type' ); 
$body_cell_content_type_editor =	$tablefield->get_field_setting( 'body_cell_content_type_editor' ); 
$body_row_styles = 					$tablefield->get_field_setting( 'body_row_styles' ); 
$body_cell_styles = 				$tablefield->get_field_setting( 'body_cell_styles' ); 
 
// header 
$header_row_content_type = 			$tablefield->get_field_setting( 'header_row_content_type' ); 
$header_row_content_type_editor = 	$tablefield->get_field_setting( 'header_row_content_type_editor' ); 
$header_cell_span = 				$tablefield->get_field_setting( 'header_cell_span' ); 
$header_cell_span_column = 			$tablefield->get_field_setting( 'header_cell_span_column' ); 
$header_cell_content_type = 		$tablefield->get_field_setting( 'header_cell_content_type' ); 
$header_cell_content_type_editor = 	$tablefield->get_field_setting( 'header_cell_content_type_editor' ); 
$header_row_styles = 				$tablefield->get_field_setting( 'header_row_styles' ); 
$header_cell_styles = 				$tablefield->get_field_setting( 'header_cell_styles' ); 
 
// footer 
$footer_row_content_type = 			$tablefield->get_field_setting( 'footer_row_content_type' ); 
$footer_row_content_type_editor = 	$tablefield->get_field_setting( 'footer_row_content_type_editor' ); 
$footer_cell_span = 				$tablefield->get_field_setting( 'footer_cell_span' ); 
$footer_cell_span_column = 			$tablefield->get_field_setting( 'footer_cell_span_column' ); 
$footer_cell_content_type = 		$tablefield->get_field_setting( 'footer_cell_content_type' ); 
$footer_cell_content_type_editor = 	$tablefield->get_field_setting( 'footer_cell_content_type_editor' ); 
$footer_row_styles = 				$tablefield->get_field_setting( 'footer_row_styles' ); 
$footer_cell_styles = 				$tablefield->get_field_setting( 'footer_cell_styles' );

Update

Update field

$tablefield->update_field();

Previous and Next Sources

Parent sources