TablePress-Hooks.md

Hooks

• Actions
• Filters

Actions

tablepress_run

Fires before TablePress is loaded.

The tablepress_loaded action hook might be a better choice in most situations, as TablePress options will then be available.

Changelog

Version	Description
1.0.0

Source: ./classes/class-tablepress.php, line 111

tablepress_loaded

Fires after TablePress is loaded.

The tablepress_run action hook can be used if code has to run before TablePress is loaded.

Changelog

Version	Description
2.0.0

Source: ./classes/class-tablepress.php, line 180

tablepress_event_saved_table

Fires after a table has been saved.

Arguments

Argument	Type	Description
$table['id']

Changelog

Version	Description
1.5.0

Source: ./models/model-table.php, line 369

tablepress_event_added_table

Fires after a new table has been added.

Arguments

Argument	Type	Description
$table_id	string	ID of the added table.

Changelog

Version	Description
1.1.0

Source: ./models/model-table.php, line 415

tablepress_event_copied_table

Fires after an existing table has been copied.

Arguments

Argument	Type	Description
$new_table_id	string	ID of the copy of the table.
$table_id	string	ID of the existing table that is copied.

Changelog

Version	Description
1.1.0

Source: ./models/model-table.php, line 466

tablepress_event_deleted_table

Fires after a table has been deleted.

Arguments

Argument	Type	Description
$table_id	string	ID of the deleted table.

Changelog

Version	Description
1.1.0

Source: ./models/model-table.php, line 506

tablepress_event_deleted_all_tables

Fires after all tables have been deleted.

Changelog

Version	Description
1.1.0

Source: ./models/model-table.php, line 541

tablepress_event_changed_table_id

Fires after the ID of a table has been changed.

Arguments

Argument	Type	Description
$new_id	string	New ID of the table.
$old_id	string	Old ID of the table.

Changelog

Version	Description
1.1.0

Source: ./models/model-table.php, line 762

Filters

tablepress_table_shortcode

Filters the string that is used as the [table] Shortcode.

Arguments

Argument	Type	Description
self::$shortcode

Changelog

Version	Description
1.0.0

Source: ./classes/class-tablepress.php, line 131

tablepress_table_info_shortcode

Filters the string that is used as the [table-info] Shortcode.

Arguments

Argument	Type	Description
self::$shortcode_info

Changelog

Version	Description
1.0.0

Source: ./classes/class-tablepress.php, line 139

tablepress_exit_early

Filters whether TablePress should exit early, e.g. during wp-login.php, XML-RPC, and WP-Cron requests.

Arguments

Argument	Type	Description
$exit_early	bool	Whether TablePress should exit early.

Changelog

Version	Description
2.0.0

Source: ./classes/class-tablepress.php, line 159

tablepress_load_file_full_path

Filters the full path of a file that shall be loaded.

Arguments

Argument	Type	Description
$full_path	string	Full path of the file that shall be loaded.
$file	string	File name of the file that shall be loaded.
$folder	string	Folder name of the file that shall be loaded.

Changelog

Version	Description
1.0.0

Source: ./classes/class-tablepress.php, line 200

tablepress_load_class_name

Filters name of the class that shall be loaded.

Arguments

Argument	Type	Description
$class_name	string	Name of the class that shall be loaded.

Changelog

Version	Description
1.0.0

Source: ./classes/class-tablepress.php, line 228

tablepress_site_uses_block_editor

Filters the outcome of the check whether the site uses the block editor.

This can be used when certain conditions (e.g. new site builders) are not (yet) accounted for.

Arguments

Argument	Type	Description
$site_uses_block_editor	bool	True if the site uses the block editor, false otherwise.

Changelog

Version	Description
2.0.1

Source: ./classes/class-tablepress.php, line 559

tablepress_table_raw_render_data

Filters the table before the render process.

Arguments

Argument	Type	Description
$this->table
$this->render_options

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 112

tablepress_table_evaluate_data

Filters the table after evaluating formulas in the table.

Arguments

Argument	Type	Description
$this->table
$orig_table	array	The table with unevaluated formulas.
$this->render_options

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 174

tablepress_table_render_data

Filters the table after processing the table visibility information.

Arguments

Argument	Type	Description
$this->table
$orig_table	array	The unprocessed table.
$this->render_options

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 276

