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.

ModuleSlugConfiguration parameterNameDescriptionTypeDefault value
FreebasicidTable IDThe ID of the table to show (can be seen on the “All Tables” or the “Edit” screen).stringnone (required)
Freebasicalternating_row_colorsAlternating Row ColorsWhether the table shall get alternating row background or text colors (“zebra striping”).boolean (true or false)true
Freebasicrow_hoverRow Hover HighlightingWhether table rows shall be highlighted with a different background or text color, if the mouse hovers over them.boolean (true or false)true
Freebasictable_headTable HeaderHow 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.integer1
Freebasictable_footTable FooterHow many last rows shall be the table footer.integer0
Freebasicfirst_column_thFirst Column Table HeadWhether the cells in first column shall be marked as headers (HTML <th> tag) for their row.boolean (true or false)false
Freebasicprint_namePrint Table NameWhether the name of the table shall be printed above or below the table.boolean (true or false)false
Freebasicprint_name_positionTable Name PositionPosition for printing the table name.enum (above or below)above
Freebasicprint_descriptionPrint Table DescriptionWhether the description of the table shall be printed above or below the table.boolean (true or false)false
Freebasicprint_description_positionTable Description PositionPosition for printing the table description.enum (above or below)below
Freebasicextra_css_classesExtra CSS ClassesAllows adding additional CSS classes to the HTML <table> element, e.g. for styling of groups of tables.string"" (empty string)
Freebasicuse_datatablesEnable Table Features for Site VisitorsWhether 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
Freebasicdatatables_custom_commandsCustom CommandsAdditional parameters from the DataTables documentation that can further influence the Table Features for Site Visitors.

Before this parameter can be used, it needs to be enabled by adding the line add_filter( 'tablepress_disable_custom_commands_shortcode_parameter',
'__return_false' );
to e.g. the theme’s “functions.php” file.

The parameter can hold JavaScript objects, without the wrapping { and } characters.

If the string (which is likely) contains quotation marks ", it must be wrapped/enclosed in single quotes ' for WordPress to properly recognize the parameter.

If the parameter is used inside a Shortcode, all [ and ] characters have to be replaced by their entities &lsqb; and &rsqb;.
string"" (empty string)
Freebasicdatatables_datetimeDate and Time Detection FormatsAllows adding detection for date format other than “MM/DD/YYYY”, based on a date format string.

To turn on the format DD.MM.YYYY, used in many European countries, use the parameter like datatables_datetime=DD.MM.YYYY.
string"" (empty string)
Freebasicdatatables_filterSearch/FilteringWhether the Search/Filtering feature for the table is enabled, and whether the Search field is shown.

This is required for most feature modules that deal with searching or filtering the table.
boolean (true or false)true
Freebasicdatatables_infoTable InfoWhether the “Showing M to N of X entries” text is shown below the table.boolean (true or false)true
Freebasicdatatables_lengthchangePagiation Length ChangeWhether the “N entries per page” dropdown above the table is shown.

This requires the Pagination feature to be active.
boolean (true or false)true
Freebasicdatatables_localeVisitor Features LocaleWhich language file is loaded for the visitor features.

By default, the configured site language is used.

Available files are in the i18n/datatables/ subfolder of the plugin’s folder.

Example: datatables_locale=de_DE
stringcurrent site locale
Freebasicdatatables_paginatePaginationWhether the table pagination feature is enabled.boolean (true or false)true
Freebasicdatatables_paginate_entriesPagination Rows to showAllows configuring how many rows are to be shown on a table “page” when using pagination.integer10
Freebasicdatatables_scrollxHorizontal ScrollingWhether horizontal scrolling is enabled for the table, to make the table responsive on smaller screens.boolean (true or false)false
Freebasicdatatables_scrollyVertical ScrollingWhether vertical scrolling is enabled for the table, inside a container.

