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.
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 | Advanced Loading | Loads 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 Loading | datatables-advanced-loading | datatables_advanced_loading_html_rows | Advanced Loading HTML Rows | The 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. | integer | 10 | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_firstlast | Pagination First/Last Buttons | Turns on “First” and “Last” buttons (« and »). | boolean (true or false ) | false | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_previousnext | Pagination Previous/Next Buttons | Turns on “Previous” and “Next” buttons (‹ and ›). | boolean (true or false ) | true | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_numbers | Pagination Page Numbers | Turns on Page Number buttons. | boolean (true or false ) | true | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_input | Pagination Page Input Field | Adds an input field to jump to a specific page. | boolean (true or false ) | false | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_input_pageof | Pagination "page of" text | Adds a “page of” text “/N” after the input. | boolean (true or false ) | true | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_buttons | Pagination number of buttons | The number of buttons to show in the pagination. | integer | 7 | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_boundarynumbers | Pagination boundary buttons | Whether to always show the first and last number buttons. | boolean (true or false ) | true | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_loadmore_button | Pagination "Show More" button | Whether to show a "Show More" button that loads more rows instead of classical pagination. | boolean (true or false ) | false | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_scrolltotop | Pagination Scroll to Top | Whether to scroll to the top of the table when the visitor goes to a different table page. | boolean (true or false ) | false | |
Advanced Pagination Settings | datatables-pagination | datatables_pagination_scrolltotop_offset | Pagination Scroll to Top offset | The offset in pixels that defines the scroll position. | integer | 10 | |
Alphabet Search | datatables-alphabetsearch | datatables_alphabetsearch | Alphabet Search | Whether to show an alphabet for filtering the table by a chosen column’s first character. | boolean (true or false ) | false | |
Alphabet Search | datatables-alphabetsearch | datatables_alphabetsearch_column | Alphabet Search Column | Column for which an alphabet for searching should be shown. | string | 1 | |
Alphabet Search | datatables-alphabetsearch | datatables_alphabetsearch_alphabet | Alphabet Search Alphabet | Which alphabet to use (Latin alphabet (A-Z) or Greek alphabet (Α-Ω)) | enum (latin or greek ) | latin | |
Alphabet Search | datatables-alphabetsearch | datatables_alphabetsearch_numbers | Alphabet Search Numbers | Whether to show numbers in the alphabet. | boolean (true or false ) | false | |
Alphabet Search | datatables-alphabetsearch | datatables_alphabetsearch_letters | Alphabet Search Letters | Whether to show letters/characters in the alphabet. | boolean (true or false ) | true | |
Alphabet Search | datatables-alphabetsearch | datatables_alphabetsearch_case_sensitive | Alphabet Search Case-sensitivity | Whether to treat upper and lower case letters separately. | boolean (true or false ) | false | |
Automatic Filter | datatables-auto-filter | datatables_auto_filter | Automatic Filtering Search Term | The table will be automatically filtered for this search term. | string | "" (empty string) | |
Automatic Filter | datatables-auto-filter | datatables_auto_filter_url_parameter | Automatic Filtering | Instead of, or in addition to, using a pre-defined search term, a URL parameter like “table_filter” can be used. | string | "" (empty string) | |
Buttons | datatables-buttons | datatables_buttons | Buttons configuration | Configuration object of the User Action 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_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_expression | Cell Highlight expression | A logic expression for complex Cell Highlighting. | 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_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 | Column Filter Dropdowns | Whether to add Column Filter Dropdowns. | boolean (true or false ) | false | |
Column Filter Dropdowns | datatables-columnfilterwidgets | datatables_columnfilterwidgets_columns | Column Filter Dropdowns Columns | Columns for which Column Filter Dropdowns should be shown. | string | "" (empty string) | |
Column Filter Dropdowns | datatables-columnfilterwidgets | datatables_columnfilterwidgets_exclude_columns | Column Filter Dropdowns Exclude Columns | Columns which should be excluded from getting Column Filter Dropdowns. This setting is deprecated. Use datatables_columnfilterwidgets_columns instead. | string | "" (empty string) | |
Column Filter Dropdowns | datatables-columnfilterwidgets | datatables_columnfilterwidgets_separator | Column Filter Dropdowns Filter Term Separator | String separator, e.g. ", " that is used to split cell content to get individual filter terms. | string | "" (empty string) | |
Column Filter Dropdowns | datatables-columnfilterwidgets | datatables_columnfilterwidgets_max_selections | Column Filter Dropdowns Maximum selections | The 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 Dropdowns | datatables-columnfilterwidgets | datatables_columnfilterwidgets_group_terms | Column Filter Dropdowns Filter Terms Grouping | Whether to list the selected filter terms in one common section instead of underneath each dropdown. | boolean (true or false ) | false | |
Column Order | column-order | column_order | Column Order | Desired column order for a pre-ordering. Possible values are Default, Random, Reverse, and Custom. | enum (default , random , reverse , or manual ) | default | |
Column Order | column-order | column_order_manual_order | Column Order Custom Order | List of columns in the desired order, if "custom" is configured for the Column Order. | string | "" (empty string) | |
Custom Search Builder | datatables-searchbuilder | datatables_searchbuilder | Custom Search Builder | Whether to show a search builder interface for filtering from groups and using conditions. | boolean (true or false ) | false | |
Fixed Columns | datatables-fixedheader-fixedcolumns | datatables_fixedcolumns | Fixed Columns | Which 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 Columns | datatables-fixedheader-fixedcolumns | datatables_fixedcolumns_left_columns | Fixed Columns Number of Left columns | Number of columns to fix from the left. | integer | 0 | |
Fixed Columns | datatables-fixedheader-fixedcolumns | datatables_fixedcolumns_right_columns | Fixed Columns Number of Right columns | Number of columns to fix from the right. | integer | 0 | |
Fixed Columns | datatables-fixedheader-fixedcolumns | datatables_scrollx_buttons | Horizontal Scroll Buttons | Whether to show left/right buttons for the horizontal scrolling. | boolean (true or false ) | false | |
Fixed Rows | datatables-fixedheader-fixedcolumns | datatables_fixedheader | Fixed Header | What to fix to the top/bottom edge of the screen (top or bottom or top,bottom) when scrolling vertically. | string | "" (empty string) | |
Fixed Rows | datatables-fixedheader-fixedcolumns | datatables_fixedheader_offsettop | Fixed Header Offset | Offset 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. | integer | 0 | |
Fuzzy Search | datatables-fuzzysearch | datatables_fuzzysearch | Fuzzy Search | Whether to activate fuzzy search for the table. | boolean (true or false ) | false | |
Fuzzy Search | datatables-fuzzysearch | datatables_fuzzysearch_threshold | Fuzzy Search Threshold | Similarity 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. | float | 0.5 | |
Fuzzy Search | datatables-fuzzysearch | datatables_fuzzysearch_togglesmart | Fuzzy Search Toggle control | Whether to allow the visitor to switch between exact and fuzzy search. | boolean (true or false ) | true | |
Fuzzy Search | datatables-fuzzysearch | datatables_fuzzysearch_rankcolumn | Fuzzy Search Rank Column | The column number for a rank column that should show the search’s similarity score. | string | "" (empty string) | |
Index Column | datatables-counter-column | datatables_counter_column | Index Column or Counter Column | Whether 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 Filtering | datatables-column-filter | datatables_column_filter | Individual Column Filtering Form Element | The 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 Filtering | datatables-column-filter | datatables_column_filter_position | Individual Column Filtering Position | The desired position for the individual column filters: table_head for the Table Header or table_foot for the Table Footer | enum (table_head or table_foot ) | table_head | |
Individual Column Filtering | datatables-column-filter | datatables_column_filter_columns | Individual Column Filtering Columns | Columns for which an individual column filtering control should be added. | string | "" (empty string) | |
Inverted Filtering | datatables-inverted-filter | datatables_inverted_filter | Inverted Filtering | Whether to turn the filtering into a search and hide the table if no search term is entered. | boolean (true or false ) | false | |
Responsive Tables | responsive-tables | responsive | Mode for Responsiveness | The desired behavior of the table on small screens. | enum ("" (empty string), scroll , collapse modal, stack , or flip ) | "" (empty string) | |
Responsive Tables | responsive-tables | responsive_breakpoint | Breakpoint for the Mode of Responsiveness | The largest screen size (breakpoint) for which the Flip or Stack mode should be used. | enum (phone , tablet , desktop , or all ) | phone | |
Responsive Tables | responsive-tables | responsive_scroll_buttons | Horizontal Scroll Buttons | Whether to show left/right buttons for the horizontal scrolling. | boolean (true or false ) | false | |
Row Filtering | row-filtering | filter | Row Filtering Term | The 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 Filtering | row-filtering | filter_case_sensitive | Row Filtering Case-sensitive matching | Whether the case sensitivity of the filter term has to match the content in the cell. | boolean (true or false ) | false | |
Row Filtering | row-filtering | filter_columns | Row Filtering Filter columns | The columns which should be searched for the filter terms. | string | "" (empty string) // “” equates to ‘all’. | |
Row Filtering | row-filtering | filter_expression | Row Filtering Expression | A logic expression for complex Row Filtering. | string | "" (empty string) | |
Row Filtering | row-filtering | filter_full_cell_match | Row Filtering Full cell matching | Whether the full cell content has to match the filter term. | boolean (true or false ) | false | |
Row Filtering | row-filtering | filter_inverse | Row Filtering Invert filtering result | Whether rows with the filter term will be hidden and rows without the filter term will be shown. | boolean (true or false ) | false | |
Row Filtering | row-filtering | filter_url_parameter | Row Filtering URL parameter | Instead of, or in addition to, using a pre-defined filter term, a URL parameter like “table_filter” can be used. | string | "" (empty string) | |
Row Grouping | datatables-rowgroup | datatables_rowgroup | Row Grouping | Whether to group rows that belong to the same category. | boolean (true or false ) | false | |
Row Grouping | datatables-rowgroup | datatables_rowgroup_datasrc | Row Grouping Data source | Columns that are used as group categories. | string | 1 | |
Row Highlighting | row-highlighting | row_highlight | Row Highlight term | Rows 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 Highlighting | row-highlighting | row_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 | |
Row Highlighting | row-highlighting | row_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) | |
Row Highlighting | row-highlighting | row_highlight_expression | Row Highlight expression | A logic expression for complex Row Highlighting. | string | "" (empty string) | |
Row Highlighting | row-highlighting | row_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 ) | true | |
Row Highlighting | row-highlighting | row_highlight_rows | Highlight rows | A 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 Highlighting | row-highlighting | row_highlight_url_parameter | Row Highlight URL parameter | This allows providing the Row Highlight term in a URL parameter. | string | "" (empty string) | |
Row Order | row-order | row_order | Row Order | Desired row order for a pre-ordering. Possible values are Default, Random, Reverse, Sort, and Custom. | enum (default , random ,reverse , sort , or manual ) | default | |
Row Order | row-order | row_order_manual_order | Row Order Custom Order | List of columns in the desired order, if “custom” is configured for the Row Order. | string | "" (empty string) | |
Row Order | row-order | row_order_sort_column | Row Order | The columns which shall be sorted on, if “sort” is configured for the Row Order. | string | "" (empty string) | |
Row Order | row-order | row_order_sort_direction | Row Order | The order direction which shall be used when sorting, if “sort” is configured for the Row Order. | enum (asc or desc ) | asc | |
Search Highlighting | datatables-searchhighlight | datatables_searchhighlight | Search Highlighting | Whether to highlight the current search term in the table. | boolean (true or false ) | false | |
Search Panes | datatables-searchpanes | datatables_searchpanes | Search Panes | Whether panes for filtering the columns should be shown. | boolean (true or false ) | false | |
Search Panes | datatables-searchpanes | datatables_searchpanes_columns | Search Panes Columns | A comma-separated list of the columns for which a search pane should be shown | string | "" (empty string) | |
Server-side Processing | datatables-serverside-processing | datatables_serverside_processing | Server-side Processing | Whether to load the table data dynamically via the TablePress REST API, for improved loading speed. | boolean (true or false ) | false | |
Server-side Processing | datatables-serverside-processing | datatables_serverside_processing_cached_pages | Server-side Processing Cached pages | Number of pages to cache to reduce requests to the server. | integer | 0 | |
Server-side Processing | datatables-serverside-processing | datatables_serverside_processing_periodic_refresh | Server-side Processing Periodic refresh | Number of seconds after which the table data is automatically reloaded. | integer | 0 | |
Server-side Processing | datatables-serverside-processing | datatables_serverside_processing_request_type | Server-side Processing Request Type | Request 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 Processing | datatables-serverside-processing | datatables_serverside_processing_html_rows | Server-side 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='{...}' .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 [ and ] .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) |