Skip to content

wp Api

Jump to bottom
James K. edited this page Jun 26, 2024 · 14 revisions

Hooks

Actions

tp_init

Fires after the plugin has been initialized.

Source: src/TouchPoint-WP/TouchPointWP.php, line 764

Filters

tp_auto_redirect_login

Controls whether to redirect to the TouchPoint login automatically.

Arguments

Argument Type Description
$redirect bool Value preset from setting TouchPoint login as default.

Source: src/TouchPoint-WP/Auth.php, line 266

tp_prevent_admin_bar

Allows for hiding the WordPress-provided Admin bar.

Arguments

Argument Type Description
$removeBar bool True if bar should be removed.

Source: src/TouchPoint-WP/Auth.php, line 292

tp_app_events_content

Allows for manipulation of the html returned to the calendar feature of 2.0 Mobile apps.

Arguments

Argument Type Description
$content string The html thus far.

Changelog

Version Description
0.0.90 Deprecated
0.0.2 Added

Source: src/TouchPoint-WP/EventsCalendar.php, line 131

tp_app_events_css_url

Insert a CSS file into all event content for mobile 2.0 app.

Arguments

Argument Type Description
$cssUrl string The url for a CSS file. By default, one provided with the plugin is used.

Changelog

Version Description
0.0.90 Deprecated
0.0.3 Added

Source: src/TouchPoint-WP/EventsCalendar.php, line 180

tp_use_default_templates

Arguments

Argument Type Description
true
self::class

Source: src/TouchPoint-WP/Involvement.php, line 443

tp_use_css

Arguments

Argument Type Description
true
self::class

Source: src/TouchPoint-WP/Involvement.php, line 1504

tp_involvement_attributes

Allows for manipulation of the notable attributes strings for an Involvement. An array of strings.

Typically, these are the standardized strings that appear on the Involvement to give information about it, such as the schedule, leaders, and location.

Arguments

Argument Type Description
$attrs string[] The list of notable attributes.
$this \tp\TouchPointWP\Involvement The Involvement object.

Changelog

Version Description
0.0.11 Added

Source: src/TouchPoint-WP/Involvement.php, line 3493

tp_involvement_actions

Allows for manipulation of the action buttons for an Involvement. This is the list of buttons that appear on the Involvement to allow the user to interact with it.

Arguments

Argument Type Description
$ret \tp\TouchPointWP\Utilities\StringableArray The list of action buttons.
$this \tp\TouchPointWP\Involvement The Involvement object.
$context ?string A reference to where the action buttons are meant to be used.
$btnClass string A string for classes to add to the buttons. Note that buttons can be 'a' or 'button'
elements.

Changelog

Version Description
0.0.7 Added

Source: src/TouchPoint-WP/Involvement.php, line 3572

tp_allow_contact

Arguments

Argument Type Description
true

Source: src/TouchPoint-WP/Involvement.php, line 3775

tp_inv_allow_contact

Arguments

Argument Type Description
$allowed
$invType

Source: src/TouchPoint-WP/Involvement.php, line 3788

tp_get_involvement_type_settings

Adjust Involvement Post Type Settings. These settings define virtually all attributes of how a set of Involvements is synced to WordPress.

If you're using this filter, you will need to add your function VERY early (init with a low sequence number or earlier) because post types are registered early.

Arguments

Argument Type Description
$settingsArr \tp\TouchPointWP\Involvement_PostTypeSettings[] An array of the Post Type Settings objects.

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/Involvement_PostTypeSettings.php, line 79

tp_meeting_attributes

Allows for manipulation of the notable attributes strings for a Meeting. An array of strings.

Typically, these are the standardized strings that appear on the Involvement to give information about it, such as the schedule, leaders, and location.

Arguments

Argument Type Description
$attrs string[] The list of notable attributes.
$this \tp\TouchPointWP\Meeting The Meeting object.

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/Meeting.php, line 341

tp_meeting_actions

Allows for manipulation of the action buttons for a Meeting. This is the list of buttons that appear on the Meeting to allow the user to interact with it.