To turn this feature on, a height for the table container has to be configured, e.g. via datatables_scrolly=400px.
boolean false or stringfalse
Freebasicdatatables_sortSortingWhether the sorting/order feature is activated for the table.boolean (true or false)true
Freebasichide_columnsHide ColumnsAllows 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)
Freebasichide_rowsHide RowsAllows 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)
Freebasicshow_columnsShow ColumnsAllows 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)
Freebasicshow_rowsShow RowsAllows 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)
Freebasiccache_table_outputCache Table OutputWhether 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
Freebasicconvert_line_breaksConvert Line BreaksWhether 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
Freebasicevaluate_formulasEvaluate FormulasWhether formulas in this table should be evaluated before the table is rendered.boolean (true or false)true
Freebasicshortcode_debugShortcode DebuggingPrints the current render configuration below the table, for debugging purposes.boolean (true or false)false
FreebasicborderBorderDeprecated 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
FreebasiccellpaddingCell PaddingDeprecated 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
FreebasiccellspacingCell SpacingDeprecated 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
Freebasiccolumn_widthsColumn WidthsDeprecated 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)
Freebasicblock_previewBlock PreviewThis 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:

ModuleSlugConfiguration parameterNameDescriptionTypeDefault value
Advanced Loadingdatatables-advanced-loadingdatatables_advanced_loadingAdvanced LoadingLoads the table data from a JavaScript array instead of from HTML code, when rendering it on the frontend.

This improves loading speed for bigger tables.
boolean (true or false)false
Advanced Loadingdatatables-advanced-loadingdatatables_advanced_loading_html_rowsAdvanced Loading HTML RowsThe number of rows that should be added as HTML code, in addition to the JavaScript array.

This serves as a fallback if JavaScript is disabled.
integer10
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_firstlastPagination First/Last ButtonsTurns on “First” and “Last” buttons (« and »).boolean (true or false)false
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_previousnextPagination Previous/Next ButtonsTurns on “Previous” and “Next” buttons (‹ and ›).boolean (true or false)true
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_numbersPagination Page NumbersTurns on Page Number buttons.boolean (true or false)true
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_inputPagination Page Input FieldAdds an input field to jump to a specific page.boolean (true or false)false
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_input_pageofPagination "page of" textAdds a “page of” text “/N” after the input.boolean (true or false)true
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_buttonsPagination number of buttonsThe number of buttons to show in the pagination.integer7
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_boundarynumbersPagination boundary buttonsWhether to always show the first and last number buttons.boolean (true or false)true
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_loadmore_buttonPagination "Show More" buttonWhether to show a "Show More" button that loads more rows instead of classical pagination.boolean (true or false)false
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_scrolltotopPagination Scroll to TopWhether to scroll to the top of the table when the visitor goes to a different table page.boolean (true or false)false
Advanced Pagination Settingsdatatables-paginationdatatables_pagination_scrolltotop_offsetPagination Scroll to Top offsetThe offset in pixels that defines the scroll position.integer10
Alphabet Searchdatatables-alphabetsearchdatatables_alphabetsearchAlphabet SearchWhether to show an alphabet for filtering the table by a chosen column’s first character.boolean (true or false)false
Alphabet Searchdatatables-alphabetsearchdatatables_alphabetsearch_columnAlphabet Search ColumnColumn for which an alphabet for searching should be shown.string1
Alphabet Searchdatatables-alphabetsearchdatatables_alphabetsearch_alphabetAlphabet Search AlphabetWhich alphabet to use (Latin alphabet (A-Z) or Greek alphabet (Α-Ω))enum (latin or greek)latin
Alphabet Searchdatatables-alphabetsearchdatatables_alphabetsearch_numbersAlphabet Search NumbersWhether to show numbers in the alphabet.boolean (true or false)false
Alphabet Searchdatatables-alphabetsearchdatatables_alphabetsearch_lettersAlphabet Search LettersWhether to show letters/characters in the alphabet.boolean (true or false)true
Alphabet Searchdatatables-alphabetsearchdatatables_alphabetsearch_case_sensitiveAlphabet Search Case-sensitivityWhether to treat upper and lower case letters separately.boolean (true or false)false
Automatic Filterdatatables-auto-filterdatatables_auto_filterAutomatic Filtering Search TermThe table will be automatically filtered for this search term.string"" (empty string)
Automatic Filterdatatables-auto-filterdatatables_auto_filter_url_parameterAutomatic FilteringInstead of, or in addition to, using a pre-defined search term, a URL parameter like “table_filter” can be used.string"" (empty string)
Buttonsdatatables-buttonsdatatables_buttonsButtons configurationConfiguration object of the User Action Buttonsstring"" (empty string)
Cell Highlightingcell-highlightinghighlightCell Highlight termCells 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 Highlightingcell-highlightinghighlight_case_sensitiveCase-sensitive matchingIf this is true, the case sensitivity of the highlight term has to match the content in the cell.boolean (true or false)false
Cell Highlightingcell-highlightinghighlight_columnsHighlight columnsA 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 Highlightingcell-highlightinghighlight_expressionCell Highlight expressionA logic expression for complex Cell Highlighting.string"" (empty string)
Cell Highlightingcell-highlightinghighlight_full_cell_matchFull cell matchingIf this is true, the full cell content has to match the highlight term.boolean (true or false)false
Cell Highlightingcell-highlightinghighlight_url_parameterCell Highlight URL parameterThis allows providing the Cell Highlight term in a URL parameter.string"" (empty string)
Column Filter Dropdownsdatatables-columnfilterwidgetsdatatables_columnfilterwidgetsColumn Filter DropdownsWhether to add Column Filter Dropdowns.boolean (true or false)false
Column Filter Dropdownsdatatables-columnfilterwidgetsdatatables_columnfilterwidgets_columnsColumn Filter Dropdowns ColumnsColumns for which Column Filter Dropdowns should be shown.string"" (empty string)
Column Filter Dropdownsdatatables-columnfilterwidgetsdatatables_columnfilterwidgets_exclude_columnsColumn Filter Dropdowns Exclude ColumnsColumns which should be excluded from getting Column Filter Dropdowns.