tablepress_cell_content

This filter is documented in classes/class-render.php

Arguments

Argument	Type	Description
$cell_content
$this->table['id']
$row_idx + 1
$col_idx + 1

Source: ./classes/class-render.php, line 311

tablepress_table_content_render_data

Filters the table after processing the table content handling.

Arguments

Argument	Type	Description
$this->table
$orig_table	array	The unprocessed table.
$this->render_options

Changelog

Version	Description
2.0.0

Source: ./classes/class-render.php, line 322

tablepress_span_trigger_keywords

Filters the trigger keywords for "colspan" and "rowspan"

Arguments

Argument	Type	Description
$this->span_trigger
$this->table['id']

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 353

tablepress_print_name_html_tag

Filters the HTML tag that wraps the printed table name.

Arguments

Argument	Type	Description
'h2'
$this->table['id']

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 371

tablepress_print_name_css_class

Filters the class attribute for the printed table name.

Arguments

Argument	Type	Description
array("tablepress-table-name tablepress-table-name-id-{$this->table['id']}", $this->table['id'])
'TablePress 1.13.0'
'tablepress_table_name_tag_attributes'

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 385

tablepress_table_name_tag_attributes

Filters the attributes for the table name (HTML h2 element, by default).

Arguments

Argument	Type	Description
$name_attributes	array	The attributes for the table name element.
$this->table
$this->render_options

Changelog

Version	Description
1.13.0

Source: ./classes/class-render.php, line 395

tablepress_print_description_html_tag

Filters the HTML tag that wraps the printed table description.

Arguments

Argument	Type	Description
'span'
$this->table['id']

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 410

tablepress_print_description_css_class

Filters the class attribute for the printed table description.

Arguments

Argument	Type	Description
array("tablepress-table-description tablepress-table-description-id-{$this->table['id']}", $this->table['id'])
'TablePress 1.13.0'
'tablepress_table_description_tag_attributes'

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 424

tablepress_table_description_tag_attributes

Filters the attributes for the table description (HTML span element, by default).

Arguments

Argument	Type	Description
$description_attributes	array	The attributes for the table description element.
$this->table
$this->render_options

Changelog

Version	Description
1.13.0

Source: ./classes/class-render.php, line 434

tablepress_print_caption_text

Filters the content for the HTML caption element of the table.

If the "Edit" link for a table is shown, it is also added to the caption element.

Arguments

Argument	Type	Description
''
$this->table

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 479

tablepress_print_caption_class

Filters the class attribute for the HTML caption element of the table.

Arguments

Argument	Type	Description
"tablepress-table-caption tablepress-table-caption-id-{$this->table['id']}"
$this->table['id']

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 493

tablepress_print_colgroup_tag

Filters whether the HTML colgroup tag shall be added to the table output.

Arguments

Argument	Type	Description
false
$this->table['id']

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 518

tablepress_colgroup_tag_attributes

Filters the attributes of the HTML col tags in the HTML colgroup tag.

Arguments

Argument	Type	Description
$attributes	string	The attributes in the col element.
$this->table['id']
$col_idx + 1

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 529

tablepress_table_css_classes

Filters the CSS classes that are given to the HTML table element.

Arguments

Argument	Type	Description
$css_classes	array	The CSS classes for the table element.
$this->table['id']

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 568

tablepress_print_summary_attr

Filters the content for the summary attribute of the HTML table element.

The attribute is only added if it is not empty.

Arguments

Argument	Type	Description
$summary	string	The content for the summary attribute of the table. Default empty.
$this->table

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 596

tablepress_table_tag_attributes

Filters the attributes for the table (HTML table element).

Arguments

Argument	Type	Description
$table_attributes	array	The attributes for the table element.
$this->table
$this->render_options

Changelog

Version	Description
1.4.0

Source: ./classes/class-render.php, line 618

tablepress_table_output

Filters the generated HTML code for table.

Arguments

Argument	Type	Description
$output	string	The generated HTML for the table.
$this->table
$this->render_options

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 642

tablepress_cell_css_class

Filters the CSS classes that are given to a single cell (HTML td element) of a table.

Arguments

Argument	Type	Description
$cell_class	string	The CSS classes for the cell.
$this->table['id']
$cell_content	string	The cell content.
$row_idx + 1
$col_idx + 1
$this->colspan[$row_idx]
$this->rowspan[$col_idx]

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 724