Arguments

Argument Type Description
$ret \tp\TouchPointWP\Utilities\StringableArray The list of action buttons.
$this \tp\TouchPointWP\Meeting The Meeting object.
$context ?string A reference to where the action buttons are meant to be used.
$btnClass string A string for classes to add to the buttons. Note that buttons can be 'a' or 'button'
elements.

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/Meeting.php, line 401

tp_use_default_templates

Arguments

Argument Type Description
true
self::class

Source: src/TouchPoint-WP/Partner.php, line 573

tp_use_css

Arguments

Argument Type Description
true
self::class

Source: src/TouchPoint-WP/Partner.php, line 699

tp_partner_attributes

Allows for manipulation of the notable attributes strings for an Partner. An array of strings.

Typically, these are the standardized strings that appear on the Partner to give information about it, such as the type and location.

Arguments

Argument Type Description
$r
$this \tp\TouchPointWP\Partner The Partner object.

Changelog

Version Description
0.0.6 Added

Source: src/TouchPoint-WP/Partner.php, line 1261

tp_partner_actions

Allows for manipulation of the action buttons for a Partner. This is the list of buttons that appear on the Partner to allow the user to interact with it.

Arguments

Argument Type Description
$ret \tp\TouchPointWP\Utilities\StringableArray The list of action buttons.
$this \tp\TouchPointWP\Partner The Partner object.
$context ?string A reference to where the action buttons are meant to be used.
$btnClass string A string for classes to add to the buttons. Note that buttons can be 'a' or 'button'
elements.
$absoluteLinks bool Set true to make the links absolute, so they work from apps or emails.

Changelog

Version Description
0.0.7 Added

Source: src/TouchPoint-WP/Partner.php, line 1320

tp_person_actions

Allows for manipulation of the action buttons for a Person. This is the list of buttons that appear on the Person to allow the user to interact with them.

Arguments

Argument Type Description
$ret \tp\TouchPointWP\Utilities\StringableArray The list of action buttons.
$this \tp\TouchPointWP\Person The Person object.
$context ?string A reference to where the action buttons are meant to be used.
$btnClass string A string for classes to add to the buttons. Note that buttons can be 'a' or 'button'
elements.

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/Person.php, line 1201

tp_allow_contact

Arguments

Argument Type Description
true

Source: src/TouchPoint-WP/Person.php, line 1792

tp_person_allow_contact

Arguments

Argument Type Description
$allowed

Source: src/TouchPoint-WP/Person.php, line 1804

tp_rpt_figure_class

Filter the class name to be used for the displaying the report.

Arguments

Argument Type Description
self::$classDefault
$report \tp\TouchPointWP\Report The report being displayed.

Source: src/TouchPoint-WP/Report.php, line 298

tp_include_script_{$filename}

Arguments

Argument Type Description
true

Source: src/TouchPoint-WP/TouchPointWP.php, line 888

tp_include_style_{$filename}

Arguments

Argument Type Description
true

Source: src/TouchPoint-WP/TouchPointWP.php, line 922

tp_include_actions_style

Arguments

Argument Type Description
true
$action

Source: src/TouchPoint-WP/TouchPointWP.php, line 2464

tp_settings_fields

Adjust the settings array before it's returned.

Arguments

Argument Type Description
$this->settings

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/TouchPointWP_Settings.php, line 1249

tp_menu_settings

Allows for manipulation of menu settings for the plugin.

Arguments

Argument Type Description
$settings array The settings array. Default values below.

'location' => 'options', // Possible settings: options, menu, submenu.
'parent_slug' => 'options-general.php',
'page_title' => __('TouchPoint-WP', 'TouchPoint-WP'),
'menu_title' => __('TouchPoint-WP', 'TouchPoint-WP'),
'capability' => 'manage_options',
'menu_slug' => $this->parent::TOKEN . '_Settings',
'function' => [$this, 'settingsPage'],
'icon_url' => '',
'position' => null,