This setting is deprecated. Use datatables_columnfilterwidgets_columns instead.
string"" (empty string)
Column Filter Dropdownsdatatables-columnfilterwidgetsdatatables_columnfilterwidgets_separatorColumn Filter Dropdowns Filter Term SeparatorString separator, e.g. ", " that is used to split cell content to get individual filter terms.string"" (empty string)
Column Filter Dropdownsdatatables-columnfilterwidgetsdatatables_columnfilterwidgets_max_selectionsColumn Filter Dropdowns Maximum selectionsThe maximum number of allowed selections from each filter dropdown.

Setting this to 1 will turn the dropdowns into classical select fields, that directly show the selection in the dropdown, instead of below it.
string"" (empty string)
Column Filter Dropdownsdatatables-columnfilterwidgetsdatatables_columnfilterwidgets_group_termsColumn Filter Dropdowns Filter Terms GroupingWhether to list the selected filter terms in one common section instead of underneath each dropdown.boolean (true or false)false
Column Ordercolumn-ordercolumn_orderColumn OrderDesired column order for a pre-ordering.

Possible values are Default, Random, Reverse, and Custom.
enum (default, random, reverse, or manual)default
Column Ordercolumn-ordercolumn_order_manual_orderColumn Order Custom OrderList of columns in the desired order, if "custom" is configured for the Column Order.string"" (empty string)
Custom Search Builderdatatables-searchbuilderdatatables_searchbuilderCustom Search BuilderWhether to show a search builder interface for filtering from groups and using conditions.boolean (true or false)false
Fixed Columnsdatatables-fixedheader-fixedcolumnsdatatables_fixedcolumnsFixed ColumnsWhich columns to fix to the left/right edge of the screen (left or right or left,right) when scrolling horizontally.

Using the datatables_fixedcolumns_left_columns and datatables_fixedcolumns_right_columns settings is recommended over this one.
string"" (empty string)
Fixed Columnsdatatables-fixedheader-fixedcolumnsdatatables_fixedcolumns_left_columnsFixed Columns Number of Left columnsNumber of columns to fix from the left.integer0
Fixed Columnsdatatables-fixedheader-fixedcolumnsdatatables_fixedcolumns_right_columnsFixed Columns Number of Right columnsNumber of columns to fix from the right.integer0
Fixed Columnsdatatables-fixedheader-fixedcolumnsdatatables_scrollx_buttonsHorizontal Scroll ButtonsWhether to show left/right buttons for the horizontal scrolling.boolean (true or false)false
Fixed Rowsdatatables-fixedheader-fixedcolumnsdatatables_fixedheaderFixed HeaderWhat to fix to the top/bottom edge of the screen (top or bottom or top,bottom) when scrolling vertically.string"" (empty string)
Fixed Rowsdatatables-fixedheader-fixedcolumnsdatatables_fixedheader_offsettopFixed Header OffsetOffset in pixels at which the fixed header is sticky, from the top edge.