tablepress_cell_tag_attributes

Filters the attributes for the table cell (HTML td or th element).

Arguments

Argument	Type	Description
$tag_attributes	array	The attributes for the td or th element.
$this->table['id']
$cell_content	string	The cell content.
$row_idx + 1
$col_idx + 1
$this->colspan[$row_idx]
$this->rowspan[$col_idx]

Changelog

Version	Description
1.4.0

Source: ./classes/class-render.php, line 747

tablepress_row_css_class

Filters the CSS classes that are given to a row (HTML tr element) of a table.

Arguments

Argument	Type	Description
$row_classes	string	The CSS classes for the row.
$this->table['id']
$row_cells	array	The HTML code for the cells of the row.
$row_idx + 1
$this->table['data'][$row_idx]

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 780

tablepress_row_tag_attributes

Filters the attributes for the table row (HTML tr element).

Arguments

Argument	Type	Description
$tr_attributes	array	The attributes for the tr element.
$this->table['id']
$row_idx + 1
$this->table['data'][$row_idx]

Changelog

Version	Description
1.4.0

Source: ./classes/class-render.php, line 796

tablepress_apply_nl2br

Filters whether line breaks in the cell content shall be replaced with HTML br tags.

Arguments

Argument	Type	Description
true
$this->table['id']

Changelog

Version	Description
1.0.0

Source: ./classes/class-render.php, line 846

tablepress_admin_menu_parent_page

Filters the admin menu parent page, which is needed for the construction of plugin URLs.

Arguments

Argument	Type	Description
TablePress::$model_options->get('admin_menu_parent_page')

Changelog

Version	Description
1.0.0

Source: ./classes/class-controller.php, line 49

tablepress_admin_page_script_dependencies

Filters the dependencies of a TablePress script file.

Arguments

Argument	Type	Description
$dependencies	array	List of the dependencies that the $name script relies on.
$name	string	Name of the JS script, without extension.

Changelog

Version	Description
2.0.0

Source: ./classes/class-admin-page-helper.php, line 65

tablepress_import_table_data

Arguments

Argument	Type	Description
$data
$format

Source: ./classes/class-import-legacy.php, line 87

tablepress_use_legacy_table_evaluate_class

Filters whether the Legacy Table Evaluate class shall be used.

Arguments

Argument	Type	Description
false

Changelog

Version	Description
2.0.0

Source: ./classes/class-evaluate.php, line 34

tablepress_custom_css_url

Filters the URL from which the "Custom CSS" file is loaded.

Arguments

Argument	Type	Description
$url	string	URL of the "Custom CSS" file.
$file	string	File name of the "Custom CSS" file.
$type	string	Type of the "Custom CSS" file ("normal", "minified", or "combined").

Changelog

Version	Description
1.0.0

Source: ./classes/class-css.php, line 139

tablepress_custom_css_file_name

Filters the file path on the server from which the "Custom CSS" file is loaded.

Arguments

Argument	Type	Description
$path	string	File path of the "Custom CSS" file.
$file	string	File name of the "Custom CSS" file.
$type	string	Type of the "Custom CSS" file ("normal", "minified", or "combined").

Changelog

Version	Description
1.0.0

Source: ./classes/class-css.php, line 153

tablepress_save_custom_css_to_file

Arguments

Argument	Type	Description
true

Source: ./classes/class-css.php, line 238

tablepress_save_custom_css_to_file

Arguments

Argument	Type	Description
true

Source: ./classes/class-css.php, line 272

tablepress_flush_caching_plugins_caches

Arguments

Argument	Type	Description
true

Source: ./classes/class-css.php, line 443

tablepress_use_legacy_table_import_class

Filters whether the Legacy Table Import class shall be used.

Arguments

Argument	Type	Description
false

Changelog

Version	Description
2.0.0

Source: ./classes/class-import.php, line 399

tablepress_post_type

Filters the "Custom Post Type" that TablePress uses for storing tables in the database.

Arguments

Argument	Type	Description
$this->post_type

Changelog

Version	Description
1.0.0

Source: ./models/model-post.php, line 48

tablepress_post_type_args

Filters the arguments for the registration of the "Custom Post Type" that TablePress uses.

Arguments