Source: src/TouchPoint-WP/TouchPointWP_Settings.php, line 1337

tp_adjust_time_string

Allows for manipulation of the string returned as a formatted time.

Arguments

Argument Type Description
$ts string The string, as formatted so far.
$dt \DateTimeInterface The DateTimeInterface object for the time being formatted.

Changelog

Version Description
0.0.34 Added

Source: src/TouchPoint-WP/Utilities/DateFormats.php, line 27

tp_adjust_time_range_string

Allows for manipulation of a time range string. For example, combined with tp_adjust_time_string, you can change a range of 1:00pm - 2:00pm to 1-2pm.

Arguments

Argument Type Description
$ts string The string, as formatted so far.
$startStr string The start string, with default formatting.
$endStr string The end string, with default formatting
$startDt \DateTimeInterface The DateTimeInterface object for the start.
$endDt \DateTimeInterface The DateTimeInterface object for the $end.

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/Utilities/DateFormats.php, line 73

tp_adjust_date_string

Allows for manipulation of the string returned as a formatted date.

Arguments

Argument Type Description
$r string The string, as formatted so far.
$dt \DateTimeInterface The DateTimeInterface object for the date being formatted.

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/Utilities/DateFormats.php, line 148

tp_adjust_date_string_short

Allows for manipulation of the string returned as a (short) formatted date.

Arguments

Argument Type Description
$r string The string, as formatted so far.
$dt \DateTimeInterface The DateTimeInterface object for the date being formatted.

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/Utilities/DateFormats.php, line 220

tp_custom_color_function

Allows for a custom color function to assign a color for a given value.

Arguments

Argument Type Description
null
$itemName string The name of the current item.
$setName string The name of the set to which the item belongs.

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/Utilities.php, line 321

tp_custom_color_set

Allows for a custom color set to be used for color assignment to match branding. This filter should return an array of colors in hex format, starting with '#'. The colors will be assigned in order, but it is not deterministic which color will be assigned to which item. If it needs to be, use the tp_custom_color_function filter instead.

Arguments

Argument Type Description
[]
$setName string The name of the set for which the colors are needed.

Changelog

Version Description
0.0.90 Added

Source: src/TouchPoint-WP/Utilities.php, line 350

tp_standardize_html

Allows for the standardization of HTML content, typically during the import from TouchPoint. If this filter is used, the default filtering will be bypassed. Use other filters for more precise control.

Arguments

Argument Type Description
$html string The HTML to be standardized.
$context string A context string to pass to hooks.

Changelog

Version Description
0.0.34 Added

Source: src/TouchPoint-WP/Utilities.php, line 615

tp_pre_standardize_html

Make any adjustments to HTML content before the rest of the standardization process happens.

Arguments

Argument Type Description
$html string The HTML to be standardized.
$context string A context string to pass to hooks.

Changelog

Version Description
0.0.25 Added

Source: src/TouchPoint-WP/Utilities.php, line 631

tp_standardize_h_tags_max_h

Arguments

Argument Type Description
2
$context

Source: src/TouchPoint-WP/Utilities.php, line 654

tp_standardize_allowed_tags

The allowed tags in the HTML standardization process. Default is a set of common tags, but tags such as script, style, img, and others are stripped.

Arguments

Argument Type Description
$allowedTags string[] The allowed tags in the HTML.
$context string A context string to pass to hooks.

Changelog

Version Description
0.0.25 Added

Source: src/TouchPoint-WP/Utilities.php, line 662

tp_post_standardize_html

Make any adjustments to HTML content after the rest of the standardization process happens.

Arguments

Argument Type Description
$html string The HTML to be standardized.
$context string A context string to pass to hooks.

Changelog

Version Description
0.0.25 Added

Source: src/TouchPoint-WP/Utilities.php, line 678

Pronamic WordPress Documentor
Generated by Pronamic WordPress Documentor 1.2.0

Documentation generated June 26, 2024 3:56am.

Features

WordPress Hooks

PHP API Index

Clone this wiki locally