index - TenthPres/TouchPoint-WP GitHub Wiki

Hooks

Actions

tp_init

Fires after the plugin has been initialized.

Source: .\src\TouchPoint-WP\TouchPointWP.php, line 755

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.2

Source: .\src\TouchPoint-WP\EventsCalendar.php, line 70

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.3

Source: .\src\TouchPoint-WP\EventsCalendar.php, line 120

tp_use_default_templates

Arguments

Argument Type Description
true
self::class

Source: .\src\TouchPoint-WP\Involvement.php, line 423

tp_adjust_time_string

Calculate the schedule string. TODO adjust to include one-off meetings.

Arguments

Argument Type Description
$ts
$dt

Source: .\src\TouchPoint-WP\Involvement.php, line 695

tp_adjust_time_string

Calculate the schedule string. TODO adjust to include one-off meetings.

Arguments

Argument Type Description
$timeStr
$dt

Source: .\src\TouchPoint-WP\Involvement.php, line 695

tp_use_css

Arguments

Argument Type Description
true
self::class

Source: .\src\TouchPoint-WP\Involvement.php, line 1242

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

Source: .\src\TouchPoint-WP\Involvement.php, line 3161

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

Source: .\src\TouchPoint-WP\Involvement.php, line 3265

tp_allow_contact

Arguments

Argument Type Description
true

Source: .\src\TouchPoint-WP\Involvement.php, line 3370

tp_inv_allow_contact

Arguments

Argument Type Description
$allowed
$invType

Source: .\src\TouchPoint-WP\Involvement.php, line 3383

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

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

Source: .\src\TouchPoint-WP\Meeting.php, line 280

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

Source: .\src\TouchPoint-WP\Meeting.php, line 383

tp_use_default_templates

Determines whether the plugin's default templates should be used. Theme developers can return false in this filter to prevent the default templates from applying, especially if they conflict with the theme.

Default is true.

Arguments

Argument Type Description
true
self::class

Changelog

Version Description
0.0.6

Source: .\src\TouchPoint-WP\Partner.php, line 543

tp_use_css

Arguments

Argument Type Description
true
self::class

Source: .\src\TouchPoint-WP\Partner.php, line 680

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

Source: .\src\TouchPoint-WP\Partner.php, line 1232

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.

Changelog

Version Description
0.0.7

Source: .\src\TouchPoint-WP\Partner.php, line 1288

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

Source: .\src\TouchPoint-WP\Person.php, line 1194

tp_use_person_link

Arguments

Argument Type Description
$this->hasProfilePage()
$this

Source: .\src\TouchPoint-WP\Person.php, line 1384

tp_allow_contact

Arguments

Argument Type Description
true

Source: .\src\TouchPoint-WP\Person.php, line 1747

tp_person_allow_contact

Arguments

Argument Type Description
$allowed

Source: .\src\TouchPoint-WP\Person.php, line 1759

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_strtolower()

Arguments

Argument Type Description
true

Source: .\src\TouchPoint-WP\TouchPointWP.php, line 878

tp_include_style_strtolower()

Arguments

Argument Type Description
true

Source: .\src\TouchPoint-WP\TouchPointWP.php, line 911

tp_include_actions_style

Arguments

Argument Type Description
true
$action

Source: .\src\TouchPoint-WP\TouchPointWP.php, line 2383

tp_settings_fields

Adjust the settings array before it's returned.

Arguments

Argument Type Description
$this->settings

Changelog

Version Description
0.0.90

Source: .\src\TouchPoint-WP\TouchPointWP_Settings.php, line 1200

tp_menu_settings

Adjust the menu settings before they're applied.

Arguments

Argument Type Description
`[
'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 1276

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

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

tp_adjust_date_string

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

Arguments

Argument Type Description
$r
$dt \DateTimeInterface The DateTimeInterface object for the date being formatted.

Changelog

Version Description
0.0.90

Source: .\src\TouchPoint-WP\Utilities\DateFormats.php, line 98

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

Source: .\src\TouchPoint-WP\Utilities.php, line 572

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

Source: .\src\TouchPoint-WP\Utilities.php, line 588

tp_standardize_h_tags_max_h

Arguments

Argument Type Description
2
$context

Source: .\src\TouchPoint-WP\Utilities.php, line 611

tp_standardize_allowed_tags

The allowed tags in the HTML standardization process. Default is a set of common tags.

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

Source: .\src\TouchPoint-WP\Utilities.php, line 619

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

Source: .\src\TouchPoint-WP\Utilities.php, line 635

Pronamic WordPress Documentor
Generated by Pronamic WordPress Documentor 1.2.0

⚠️ **GitHub.com Fallback** ⚠️