Argument	Type	Description
$post_type_args	array	Arguments for the registration of the TablePress "Custom Post Type".

Changelog

Version	Description
1.0.0

Source: ./models/model-post.php, line 69

tablepress_load_all_tables

Filters all table IDs that are loaded.

Arguments

Argument	Type	Description
$table_ids	array	The table IDs that are loaded.

Changelog

Version	Description
1.4.0

Source: ./models/model-table.php, line 246

tablepress_filter_table_cell_content

Arguments

Argument	Type	Description
true

Source: ./models/model-table.php, line 304

tablepress_flush_caching_plugins_caches

Arguments

Argument	Type	Description
true

Source: ./models/model-table.php, line 616

tablepress_table_template

Filters the default template/structure of an empty table.

Arguments

Argument	Type	Description
$table	array	Default template/structure of an empty table.

Changelog

Version	Description
1.0.0

Source: ./models/model-table.php, line 838

tablepress_map_meta_caps

Filters a user's TablePress capabilities.

Arguments

Argument	Type	Description
$caps	array	The user's current TablePress capabilities.
$cap	string	Capability name.
$user_id	int	The user ID.
$args	array	Adds the context to the cap, typically the table ID.

Changelog

Version	Description
1.0.0

Source: ./models/model-options.php, line 336

tablepress_admin_page_script_dependencies

Filters the dependencies of a TablePress script file.

Arguments

Argument	Type	Description
$dependencies	array	List of the dependencies that the $name script relies on.
$name	string	Name of the JS script, without extension.

Changelog

Version	Description
2.0.0

Source: ./modules/classes/class-modules-helper.php, line 65

tablepress_module_enqueue_css_files

Arguments

Argument	Type	Description
true
self::$module['slug']

Source: ./modules/controllers/datatables-searchhighlight.php, line 170

tablepress_rest_api_permissions_check

Allows overriding the TablePress REST API permission check.

If the filter returns true or false that will be used to short-circuit the permissions checks.

Arguments

Argument	Type	Description
null
$request	\WP_REST_Request	Full details about the request.

Changelog

Version	Description
2.1.0

Source: ./modules/controllers/rest-api.php, line 95

tablepress_rest_api_permissions_check

This filter is documented in modules/controllers/rest-api.php

Arguments

Argument	Type	Description
null
$request

Source: ./modules/controllers/rest-api.php, line 177

tablepress_module_enqueue_css_files

Arguments

Argument	Type	Description
true
self::$module['slug']

Source: ./modules/controllers/datatables-searchpanes.php, line 211

tablepress_shortcode_table_default_shortcode_atts

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
$default_render_options

Source: ./modules/controllers/datatables-serverside-processing-rest-api.php, line 240

tablepress_shortcode_table_shortcode_atts

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
$render_options

Source: ./modules/controllers/datatables-serverside-processing-rest-api.php, line 243

tablepress_serverside_processing_order_column_data

Filters the sort data for a column.

This can be used to modify a column's data as used for sorting. For rendering, the original data will be used.

Arguments

Argument	Type	Description
$column_data	array	Sort data for the column.
$table['id']
$order_command['column']

Changelog

Version	Description
2.0.0

Source: ./modules/controllers/datatables-serverside-processing-rest-api.php, line 429

tablepress_module_enqueue_css_files

Arguments

Argument	Type	Description
true
self::$module['slug']

Source: ./modules/controllers/responsive-tables.php, line 200

tablepress_responsive_tables_enqueue_css_file

Arguments

Argument	Type	Description
true

Source: ./modules/controllers/responsive-tables.php, line 212

tablepress_datatables_advanced_loading_output

Arguments

Argument	Type	Description
$js_output
$json_data
$render_data
$table
$render_options

Source: ./modules/controllers/datatables-advanced-loading.php, line 239

tablepress_module_enqueue_css_files

Arguments

Argument	Type	Description
true
self::$module['slug']

Source: ./modules/controllers/datatables-searchbuilder.php, line 301

tablepress_module_enqueue_css_files

Arguments

Argument	Type	Description
true
self::$module['slug']

Source: ./modules/controllers/datatables-buttons.php, line 294

tablepress_module_enqueue_css_files

Arguments

Argument	Type	Description
true
self::$module['slug']

Source: ./modules/controllers/datatables-columnfilterwidgets.php, line 283

