Configuration parameter reference

All versions of TablePress support the following basic configuration parameters, both in the “TablePress Table” block in the editor as well as when using the [table id=N /] Shortcode. The supported configuration parameters of the TablePress premium feature modules are shown below.

Module	Slug	Configuration parameter	Name	Description	Type	Default value
Free	basic	`id`	Table ID	The ID of the table to show (can be seen on the “All Tables” or the “Edit” screen).	string	none (required)
Free	basic	`alternating_row_colors`	Alternating Row Colors	Whether the table shall get alternating row background or text colors (“zebra striping”).	boolean (`true` or `false`)	`true`
Free	basic	`row_hover`	Row Hover Highlighting	Whether table rows shall be highlighted with a different background or text color, if the mouse hovers over them.	boolean (`true` or `false`)	`true`
Free	basic	`table_head`	Table Header	How many first rows shall be the table header. This value needs to be greater than 0 if any “Table Features for Site Visitors” shall be used.	integer	`1`
Free	basic	`table_foot`	Table Footer	How many last rows shall be the table footer.	integer	`0`
Free	basic	`first_column_th`	First Column Table Head	Whether the cells in first column shall be marked as headers (HTML `<th>` tag) for their row.	boolean (`true` or `false`)	`false`
Free	basic	`print_name`	Print Table Name	Whether the name of the table shall be printed above or below the table.	boolean (`true` or `false`)	`false`
Free	basic	`print_name_position`	Table Name Position	Position for printing the table name.	enum (`above` or `below`)	`above`
Free	basic	`print_description`	Print Table Description	Whether the description of the table shall be printed above or below the table.	boolean (`true` or `false`)	`false`
Free	basic	`print_description_position`	Table Description Position	Position for printing the table description.	enum (`above` or `below`)	`below`
Free	basic	`extra_css_classes`	Extra CSS Classes		string	`""` (empty string)
Free	basic	`use_datatables`	Enable Table Features for Site Visitors	Whether the “Table Features for Site Visitors” shall be used with this table. This requires that the table has at least one “Table Header” row.	boolean (`true` or `false`)	`true`
Free	basic	`datatables_custom_commands`	Custom Commands		string	`""` (empty string)
Free	basic	`datatables_datetime`	Date and Time Detection Formats		string	`""` (empty string)
Free	basic	`datatables_filter`	Search/Filtering		boolean (`true` or `false`)	`true`
Free	basic	`datatables_info`	Table Info		boolean (`true` or `false`)	`true`
Free	basic	`datatables_lengthchange`	Pagiation Length Change		boolean (`true` or `false`)	`true`
Free	basic	`datatables_locale`	Visitor Features Locale		string	current site locale
Free	basic	`datatables_paginate`	Pagination		boolean (`true` or `false`)	`true`
Free	basic	`datatables_paginate_entries`	Pagination Rows to show		integer	`10`
Free	basic	`datatables_scrollx`	Horizontal Scrolling		boolean (`true` or `false`)	`false`
Free	basic	`datatables_scrolly`	Vertical Scrolling		boolean `false` or string	`false`
Free	basic	`datatables_sort`	Sorting		boolean (`true` or `false`)	`true`
Free	basic	`hide_columns`	Hide Columns	Allows overwriting the column visibility settings. `hide_columns=2,5-8` will hide columns 2, 5, 6, 7, and 8, regardless of their visibility configuration on the “Edit” screen. The parameter `hide_columns=all` will hide all columns at once. `show_columns` takes precedence over `hide_columns`.	string	`""` (empty string)
Free	basic	`hide_rows`	Hide Rows	Allows overwriting the row visibility settings. `hide_rows=2,5-8` will hide rows 2, 5, 6, 7, and 8, regardless of their visibility configuration on the “Edit” screen. The parameter `hide_rows=all` will hide all rows at once. `show_rows` takes precedence over `hide_rows`.	string	`""` (empty string)
Free	basic	`show_columns`	Show Columns	Allows overwriting the column visibility settings. `show_columns=2,5-8` will show columns 2, 5, 6, 7, and 8, regardless of their visibility configuration on the “Edit” screen. The parameter `show_columns=all` will show all columns at once. `show_columns` takes precedence over `hide_columns`.	string	`""` (empty string)
Free	basic	`show_rows`	Show Rows	Allows overwriting the row visibility settings. `show_rows=2,5-8` will show rows 2, 5, 6, 7, and 8, regardless of their visibility configuration on the “Edit” screen. The parameter `show_rows=all` will show all rows at once. `show_rows` takes precedence over `hide_rows`.	string	`""` (empty string)
Free	basic	`cache_table_output`	Cache Table Output	Whether the generated table output HTML code should be cached for one day. This should be turned off for tables that have dynamic content in their cells, like other Shortcodes.	boolean (`true` or `false`)	`true`
Free	basic	`convert_line_breaks`	Convert Line Breaks	Whether line breaks in the content in the table cells should be converted to HTML `<br> tags, which resemble line breaks in HTML code.`	boolean (`true` or `false`)	`true`
Free	basic	`evaluate_formulas`	Evaluate Formulas	Whether formulas in this table should be evaluated before the table is rendered.	boolean (`true` or `false`)	`true`
Free	basic	`shortcode_debug`	Shortcode Debugging	Prints the current render configuration below the table, for debugging purposes.	boolean (`true` or `false`)	`false`
Free	basic	`border`	Border	Deprecated and no longer recommended. Use CSS code instead. This corresponds to the `<table border="0">` attribute that is no longer part of the HTML5 spec.	boolean (`true` or `false`)	`false`
Free	basic	`cellpadding`	Cell Padding	Deprecated and no longer recommended. Use CSS code instead. This corresponds to the `<table cellpadding="0">` attribute that is no longer part of the HTML5 spec.	boolean (`true` or `false`)	`false`
Free	basic	`cellspacing`	Cell Spacing	Deprecated and no longer recommended. Use CSS code instead. This corresponds to the `<table cellspacing="0">` attribute that is no longer part of the HTML5 spec.	boolean (`true` or `false`)	`false`
Free	basic	`column_widths`	Column Widths	Deprecated and no longer recommended. Use CSS code instead. A string with width value (in pixels or as a percentage) for each column, separated by the `\|` (pipe) symbol. Examples: `column_widths=40px\|50px\|30px\|60px` `column_widths=20%\|60%\|20%`	string	`""` (empty string)
Free	basic	`block_preview`	Block Preview	This is an internal setting that should not be used.	boolean (`true` or `false`)	`false`