This is useful when a site already has a fixed main site navigation, so that the table header row sticks below that.
integer0
Fuzzy Searchdatatables-fuzzysearchdatatables_fuzzysearchFuzzy SearchWhether to activate fuzzy search for the table.boolean (true or false)false
Fuzzy Searchdatatables-fuzzysearchdatatables_fuzzysearch_thresholdFuzzy Search ThresholdSimilarity score that needs to be reached.

The threshold, a number between 0 and 1, defines the similarity that is required for a row to be found.
float0.5
Fuzzy Searchdatatables-fuzzysearchdatatables_fuzzysearch_togglesmartFuzzy Search Toggle controlWhether to allow the visitor to switch between exact and fuzzy search.boolean (true or false)true
Fuzzy Searchdatatables-fuzzysearchdatatables_fuzzysearch_rankcolumnFuzzy Search Rank ColumnThe column number for a rank column that should show the search’s similarity score.string"" (empty string)
Index Columndatatables-counter-columndatatables_counter_columnIndex Column or Counter ColumnWhether to make the first column a counter or index column indicating a rank of the rows after searching and ordering.boolean (true or false)false
Individual Column Filteringdatatables-column-filterdatatables_column_filterIndividual Column Filtering Form ElementThe desired form element for the individual column filters: Empty string for none, or input for text fields, or select for dropdowns.enum ("" (empty string), input, or select)"" (empty string)
Individual Column Filteringdatatables-column-filterdatatables_column_filter_positionIndividual Column Filtering PositionThe desired position for the individual column filters: table_head for the Table Header or table_foot for the Table Footerenum (table_head or table_foot)table_head
Individual Column Filteringdatatables-column-filterdatatables_column_filter_columnsIndividual Column Filtering ColumnsColumns for which an individual column filtering control should be added.string"" (empty string)
Inverted Filteringdatatables-inverted-filterdatatables_inverted_filterInverted FilteringWhether to turn the filtering into a search and hide the table if no search term is entered.boolean (true or false)false
Responsive Tablesresponsive-tablesresponsiveMode for ResponsivenessThe desired behavior of the table on small screens.enum ("" (empty string), scroll, collapsemodal, stack, or flip)"" (empty string)
Responsive Tablesresponsive-tablesresponsive_breakpointBreakpoint for the Mode of ResponsivenessThe largest screen size (breakpoint) for which the Flip or Stack mode should be used.enum (phone, tablet, desktop, or all)phone
Responsive Tablesresponsive-tablesresponsive_scroll_buttonsHorizontal Scroll ButtonsWhether to show left/right buttons for the horizontal scrolling.boolean (true or false)false
Row Filteringrow-filteringfilterRow Filtering TermThe table will show only rows that contain this filter term. You can combine multiple filter terms with an AND or OR operator, e.g. “term1&&term2” or “term1||term2”.string"" (empty string)
Row Filteringrow-filteringfilter_case_sensitiveRow Filtering Case-sensitive matchingWhether the case sensitivity of the filter term has to match the content in the cell.boolean (true or false)false
Row Filteringrow-filteringfilter_columnsRow Filtering Filter columnsThe columns which should be searched for the filter terms.string"" (empty string) // “” equates to ‘all’.
Row Filteringrow-filteringfilter_expressionRow Filtering ExpressionA logic expression for complex Row Filtering.string"" (empty string)
Row Filteringrow-filteringfilter_full_cell_matchRow Filtering Full cell matchingWhether the full cell content has to match the filter term.boolean (true or false)false
Row Filteringrow-filteringfilter_inverseRow Filtering Invert filtering resultWhether rows with the filter term will be hidden and rows without the filter term will be shown.boolean (true or false)false
Row Filteringrow-filteringfilter_url_parameterRow Filtering URL parameterInstead of, or in addition to, using a pre-defined filter term, a URL parameter like “table_filter” can be used.string"" (empty string)
Row Groupingdatatables-rowgroupdatatables_rowgroupRow GroupingWhether to group rows that belong to the same category.boolean (true or false)false
Row Groupingdatatables-rowgroupdatatables_rowgroup_datasrcRow Grouping Data sourceColumns that are used as group categories.string1
Row Highlightingrow-highlightingrow_highlightRow Highlight termRows 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)
Row Highlightingrow-highlightingrow_highlight_case_sensitiveCase-sensitive matchingIf this is true, the case sensitivity of the highlight term has to match the content in the cell.boolean (true or false)false
Row Highlightingrow-highlightingrow_highlight_columnsHighlight columnsA 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)
Row Highlightingrow-highlightingrow_highlight_expressionRow Highlight expressionA logic expression for complex Row Highlighting.string"" (empty string)
Row Highlightingrow-highlightingrow_highlight_full_cell_matchFull cell matchingIf this is true, the full cell content has to match the highlight term.boolean (true or false)true
Row Highlightingrow-highlightingrow_highlight_rowsHighlight rowsA comma-separated list of the rows which should be searched for the highlight terms, e.g. 1,3-5,7. By default, all rows will be searched.string"" (empty string)
Row Highlightingrow-highlightingrow_highlight_url_parameterRow Highlight URL parameterThis allows providing the Row Highlight term in a URL parameter.string"" (empty string)
Row Orderrow-orderrow_orderRow OrderDesired row order for a pre-ordering.