tablepress_datatables_serverside_processing_render_options

Filters the list of render option keys that are passed as a request parameter in the AJAX call to the Server-side Processing REST API endpoint.

This can be used to make other render options available to e.g. other filter hooks in the Render class.

Arguments

Argument	Type	Description
$render_options_ssp	array	Render Options list for Server-side Processing.
$table_id	string	Table ID.
$render_options	array	Render Options.

Changelog

Version	Description
2.0.4

Source: ./modules/controllers/datatables-serverside-processing.php, line 203

tablepress_module_enqueue_css_files

Arguments

Argument	Type	Description
true
self::$module['slug']

Source: ./modules/controllers/datatables-rowgroup.php, line 224

tablepress_module_enqueue_css_files

Arguments

Argument	Type	Description
true
self::$module['slug']

Source: ./modules/controllers/datatables-alphabetsearch.php, line 279

tablepress_advanced_access_rights_hide_prohibited_tables

Filters whether tables which a user can not access should be hidden in lists of tables.

Arguments

Argument	Type	Description
true

Changelog

Version	Description
2.0.0

Source: ./modules/controllers/advanced-access-rights.php, line 79

tablepress_advanced_access_rights_prohibited_caps

Filters the capabilities that are prohibited via the Advanced Access Rights user interface.

Arguments

Argument	Type	Description
$prohibited_caps	array	Array if prohibited capabilities.
$cap	string	Meta cap that is to be checked/mapped.
$user_id	int	User ID for which meta cap is to be checked.
$args	array	Arguments for the check, here e.g. the table ID.

Changelog

Version	Description
2.1.0

Source: ./modules/controllers/advanced-access-rights.php, line 169

tablepress_use_default_css

Arguments

Argument	Type	Description
true

Source: ./controllers/controller-frontend.php, line 47

tablepress_wp_search_integration

Filters whether the WordPress search shall also search TablePress tables.

Arguments

Argument	Type	Description
true

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 57

tablepress_use_default_css

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
true

Source: ./controllers/controller-frontend.php, line 101

tablepress_custom_css_version

Filters the "Custom CSS" version number that is appended to the enqueued CSS files

Arguments

Argument	Type	Description
TablePress::$model_options->get('custom_css_version')

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 106

tablepress_default_css_url

Filters the URL from which the TablePress Default CSS file is loaded.

Arguments

Argument	Type	Description
$unfiltered_default_css_url	string	URL of the TablePress Default CSS file.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 120

tablepress_custom_css

Filters the "Custom CSS" code that is to be loaded as inline CSS.

Arguments

Argument	Type	Description
$custom_css	string	The "Custom CSS" code.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 163

tablepress_custom_css

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
$custom_css

Source: ./controllers/controller-frontend.php, line 197

tablepress_datatables_js_url

Filters the URL from which the DataTables JavaScript library file is loaded.

Arguments

Argument	Type	Description
$js_url	string	URL of the DataTables JS library file.
$js_file	string	Path and file name of the DataTables JS library file.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 210

tablepress_datatables_locale

Filters the locale/language for the DataTables JavaScript library.

Arguments

Argument	Type	Description
$js_options['datatables_locale']
$table_id	string	The current table ID.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 264

tablepress_datatables_language_file

Filters the language file path for the DataTables JavaScript library.

PHP files that return an array and JSON files are supported. The JSON file method is deprecated and should no longer be used.

Arguments

Argument	Type	Description
$orig_language_file	string	Language file path for the DataTables JS library.
$datatables_locale	string	Current locale/language for the DataTables JS library.
TABLEPRESS_ABSPATH

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 278

tablepress_datatables_language_strings

Filters the language strings for the DataTables JavaScript library's features.

Arguments

Argument	Type	Description
$datatables_strings	array	The language strings for DataTables.
$datatables_locale	string	Current locale/language for the DataTables JS library.

Changelog

Version	Description
2.0.0

Source: ./controllers/controller-frontend.php, line 321

tablepress_datatables_parameters

Filters the parameters that are passed to the DataTables JavaScript library.

Arguments

Argument	Type	Description
$parameters	array	The parameters for the DataTables JS library.
$table_id	string	The current table ID.
$html_id	string	The ID of the table HTML element.
$js_options	array	The options for the JS library.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 383