In addition, the different features modules in the TablePress premium versions support these configuration parameters:

Module	Slug	Configuration parameter	Name	Description	Type	Default value
Advanced Loading	datatables-advanced-loading	`datatables_advanced_loading`			boolean (`true` or `false`)	`false`
Advanced Loading	datatables-advanced-loading	`datatables_advanced_loading_html_rows`			integer	`10`
Advanced Pagination Settings	datatables-pagination	`datatables_pagination_firstlast`			boolean (`true` or `false`)	`false`
Advanced Pagination Settings	datatables-pagination	`datatables_pagination_previousnext`			boolean (`true` or `false`)	`true`
Advanced Pagination Settings	datatables-pagination	`datatables_pagination_numbers`			boolean (`true` or `false`)	`true`
Advanced Pagination Settings	datatables-pagination	`datatables_pagination_input`			boolean (`true` or `false`)	`false`
Advanced Pagination Settings	datatables-pagination	`datatables_pagination_input_pageof`			boolean (`true` or `false`)	`true`
Advanced Pagination Settings	datatables-pagination	`datatables_pagination_buttons`			integer	`7`
Advanced Pagination Settings	datatables-pagination	`datatables_pagination_boundarynumbers`			boolean (`true` or `false`)	`true`
Advanced Pagination Settings	datatables-pagination	`datatables_pagination_scrolltotop`			boolean (`true` or `false`)	`false`
Advanced Pagination Settings	datatables-pagination	`datatables_pagination_scrolltotop_offset`			integer	`10`
Alphabet Search	datatables-alphabetsearch	`datatables_alphabetsearch`			boolean (`true` or `false`)	`false`
Alphabet Search	datatables-alphabetsearch	`datatables_alphabetsearch_column`			string	`1`
Alphabet Search	datatables-alphabetsearch	`datatables_alphabetsearch_alphabet`			enum (`latin` or `greek`)	`latin`
Alphabet Search	datatables-alphabetsearch	`datatables_alphabetsearch_numbers`			boolean (`true` or `false`)	`false`
Alphabet Search	datatables-alphabetsearch	`datatables_alphabetsearch_letters`			boolean (`true` or `false`)	`true`
Alphabet Search	datatables-alphabetsearch	`datatables_alphabetsearch_case_sensitive`			boolean (`true` or `false`)	`false`
Automatic Filter	datatables-auto-filter	`datatables_auto_filter`			string	`""` (empty string)
Automatic Filter	datatables-auto-filter	`datatables_auto_filter_url_parameter`			string	`""` (empty string)
Buttons	datatables-buttons	`datatables_buttons`			string	`""` (empty string)
Cell Highlighting	cell-highlighting	`highlight`	Cell Highlight term	Cells that contain this term will be highlighted. You can combine multiple highlight terms with an OR operator, e.g. `term1\|\|term2` or `term1&&term2`.	string	`""` (empty string)
Cell Highlighting	cell-highlighting	`highlight_full_cell_match`	Full cell matching	If this is `true`, the full cell content has to match the highlight term.	boolean (`true` or `false`)	`false`
Cell Highlighting	cell-highlighting	`highlight_case_sensitive`	Case-sensitive matching	If this is `true`, the case sensitivity of the highlight term has to match the content in the cell.	boolean (`true` or `false`)	`false`
Cell Highlighting	cell-highlighting	`highlight_columns`	Highlight columns	A comma-separated list of the columns which should be searched for the highlight terms, e.g. `1,3-5,7`. By default, all columns will be searched.	string	`""` (empty string) // "" equates to 'all'.
Cell Highlighting	cell-highlighting	`highlight_url_parameter`	Cell Highlight URL parameter	This allows providing the Cell Highlight term in a URL parameter.	string	`""` (empty string)
Column Filter Dropdowns	datatables-columnfilterwidgets	`datatables_columnfilterwidgets`			boolean (`true` or `false`)	`false`
Column Filter Dropdowns	datatables-columnfilterwidgets	`datatables_columnfilterwidgets_columns`			string	`""` (empty string)
Column Filter Dropdowns	datatables-columnfilterwidgets	`datatables_columnfilterwidgets_exclude_columns`			string	`""` (empty string)
Column Filter Dropdowns	datatables-columnfilterwidgets	`datatables_columnfilterwidgets_separator`			string	`""` (empty string)
Column Filter Dropdowns	datatables-columnfilterwidgets	`datatables_columnfilterwidgets_max_selections`			string	`""` (empty string)
Column Filter Dropdowns	datatables-columnfilterwidgets	`datatables_columnfilterwidgets_group_terms`			boolean (`true` or `false`)	`false`
Column Order	column-order	`column_order`			enum (`default`, `reverse`, or `manual`)	`default`
Column Order	column-order	`column_order_manual_order`			string	`""` (empty string)
Custom Search Builder	datatables-searchbuilder	`datatables_searchbuilder`			boolean (`true` or `false`)	`false`
Fixed Columns	datatables-fixedheader-fixedcolumns	`datatables_fixedcolumns`			string	`""` (empty string)
Fixed Columns	datatables-fixedheader-fixedcolumns	`datatables_fixedcolumns_left_columns`			integer	`0`
Fixed Columns	datatables-fixedheader-fixedcolumns	`datatables_fixedcolumns_right_columns`			integer	`0`
Fixed Columns	datatables-fixedheader-fixedcolumns	`datatables_scrollx_buttons`			boolean (`true` or `false`)	`false`
Fixed Rows	datatables-fixedheader-fixedcolumns	`datatables_fixedheader`			string	`""` (empty string)
Fixed Rows	datatables-fixedheader-fixedcolumns	`datatables_fixedheader_offsettop`			integer	`0`
Fuzzy Search	datatables-fuzzysearch	`datatables_fuzzysearch`			boolean (`true` or `false`)	`false`
Fuzzy Search	datatables-fuzzysearch	`datatables_fuzzysearch_threshold`			float	`0.5`
Fuzzy Search	datatables-fuzzysearch	`datatables_fuzzysearch_togglesmart`			boolean (`true` or `false`)	`true`
Fuzzy Search	datatables-fuzzysearch	`datatables_fuzzysearch_rankcolumn`			string	`""` (empty string)
Index Column	datatables-counter-column	`datatables_counter_column`			boolean (`true` or `false`)	`false`
Individual Column Filtering	datatables-column-filter	`datatables_column_filter`			string	`""` (empty string)
Individual Column Filtering	datatables-column-filter	`datatables_column_filter_position`			enum (`table_head` or `table_foot`)	`table_head`
Individual Column Filtering	datatables-column-filter	`datatables_column_filter_columns`			string	`""` (empty string)
Inverted Filtering	datatables-inverted-filter	`datatables_inverted_filter`			boolean (`true` or `false`)	`false`
Responsive Tables	responsive-tables	`responsive`			string	`""` (empty string)
Responsive Tables	responsive-tables	`responsive_breakpoint`			enum (`phone`, `tablet`, `desktop`, or `all`)	`phone`
Responsive Tables	responsive-tables	`responsive_scroll_buttons`			boolean (`true` or `false`)	`false`
Row Filtering	row-filtering	`filter`			string	`""` (empty string)
Row Filtering	row-filtering	`filter_full_cell_match`			boolean (`true` or `false`)	`false`
Row Filtering	row-filtering	`filter_case_sensitive`			boolean (`true` or `false`)	`false`
Row Filtering	row-filtering	`filter_columns`			string	`""` (empty string) // "" equates to 'all'.
Row Filtering	row-filtering	`filter_inverse`			boolean (`true` or `false`)	`false`
Row Filtering	row-filtering	`filter_url_parameter`			string	`""` (empty string)
Row Grouping	datatables-rowgroup	`datatables_rowgroup`			boolean (`true` or `false`)	`false`
Row Grouping	datatables-rowgroup	`datatables_rowgroup_datasrc`			string	`1`
Row Highlighting	row-highlighting	`row_highlight`			string	`""` (empty string)
Row Highlighting	row-highlighting	`row_highlight_full_cell_match`			boolean (`true` or `false`)	`true`
Row Highlighting	row-highlighting	`row_highlight_case_sensitive`			boolean (`true` or `false`)	`false`
Row Highlighting	row-highlighting	`row_highlight_columns`		// "" equates to 'all'.	string	`""` (empty string)
Row Highlighting	row-highlighting	`row_highlight_rows`		// "" equates to 'all'.	string	`""` (empty string)
Row Highlighting	row-highlighting	`row_highlight_url_parameter`			string	`""` (empty string)
Row Order	row-order	`row_order`			enum (`default`, `reverse`, `sort`, or `manual`)	`default`
Row Order	row-order	`row_order_sort_column`			string	`""` (empty string)
Row Order	row-order	`row_order_sort_direction`			enum (`asc` or `desc`)	`asc`
Row Order	row-order	`row_order_manual_order`			string	`""` (empty string)
Search Highlighting	datatables-searchhighlight	`datatables_searchhighlight`			boolean (`true` or `false`)	`false`
Search Panes	datatables-searchpanes	`datatables_searchpanes`			boolean (`true` or `false`)	`false`
Search Panes	datatables-searchpanes	`datatables_searchpanes_columns`			string	`""` (empty string)
Server-side Processing	datatables-serverside-processing	`datatables_serverside_processing`			boolean (`true` or `false`)	`false`
Server-side Processing	datatables-serverside-processing	`datatables_serverside_processing_cached_pages`			integer	`0`
Server-side Processing	datatables-serverside-processing	`datatables_serverside_processing_periodic_refresh`			integer	`0`
Server-side Processing	datatables-serverside-processing	`datatables_serverside_processing_request_type`			enum (`GET` or `POST`)	`GET`
Server-side Processing	datatables-serverside-processing	`datatables_serverside_processing_html_rows`		This is only a Shortcode parameter, but not part of the user interface. By default, the value of the `datatables_paginate_entries` value is used.	string	`""` (empty string)
Table Layout	datatables-layout	`datatables_layout`	Table Layout	This parameter allows changing the Table Layout, by returning an object in JSON notation, e.g. as `datatables_layout='{...}'`. However, as Shortcode parameters can not contain `[` or `]` characters that denote arrays in JSON, setting a different layout is only possible if only one control element should be shown per feature position. Due to the JSON requirement, the JSON object string must be wrapped in single quotes `'` for WordPress to properly recognize the parameter. Example: The configuration parameter `datatables_layout='{"top":"search", "topStart":null, "topEnd":null, "bottomStart":"paging", "bottomEnd":null}'` will move the "Search" field to the top center position and only keep the Pagination controls below the table. For more details, see the DataTables documentation.	string	`""` (empty string)

DocumentationConfiguration parameter reference

Documentation
Configuration parameter reference