Possible values are Default, Random, Reverse, Sort, and Custom.
enum (default, random,reverse, sort, or manual)default
Row Orderrow-orderrow_order_manual_orderRow Order Custom OrderList of columns in the desired order, if “custom” is configured for the Row Order.string"" (empty string)
Row Orderrow-orderrow_order_sort_columnRow OrderThe columns which shall be sorted on, if “sort” is configured for the Row Order.string"" (empty string)
Row Orderrow-orderrow_order_sort_directionRow OrderThe order direction which shall be used when sorting, if “sort” is configured for the Row Order.enum (asc or desc)asc
Search Highlightingdatatables-searchhighlightdatatables_searchhighlightSearch HighlightingWhether to highlight the current search term in the table.boolean (true or false)false
Search Panesdatatables-searchpanesdatatables_searchpanesSearch PanesWhether panes for filtering the columns should be shown.boolean (true or false)false
Search Panesdatatables-searchpanesdatatables_searchpanes_columnsSearch Panes ColumnsA comma-separated list of the columns for which a search pane should be shownstring"" (empty string)
Server-side Processingdatatables-serverside-processingdatatables_serverside_processingServer-side ProcessingWhether to load the table data dynamically via the TablePress REST API, for improved loading speed.boolean (true or false)false
Server-side Processingdatatables-serverside-processingdatatables_serverside_processing_cached_pagesServer-side Processing Cached pagesNumber of pages to cache to reduce requests to the server.integer0
Server-side Processingdatatables-serverside-processingdatatables_serverside_processing_periodic_refreshServer-side Processing Periodic refreshNumber of seconds after which the table data is automatically reloaded.integer0
Server-side Processingdatatables-serverside-processingdatatables_serverside_processing_request_typeServer-side Processing Request TypeRequest type for the HTTP/REST request.

This is only a Shortcode parameter, but not part of the user interface.
enum (GET or POST)GET
Server-side Processingdatatables-serverside-processingdatatables_serverside_processing_html_rowsServer-side Processing HTML RowsThis 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 Layoutdatatables-layoutdatatables_layoutTable LayoutThis parameter allows changing the Table Layout, by returning an object in JSON notation, e.g. as datatables_layout='{...}'.

Due to the JSON requirement, the JSON object string must be wrapped in single quotes ' for WordPress to properly recognize the parameter.

If the parameter is used inside a Shortcode, all [ and ] characters have to be replaced by their entities &lsqb; and &rsqb;.

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)