tablepress_datatables_command

Filters the JavaScript command that invokes the DataTables JavaScript library on one table.

Arguments

Argument	Type	Description
$command	string	The JS command for the DataTables JS library.
$html_id	string	The ID of the table HTML element.
$parameters	string	The parameters for the DataTables JS library.
$table_id	string	The current table ID.
$js_options	array	The options for the JS library.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 408

tablepress_all_datatables_commands

Filters the JavaScript commands that invoke the DataTables JavaScript library on all tables on the page.

Arguments

Argument	Type	Description
$commands	string	The JS commands for the DataTables JS library.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 433

tablepress_all_datatables_commands_wrapper

Filters the script/jQuery wrapper code for the DataTables commands calls.

Arguments

Argument	Type	Description
$js_wrapper	string	Default script/jQuery wrapper code for the DataTables commands calls.

Changelog

Version	Description
1.14.0

Source: ./controllers/controller-frontend.php, line 454

tablepress_shortcode_table_default_shortcode_atts

Filters the available/default attributes for the [table] Shortcode.

Arguments

Argument	Type	Description
$default_shortcode_atts	array	The [table] Shortcode default attributes.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 483

tablepress_shortcode_table_shortcode_atts

Filters the attributes that were passed to the [table] Shortcode.

Arguments

Argument	Type	Description
$shortcode_atts	array	The attributes passed to the [table] Shortcode.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 493

tablepress_table_not_found_message

Filters the "Table not found" message.

Arguments

Argument	Type	Description
$message	string	The "Table not found" message.
$table_id	string	The current table ID.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 506

tablepress_table_load_error_message

Filters the "Table could not be loaded" message.

Arguments

Argument	Type	Description
$message	string	The "Table could not be loaded" message.
$table_id	string	The current table ID.
$table	\WP_Error	The error object for the table.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 522

tablepress_table_corrupted_message

Filters the "Table data is corrupted" message.

Arguments

Argument	Type	Description
$message	string	The "Table data is corrupted" message.
$table_id	string	The current table ID.
$table['json_error']

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 536

tablepress_disable_custom_commands_shortcode_parameter

Arguments

Argument	Type	Description
true

Source: ./controllers/controller-frontend.php, line 558

tablepress_html_id

Filters the ID of the table HTML element.

Arguments

Argument	Type	Description
$render_options['html_id']
$table_id	string	The current table ID.
$count	string	Number of copies of the table with this table ID on the page.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 590

tablepress_edit_link_below_table

Arguments

Argument	Type	Description
true
$table['id']

Source: ./controllers/controller-frontend.php, line 613

tablepress_table_render_options

Filters the render options for the table.

The render options are determined from the settings on a table's "Edit" screen and the Shortcode parameters.

Arguments

Argument	Type	Description
$render_options	array	The render options for the table.
$table	array	The current table.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 617

tablepress_cache_hit_comment

Filters the cache hit comment message.

Arguments

Argument	Type	Description
"<!-- #{$render_options['html_id']} from cache -->"

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 654

tablepress_table_js_options

Filters the JavaScript options for the table.

The JavaScript options are determined from the settings on a table's "Edit" screen and the Shortcode parameters. They are part of the render options and can be overwritten with Shortcode parameters.

Arguments

Argument	Type	Description
$js_options	array	The JavaScript options for the table.
$table_id	string	The current table ID.
$render_options	array	The render options for the table.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 694

tablepress_shortcode_table_info_default_shortcode_atts

Filters the available/default attributes for the [table-info] Shortcode.

Arguments

Argument	Type	Description
$default_shortcode_atts	array	The [table-info] Shortcode default attributes.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 737

tablepress_shortcode_table_info_shortcode_atts

Filters the attributes that were passed to the [table-info] Shortcode.

Arguments

Argument	Type	Description
$shortcode_atts	array	The attributes passed to the [table-info] Shortcode.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 746

tablepress_shortcode_table_info_overwrite

Filters whether the output of the [table-info] Shortcode is overwritten/short-circuited.

Arguments

Argument	Type	Description
false
$shortcode_atts	array	The attributes passed to the [table-info] Shortcode.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 755

tablepress_table_not_found_message

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
$message
$table_id

Source: ./controllers/controller-frontend.php, line 772

tablepress_table_load_error_message

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
$message
$table_id
$table

Source: ./controllers/controller-frontend.php, line 781

tablepress_table_info_not_found_message

Filters the "table info field not found" message.

Arguments

Argument	Type	Description
$output	string	The "table info field not found" message.
$table	array	The current table ID.
$field	string	The field that was not found.
$format	string	The return format for the field.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 846

tablepress_shortcode_table_info_output

Filters the output of the [table-info] Shortcode.

Arguments

Argument	Type	Description
$output	string	The output of the [table-info] Shortcode.
$table	array	The current table.
$shortcode_atts	array	The attributes passed to the [table-info] Shortcode.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-frontend.php, line 859

tablepress_shortcode_table_default_shortcode_atts

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
$default_render_options

Source: ./controllers/controller-admin_ajax.php, line 258

tablepress_shortcode_table_shortcode_atts

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
$render_options

Source: ./controllers/controller-admin_ajax.php, line 261

tablepress_admin_menu_entry_name

Filters the TablePress admin menu entry name.

Arguments

Argument	Type	Description
'TablePress'

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-admin.php, line 88

tablepress_add_legacy_editor_button

Filters whether the legacy editor button should be loaded on the post editing screen.

Arguments

Argument	Type	Description
true

Changelog

Version	Description
2.1.0

Source: ./controllers/controller-admin.php, line 151

tablepress_block_editor_tables_list

Filters the list of table IDs and names that is passed to the block editor, and is then used in the dropdown of the TablePress table block.

Arguments

Argument	Type	Description
$tables	array	List of table names, the table ID is the array key.

Changelog

Version	Description
2.0.0

Source: ./controllers/controller-admin.php, line 209

tablepress_show_block_editor_preview

Filters whether the table block preview should be loaded via a in the block editor.

Arguments

Argument	Type	Description
true

Changelog

Version	Description
2.0.0

Source: ./controllers/controller-admin.php, line 229

tablepress_view_data

Filters the data that is passed to the current TablePress View.

Arguments

Argument	Type	Description
$data	array	Data for the view.
$action	string	The current action for the view.

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-admin.php, line 525

tablepress_admin_view_actions

Filters the available TablePres Views/Actions and their parameters.

Arguments

Argument	Type	Description
$this->view_actions

Changelog

Version	Description
1.0.0

Source: ./controllers/controller-admin.php, line 633

tablepress_admin_menu_parent_page

This filter is documented in classes/class-controller.php

Arguments

Argument	Type	Description
$posted_options['admin_menu_parent_page']

Source: ./controllers/controller-admin.php, line 813

tablepress_export_filename

Filters the download filename of the exported table.

Arguments

Argument	Type	Description
$download_filename	string	The download filename of exported table.
$table['id']
$table['name']
$export['format']
$export_to_zip	bool	Whether the export is to a ZIP file (of multiple export files).

Changelog

Version	Description
2.0.0

Source: ./controllers/controller-admin.php, line 920

tablepress_export_data

Filters the exported table data.

Arguments

Argument	Type	Description
$export_data	string	The exported table data.
$table	array	Table to be exported.
$export['format']
$export['csv_delimiter']

Changelog

Version	Description
1.6.0

Source: ./controllers/controller-admin.php, line 935

tablepress_export_filename

This filter is documented in controllers/controller-admin.php

Arguments

Argument	Type	Description
$download_filename
''
''
$export['format']
$export_to_zip

Source: ./controllers/controller-admin.php, line 956

tablepress_export_data

This filter is documented in controllers/controller-admin.php

Arguments

Argument	Type	Description
$export_data
$table
$export['format']
$export['csv_delimiter']

Source: ./controllers/controller-admin.php, line 981

tablepress_export_filename

This filter is documented in controllers/controller-admin.php

Arguments

Argument	Type	Description
$export_filename
$table['id']
$table['name']
$export['format']
$export_to_zip

Source: ./controllers/controller-admin.php, line 984

tablepress_shortcode_table_default_shortcode_atts

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
$default_render_options

Source: ./controllers/controller-admin.php, line 1244

tablepress_shortcode_table_shortcode_atts

This filter is documented in controllers/controller-frontend.php

Arguments

Argument	Type	Description
$render_options

Source: ./controllers/controller-admin.php, line 1247

Generated by Pronamic WordPress Documentor 1.2.0