/
```
```text
http://yoursite.com/give-api/donations/
```
```text
http://yoursite.com/give-api/donations/?key=a281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70
```
--------------------------------
### wp ithemes-licensing activate
Source: https://docs.nexcess.com/software/kadence/solid/central/manage-sites
Activates the license for installed SolidWP products.
```APIDOC
## wp ithemes-licensing activate
### Description
Activates the license for installed SolidWP products.
```
--------------------------------
### GET Attendees Endpoint
Source: https://docs.nexcess.com/software/the-events-calendar/event-tickets-rest-api
Example of a standard GET request to the attendees endpoint.
```http
GET https://demo.theeventscalendar.com/wp-json/tribe/tickets/v1/attendees
```
--------------------------------
### Initializing Gateway Configuration
Source: https://docs.nexcess.com/software/kadence/restrict-content-pro/payment-gateway-api
Example implementation of the init() method to define supported features and API credentials.
```php
/**
* Initialize the gateway configuration
*
* This is used to populate the $supports property, setup any API keys, and set the API endpoint.
*
* @access public
* @return void
*/
public function init() {
/* Example:
$this->supports[] = 'one-time';
$this->supports[] = 'recurring';
$this->supports[] = 'fees';
$this->supports[] = 'trial';
global $rcp_options;
if ( $this->test_mode ) {
$this->api_endpoint = 'https://sandbox.gateway.com';
$this->api_key = $rcp_options['my_sandbox_api_key'];
} else {
$this->api_endpoint = 'https://live.gateway.com';
$this->api_key = $rcp_options['my_live_api_key'];
}
*/
}
```
--------------------------------
### Embed Event Schedule with Shortcode
Source: https://docs.nexcess.com/software/the-events-calendar
Example usage of the [tec_schedule] shortcode to display event tracks and customize the appearance.
```text
[tec_schedule tracks="all" color_scheme="light" session_link"none"]
```
--------------------------------
### Retrieve and set member status
Source: https://docs.nexcess.com/software/kadence/restrict-content-pro/rcp_member
Examples for getting the current status of a member and updating it to a new status.
```php
$member = new RCP_Member( 1 );
$status = $member->get_status();
```
```php
$member = new RCP_Member( 1 );
$member->set_status( ‘active’ );
```
--------------------------------
### Configure Security Headers
Source: https://docs.nexcess.com/software/kadence/solid/solid-security/security-headers
Example of setting up security headers within a Solid application configuration.
```javascript
import { defineConfig } from 'solid-start';
export default defineConfig({
middleware: ['solid-security'],
security: {
headers: {
'Content-Security-Policy': "default-src 'self';",
'X-Frame-Options': 'DENY',
'X-Content-Type-Options': 'nosniff',
'Referrer-Policy': 'strict-origin-when-cross-origin'
}
}
});
```
--------------------------------
### Display Installation Details
Source: https://docs.nexcess.com/software/give/give-cli
Shows GiveWP version, success/failure page URLs, currency settings, and enabled payment gateways.
```bash
wp give details
```
--------------------------------
### Initialize Payment Gateway Class
Source: https://docs.nexcess.com/software/kadence/restrict-content-pro/payment-gateway-api
Use the init() method to declare supported features, configure API credentials based on test mode, and include necessary SDK files.
```php
supports[] = 'one-time';
$this->supports[] = 'recurring';
$this->supports[] = 'fees';
$this->supports[] = 'trial';
if ( $this->test_mode ) {
$this->api_login_id = isset( $rcp_options['authorize_test_api_login'] ) ? sanitize_text_field( $rcp_options['authorize_test_api_login'] ) : '';
$this->transaction_key = isset( $rcp_options['authorize_test_txn_key'] ) ? sanitize_text_field( $rcp_options['authorize_test_txn_key'] ) : '';
$this->transaction_signature = isset( $rcp_options['authorize_test_signature_key'] ) ? sanitize_text_field( $rcp_options['authorize_test_signature_key'] ) : '';
} else {
$this->api_login_id = isset( $rcp_options['authorize_api_login'] ) ? sanitize_text_field( $rcp_options['authorize_api_login'] ) : '';
$this->transaction_key = isset( $rcp_options['authorize_txn_key'] ) ? sanitize_text_field( $rcp_options['authorize_txn_key'] ) : '';
$this->transaction_signature = isset( $rcp_options['authorize_signature_key'] ) ? sanitize_text_field( $rcp_options['authorize_signature_key'] ) : '';
}
require_once RCP_ANET_PATH . 'vendor/autoload.php';
}
```
--------------------------------
### Example JSON Event Response
Source: https://docs.nexcess.com/software/the-events-calendar/event-tickets-rest-api
A truncated example of the JSON structure returned by the events endpoint.
```json
{
"events": [
{
"id": 1762,
"global_id": "demo.theeventscalendar.com?id=1762",
"author": "2",
"status": "publish",
"date": "2022-12-01 12:36:40",
"url": "https://demo.theeventscalendar.com/event/hosted-dinner-with-chef-monica-geller/",
"rest_url": "https://demo.theeventscalendar.com/wp-json/tribe/events/v1/events/1762",
"title": "Hosted Dinner with Chef Monica Geller",
"description": "Join Chef Monica Geller for a Hosted Dinner!
",
"all_day": false,
"start_date": "2017-09-21 08:00:00",
"end_date": "2017-09-21 17:00:00",
"timezone": "UTC+0",
"cost": "$5",
"categories": [...],
"tags": [...],
"venue": {...},
"organizer": [...]
}
],
"rest_url": "...",
"total": 1,
"total_pages": 1
}
```
--------------------------------
### Configure Security Headers
Source: https://docs.nexcess.com/software/kadence/solid/solid-security/security-headers
Example configuration for setting security headers in a Solid application environment.
```javascript
v2HO6hPvmcep2svYj5f5r5d/Jrz6LouKi5d/Javr6mnO7ei736+Pa/HjJ6sTU4eWnHKS7O0v8nf7p3pa3/FzH/L2f9edPr/7nJjtQUL0Gp/9ovdbqYwXbcEE/8aLi/kn5DLub5+xaQY1jk42q7i9VZcx4c8fzT4H/Ser6W8+KCnn8Zg/007T/5863/9wxV6/8jQyZOOq8uY/ydZvyftJ7Xaf6fvE12pSFgCBgChsBBOc0OQ+V4Y1stzPjdx4awH3bB4QqBE4dSXNAe/eJHx+nbfPF1sBINgfcPgQsnOw5O0nF44sK9kJ9OBpW42i2BR7zO+/yDSj9dXQ+u3EllnKd5/mmuPemAP02Z57n2MjDVNlr/n7SnTzZOT4Ppaa61/n+z+J90VJxnTr/p/j9pm+w6Q8AQMAQMgYP27Amn4UHqk6PIiPh2i9uO/jX3yz0oPOyoOw/e6b9eXzI4HR7bcCGd7tXEC330a/x6zeOhke7aZC+sb7Mk30Gdky5JlJ+M5UE2w7Gs0inbe3r8T/kAu9wQeOMIXALZ8ebaoFPSX0oSdIf/6Zurhz3JEDAEDAFDwBAwBAwBQ8AQeBcQOMiF6JnBR5AdfKWmt7viSMJDrzqMRD+b02N/fY9KWH3e/vGJiB0IlRRNfhhvy17rw/uX1surW4Lg2Yk3cS+hEUeXD/eWv5soIF5tv5yEBXRxJ0EcZT8dRFCdF0m73xB4MwhcW7IjmUn1FxNdQFLcKnK2xfLNQH71n7L7Y3X1q2o1NAQMAUPAEDAEDAFDwBB4ywg4czi+/U5WKbxerf2G8+HaiLfcpEMfn9BzHKzs8MkWn+o4iuzYJZGSCKJEqYcpO3zMLl/ZkXhCUr/t9vN+e+swEuuq9qTV631A4J0gO2LKmybN+8tkdN/1QXHyH6t3HQlrnyFyCBgChoAhYAgYAobASRE4mbPsNOErF23MH9SSsxEHh7V1rzM2WXfhtSVZ2XEQ0eHX8GRYHtYzZ2vT/tKSbYLEd8lklapb/NyNMW3dviKuH5F10rFu110fBK4t2aEQJ0/lvWTH9emAN1PTg35YDn6y4ugvsEcz82+m5vYUQ8AQMAQMAUPAEDAEDIF3FYHDFNlvKnTiYoiB5N45KsjEJxAud699MWEuyWTHXoWHH2zz7pEdqsYxp/m7tdZcE7Jjr7GeGIaJWDnHlrq+0Rg5nyt9E4zwVR4QCUR8CmNHUsEn1T8sOB5RqLB5sYX+yyM6QJL/alzisWSSQv6+w32Vh4LVzRAwBAwBQ8AQMAQMgbeGgL9JvOxQ86NCKfzN6jFOwAP3tCevf3ILD6rNLonAHxeDxt5SEjVNfnpS/Xfbd3Sb/Hwkvo2l9sDuZt8d0+eRKomn62cHlXkxrTz70D3m+Ul46El5l53g9uztsDvPgsAbJztc/FpMj/LckbQ0lT7tlzgdtix4k4pbeevE4n6nnPKoDTdO+W6b75wxz3fe52/KAt+RmFbOZWVKkVS3ILzdye1NWIeaeys+0e1U/koDO81WrUwGsjNNspSa5pEdLtlSfFmLcY/2lYKZluaa46ikPZB6/aLP2XeS7lnG4xu85+Q/Wm+wUvYoQ8AQMAQMAUPAEDAE3jkEEmeQHEQFHLZX328jnASWgwzu5D25//1BhEfcWap72vhW2H/iwfU/SX0u+5pkFUe83kkbdf/P5PqrMb/D/t/ftx9m3Kt7VJOw6mub/2qgSopvYDl8fBvA76eD+vEgWyhhM+mzvedfls10cLm+zabPTk3Vlnrt8W2ny+41K//NIfDGyY6trS1ZW1uVjY0NKSwswobGiN6lK/yVZT8T6f1b/39lZV02NrclPS1FcnODGO3eRNR3NLotkdUN4VsJBQOSnp7qdAxv4hWDGFhZWYZM2JaMjAzJCeQweS5z8h7fKp2wCm2akh0727JNHecWwT6aIsFAtmRnpsnG+ppQUQkEQ26y7xJELIKbaxuyrt+npUsgN1dSYZe8zNNJIUT+YsmHV4HgOR4VHUce4eYWV/e/y1pgT1Ibu8YQMAQMAUPAEDAEDIGrjsDe/XRi55RQVPu79b2OxuTzSrzdvL/X3C3RkQvev1y58b2mOi8PVmzHCQt1fjplsnenV7Lufb3vPUM/QZj436sDMFmOnFxDdajG9LkpaXFnoU+OJJfjl7tXYb7rLIyX7r6NH4Prn9yylxaI19k5DPc6HL09td8uD7fEy9+56iY27jiOkxKJQxu89idQ8f7y67ir53a2grZXv9Gy9Dngw+f6r1QlOdgzL2O7bfHf7KwsyczMTOycd+uZjFNidLhP48yRIzbcHjwmyytL2G0xycoKSHYgsKum8PriICIqqfmn+jOBoxtl8aJXVlZkG5sti/boO0WdwF7tPEewvd4ZBN442bG4uCDjExOyMD8v9+7dkwCkgJtkuwuSP8iT/xs3UPloaHhcFhaWuS9TGuprJAuDJuW2pLsuX9NiaLFCfweER7Iy5wW8oWdkhqa1twGlWCOGR7ogTt/NFYb66tiIjI8MyhTMxM1RAOe2ozUOSlRKVdN2Ls78eHBzkmhFJz86Vphu3JAx2aVTKtQts56amZHoCYzyyBKeA+gHCoKqmGsKo0Kkierp7IEQ2XF0U29zcPKmqqJQCyCYlFGJsZDejmxKZm5XJ8WH6aEnWotQ7mM91pVJbUSzrK4uQEjMyhV22thGVtOygFJRWSG11JWRIOvbAttsPxzajMgrGSnakQ8q0NDVIAFIqsjAvw+z/p8D3g4cfSGF+LnXbhMSJSF//MPXGFe0kPClSU1srRYWFEGHZ2CNb2Bgr8vLFU4iSLSmrapSaOvoL57WOrRT0+angoP3s6WaOchz749LTCnnv/coQb754V8bVG/S52i5qD6ysrFL/h5ITzAG7hML9pPTK25iN9szTIXCJZIc3rJSB1PASNbQ1xGOWhWIYA3qOReBPX/wBsiKT7zUExct/q6yuvnXSbxJCEWMx8xUKmZnZ0tXdJxMTM0yKDGlra4LJzJQsWOIMSA1lj5++6pf1nQxpbWmSPBbFrAy+S/fKdOtQFIUDqgWVLumQT4dp9J6Xxmd8t0kYDNdoXdJgojMyWViZ7crqbvKdEi5p3KPP1wVym8Ukqszyxqa8evWKazadYqCttdVbuOITTBerDa7Z4lr+dPlGAtnIppjMDh/eKhNLgZVNg6XNglalRhLlmRt8F42pFC6V+mpbqDMTMrpFfairxtHpBM2krqrM0IVwkzZqmbrIZKbGJDNNySKRJy/7ZH4lykJXJvWVxbDna7IN85zOD4QqbLZdmVtwRxsyzsI2PTklwfywtEN2UHOujzrWeYfFNYNFb21zS/p7uuVVx0v59NPfuR8qpxChHYr1trYrLpHLADNlbr3wHp+/UXmcYkB9qbPLxwJZotdpW1w/0YYMMNG2aLu0Hfq9YqcKFMXf9RefaX9rf2nb12GXNYeLPk3zw6j0bj0ZXk93t7zs6JBPP/tM8ll8s2B19ftN+kf7RuMRveszKet0E8quNgQMAUPAEDAEDAFD4N1CQF38XqCJ7gF1rzyFSnt5eZU9Z4pM42xchLgoKC
```
--------------------------------
### Generate test demonstration page
Source: https://docs.nexcess.com/software/give/give-cli
Generates a page containing all GiveWP shortcodes.
```bash
wp give test-demonstration-page --preview=true
```
--------------------------------
### Get bookable dates response structure
Source: https://docs.nexcess.com/software/kadence/iconic/delivery-slots/delivery-slots-rest-api
Sample JSON response returned by the GET /iconic_wds/v1/get_bookable_dates/ endpoint.
```json
{
"success":true,
"shipping_methods":{
"free_shipping:2":"Free shipping",
"flat_rate:7":"Flat rate - Express",
"local_pickup:8":"Local pickup",
},
"dates":{
"free_shipping:2":[
{
"formatted":"Fri, 4th Mar",
"header_formatted":"Mar 4",
"admin_formatted":"04/03/2022",
"timestamp":1646409206,
"ymd":"20220304",
"weekday_number":"5",
"weekday":"Fri",
"same_day":false,
"next_day":false
},
{
"formatted":"Sat, 5th Mar",
"header_formatted":"Mar 5",
"admin_formatted":"05/03/2022",
"timestamp":1646495606,
"ymd":"20220305",
"weekday_number":"6",
"weekday":"Sat",
"same_day":false,
"next_day":false
},
}
"flat_rate:7":[
{
"formatted":"Fri, 4th Mar",
"header_formatted":"Mar 4",
"admin_formatted":"04/03/2022",
"timestamp":1646409206,
"ymd":"20220304",
"weekday_number":"5",
"weekday":"Fri",
"same_day":false,
"next_day":false
},
{
"formatted":"Sat, 5th Mar",
"header_formatted":"Mar 5",
"admin_formatted":"05/03/2022",
"timestamp":1646495606,
"ymd":"20220305",
"weekday_number":"6",
"weekday":"Sat",
"same_day":false,
"next_day":false
}
}
}
```
--------------------------------
### Example Serialized Attendee Data
Source: https://docs.nexcess.com/software/the-events-calendar/customize-zaps
An example of how attendee information is stored in the wp_postmeta table as a serialized array.
```text
a:3:{s:10:"first-name";s:4:"John";s:9:"last-name";s:3:"Doe";s:13:"email-address";s:18:"john.doe@email.com";}
```
--------------------------------
### Hooking into the Archive Loop
Source: https://docs.nexcess.com/software/give/theming-give-archive-page
Use this example in your theme's functions.php file to inject content before the archive loop begins.
```php
function my_custom_archive_content() {
echo 'This content appears before the loop!
';
}
add_action( 'my-give-before-archive-loop', 'my_custom_archive_content' );
```
--------------------------------
### Add a user to a subscription level
Source: https://docs.nexcess.com/software/kadence/restrict-content-pro/rcp_add_user_to_subscription
Example demonstrating how to assign a subscription level with specific status, expiration, and discount code.
```php
$user_id = 123;
$args = array(
‘subscription_id’ => 3,
‘status’ => ‘active’,
‘expiration’ => date( ‘Y-m-d 23:59:59’, strtotime( ‘+1 month’, current_time( ‘timestamp’ ) ) ),
‘discount_code’ => ‘free_subscription’
);
rcp_add_user_to_subscription( $user_id, $args );
```
--------------------------------
### iCalendar webcal protocol link example
Source: https://docs.nexcess.com/software/the-events-calendar/troubleshoot-subscribe-export
Example of an anchor tag using the webcal protocol to trigger calendar application handling.
```html
webcal://demo.theeventscalendar.com/?post_type=tribe_events&ical=1&eventDisplay=list
```
--------------------------------
### View Database Schema
Source: https://docs.nexcess.com/software/kadence/solid/solid-security/wp-cli-integration
Creates the database schema for Solid Security.
```bash
wp itsec schema
```
--------------------------------
### Subscription Query Response Example
Source: https://docs.nexcess.com/software/give/give-api-reference
A sample JSON response showing the structure of subscription info and associated payment records.
```json
{
"subscriptions": [
{
"info": {
"subs_db": {
"table_name": "wp_give_subscriptions",
"primary_key": "id",
"version": "1.1",
"min_index_length": 191
},
"id": "31",
"donor_id": "71",
"period": "week",
"frequency": "1",
"initial_amount": "13.000000",
"recurring_amount": "13.000000",
"bill_times": "0",
"transaction_id": "40019834114",
"parent_payment_id": "1328",
"form_id": "1325",
"created": "2018-10-09 09:52:29",
"expiration": "2018-11-06 23:59:59",
"status": "active",
"profile_id": "5371285",
"gateway": "authorize",
"donor": {
"id": "71",
"purchase_count": "5",
"purchase_value": "63.000000",
"email": "jink@recurrably.example",
"emails": {
"primary": "jink@recurrably.example"
},
"name": "Jimbo Franklin",
"date_created": "2018-10-09 15:48:24",
"payment_ids": "1328,1336,1360,1375",
"user_id": "15",
"notes": [],
"address": [],
"token": "",
"verify_key": "",
"verify_throttle": "0000-00-00 00:00:00"
},
"notes": ""
},
"payments": [
{
"id": 1375,
"amount": "13.000000",
"date": "October 30, 2018",
"status": "renewal"
},
{
"id": 1360,
"amount": "13.000000",
"date": "October 23, 2018",
"status": "renewal"
},
{
"id": 1336,
"amount": "13.000000",
"date": "October 16, 2018",
"status": "renewal"
}
]
},
}
```
--------------------------------
### Salesforce Setup URL
Source: https://docs.nexcess.com/software/give/sending-custom-data-to-salesforce
The URL path to access the Fields and Relationships manager in the Salesforce Lightning interface.
```text
{your-salesforce-domain}.lightning.force.com/lightning/setup/ObjectManager/Opportunity/FieldsAndRelationships/view
```
--------------------------------
### Display Ticket Sale Start Time
Source: https://docs.nexcess.com/software/the-events-calendar/customize-event-tickets
Enables the display of the ticket sale start time in the unavailability message using the tribe_tickets_unvailable_message_time filter.
```php
add_filter( 'tribe_tickets_unvailable_message_time', '__return_true' );
```
--------------------------------
### PayPal Express Webhook Processing Example
Source: https://docs.nexcess.com/software/kadence/restrict-content-pro/payment-gateway-api
A comprehensive example of processing PayPal IPN webhooks, including data validation, membership retrieval, and payment recording.
```php
get_id() > 0 ) {
rcp_log( 'Exiting PayPal Express IPN - membership ID not found.', true );
die( 'no membership found' );
}
rcp_log( sprintf( 'Processing IPN for membership #%d.', $membership->get_id() ) );
if ( empty( $user_id ) ) {
$user_id = $membership->get_customer()->get_user_id();
}
$member = new RCP_Member( $membership->get_customer()->get_user_id() ); // for backwards compatibility
$membership_level_id = $membership->get_object_id();
if( ! $membership_level_id ) {
rcp_log( 'Exiting PayPal Express IPN - no membership level ID.', true );
die( 'no membership level found' );
}
if( ! $membership_level = rcp_get_subscription_details( $membership_level_id ) ) {
rcp_log( 'Exiting PayPal Express IPN - no membership level found.', true );
die( 'no membership level found' );
}
$amount = isset( $posted['mc_gross'] ) ? number_format( (float) $posted['mc_gross'], 2, '.', '' ) : false;
$membership_gateway = $membership->get_gateway();
// setup the payment info in an array for storage
$payment_data = array(
'subscription' => $membership_level->name,
'payment_type' => $posted['txn_type'],
'subscription_key' => $membership->get_subscription_key(),
'user_id' => $user_id,
'customer_id' => $membership->get_customer()->get_id(),
'membership_id' => $membership->get_id(),
'status' => 'complete',
'gateway' => ! empty( $membership_gateway ) && 'paypal_pro' == $membership_gateway ? 'paypal_pro' : 'paypal_express'
);
if ( false !== $amount ) {
$payment_data['amount'] = $amount;
}
```
--------------------------------
### Configure Security Headers in Solid
Source: https://docs.nexcess.com/software/kadence/solid/solid-security/security-headers
Example of setting security headers within a Solid application configuration.
```typescript
import { defineConfig } from "solid-start";
export default defineConfig({
middleware: "./src/middleware.ts",
});
```
--------------------------------
### Change Get Tickets Link Text
Source: https://docs.nexcess.com/software/the-events-calendar/customize-event-tickets
Use the gettext_with_context filter to rename the 'Get Tickets' link text globally. Ensure the filter parameter count matches the function signature.
```php
/**
* Change the Get Tickets on List View and Single Events
*
* @param string $translation The translated text.
* @param string $text The text to translate.
* @param string $context The option context string.
* @param string $domain The domain slug of the translated text.
*
* @return string The translated text or the custom text.
*/
add_filter( 'gettext_with_context', 'tribe_change_get_tickets', 20, 4 );
function tribe_change_get_tickets( string $translation, string $text, string $context, string $domain ): string {
if (
$domain != 'default'
&& ! str_starts_with( $domain, 'event-' )
) {
return $translation;
}
$ticket_text = [
// Get Tickets on List View
'Get %s' => 'Register Now!',
// Get Tickets Form - Single View
'Get Tickets' => 'Register Now!',
];
// If we don't have replacement text, bail.
if ( empty( $ticket_text[ $text ] ) ) {
return $translation;
}
return $ticket_text[ $text ];
}
```
--------------------------------
### Show licensing status via WP-CLI
Source: https://docs.nexcess.com/software/kadence/solid/central/manage-sites
Displays the current licensing status for SolidWP products installed on the site.
```bash
wp ithemes-licensing show
```
--------------------------------
### Shortcode Usage Examples
Source: https://docs.nexcess.com/software/learndash/multiple-instructors-shortcode
Various configurations for the [all_instructors] shortcode to control display elements, image size, and visibility.
```text
[all_instructors]
```
```text
[all_instructors display_img=0]
```
```text
[all_instructors size=32]
```
```text
[all_instructors display_name=0]
```
```text
[all_instructors visible=3]
```
```text
[all_instructors exclude_author=1]
```
```text
[all_instructors course_id=36]
```
--------------------------------
### Get memberships
Source: https://docs.nexcess.com/software/kadence/restrict-content-pro/rest-api-memberships-route
Retrieve a list of memberships from the database.
```APIDOC
## GET /memberships
### Description
Retrieve a list of memberships from the Restrict Content Pro database.
```
--------------------------------
### GET /give-api/v1/donors/
Source: https://docs.nexcess.com/software/give/give-api-reference
Retrieves a list of donors from the database.
```APIDOC
## GET /give-api/v1/donors/
### Description
Retrieves a list of donors who have donated using the forms on your website.
### Method
GET
### Endpoint
/give-api/v1/donors/
### Parameters
#### Query Parameters
- **key** (string) - Required - API key for authentication
- **token** (string) - Required - API token for authentication
- **number** (integer) - Optional - Number of donors to return
- **donor** (string) - Optional - Identifier (ID or email) to retrieve a specific donor
### Response
#### Success Response (200)
- **donors** (array) - List of donor objects containing info and stats
- **request_speed** (float) - Time taken for the request
#### Response Example
{
"donors": [
{
"info": {
"id": "",
"user_id": "",
"username": "",
"display_name": "",
"customer_id": "3",
"first_name": "Jane",
"last_name": "Smith",
"email": "jsmith@gmail.com"
},
"stats": {
"total_purchases": "4",
"total_spent": "120.000000"
}
}
],
"request_speed": 0.0060648918151855
}
```
--------------------------------
### Retrieve All Events
Source: https://docs.nexcess.com/software/the-events-calendar/event-tickets-rest-api
A GET request to fetch all events from the API.
```http
GET https://demo.theeventscalendar.com/wp-json/tribe/events/v1/events
```
--------------------------------
### Override Divi Post Navigation with Event Start Date
Source: https://docs.nexcess.com/software/the-events-calendar/divi-theme
Hooks into WordPress navigation filters to join the event start date meta and adjust the WHERE and ORDER BY clauses for adjacent event queries. Add this to your child theme's functions.php file or a code snippets plugin.
```php
add_filter( 'get_previous_post_join', 'my_tec_adjacent_events_join', 10, 2 );
add_filter( 'get_next_post_join', 'my_tec_adjacent_events_join', 10, 2 );
/**
* Join event start date meta for adjacent post queries on events.
*/
function my_tec_adjacent_events_join( $join, $in_same_term ) {
if ( ! is_singular( 'tribe_events' ) ) {
return $join;
}
global $wpdb;
$meta_join = " LEFT JOIN {$wpdb->postmeta} AS tec_mt ON (tec_mt.post_id = p.ID AND tec_mt.meta_key = '_EventStartDate') ";
if ( strpos( $join, "tec_mt.meta_key = '_EventStartDate'" ) !== false ) {
return $join;
}
return $join . $meta_join;
}
add_filter( 'get_previous_post_where', 'my_tec_adjacent_events_where_previous', 10, 2 );
/**
* Adjust WHERE for previous event based on event start date.
*/
function my_tec_adjacent_events_where_previous( $where, $in_same_term ) {
if ( ! is_singular( 'tribe_events' ) ) {
return $where;
}
$event_date = get_post_meta( get_the_ID(), '_EventStartDate', true );
if ( empty( $event_date ) ) {
return $where;
}
$where = preg_replace(
"/p.post_dates*s*'[^']*'/",
"tec_mt.meta_value > '{$event_date}'",
$where
);
if ( strpos( $where, 'tec_mt.meta_value IS NOT NULL' ) === false ) {
$where .= " AND tec_mt.meta_value IS NOT NULL";
}
return $where;
}
add_filter( 'get_previous_post_sort', 'my_tec_adjacent_events_sort_previous' );
/**
* Sort previous event by event start date DESC.
*/
function my_tec_adjacent_events_sort_previous( $sort ) {
if ( ! is_singular( 'tribe_events' ) ) {
return $sort;
}
return ' ORDER BY tec_mt.meta_value DESC LIMIT 1';
}
add_filter( 'get_next_post_sort', 'my_tec_adjacent_events_sort_next' );
/**
* Sort next event by event start date ASC.
*/
function my_tec_adjacent_events_sort_next( $sort ) {
if ( ! is_singular( 'tribe_events' ) ) {
return $sort;
}
return ' ORDER BY tec_mt.meta_value ASC LIMIT 1';
}
```
--------------------------------
### itsec_install_schema Action Hook
Source: https://docs.nexcess.com/software/kadence/solid/solid-security/solid-security-action-hooks
Fires when the DB schema is installed or updated.
```php
do_action( 'itsec_install_schema', $wp_error );
```
--------------------------------
### Insert Quickview button via PHP
Source: https://docs.nexcess.com/software/kadence/iconic/quickview/manually-insert-the-quickview-button
Use these PHP snippets to display the button within product loops or custom theme templates.
```php
```
```php
display_button( $product_id ); ?>
```
--------------------------------
### Configure Security Headers in SolidStart
Source: https://docs.nexcess.com/software/kadence/solid/solid-security/security-headers
Example of setting security headers within a SolidStart application configuration.
```typescript
import { defineConfig } from "@solidjs/start/config";
export default defineConfig({
middleware: "./src/middleware.ts",
server: {
headers: {
"Content-Security-Policy": "default-src 'self';",
"X-Content-Type-Options": "nosniff",
"X-Frame-Options": "DENY",
"X-XSS-Protection": "1; mode=block"
}
}
});
```
--------------------------------
### GET /wp-json/tribe/tickets/v1/tickets
Source: https://docs.nexcess.com/software/the-events-calendar/event-tickets-rest-api
Retrieves a list of tickets, with optional filtering capabilities.
```APIDOC
## GET /wp-json/tribe/tickets/v1/tickets
### Description
Returns a collection of tickets. Filtering can be applied to narrow down results.
### Method
GET
### Endpoint
/wp-json/tribe/tickets/v1/tickets
### Parameters
#### Query Parameters
- **attendee_information_available** (boolean) - Optional - Filter tickets by whether individual attendee collection is enabled.
```
--------------------------------
### GET /wp-json/tribe/events/v1/events/{id}
Source: https://docs.nexcess.com/software/the-events-calendar/event-tickets-rest-api
Retrieves details for a specific event by its ID.
```APIDOC
## GET /wp-json/tribe/events/v1/events/{id}
### Description
Returns the full details of a single event identified by its post ID.
### Method
GET
### Endpoint
/wp-json/tribe/events/v1/events/{id}
### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique post ID of the event.
```
--------------------------------
### Get specific membership
Source: https://docs.nexcess.com/software/kadence/restrict-content-pro/rest-api-memberships-route
Retrieve details for a specific membership by its ID.
```APIDOC
## GET /memberships/{id}
### Description
Retrieve details for a specific membership.
```
--------------------------------
### Querying upcoming events
Source: https://docs.nexcess.com/software/the-events-calendar/query-events
Retrieves events starting on or after a specific date.
```php
// Retrieve any upcoming events starting January 1st, 2015, or later
$events = tribe_get_events( [
'start_date' => '2015-01-01',
] );
```
--------------------------------
### Basic ms-membership-signup Shortcode Usage
Source: https://docs.nexcess.com/software/learndash/memberdash/ms-membership-signup
Displays the default membership signup list using the standard shortcode syntax.
```shortcode
[ms-membership-signup]
```
--------------------------------
### GET /wp-json/tribe/tickets/v1/attendees/
Source: https://docs.nexcess.com/software/the-events-calendar/public-attendee-list
Retrieves all attendee registrations that are publicly available for all events on the site.
```APIDOC
## GET /wp-json/tribe/tickets/v1/attendees/
### Description
Retrieves a list of all publicly available attendee registrations across all events on the site.
### Method
GET
### Endpoint
[yoursite.com]/wp-json/tribe/tickets/v1/attendees/
```
--------------------------------
### Compress files via command line
Source: https://docs.nexcess.com/software/kadence/fix-wordpress-incompatible-archive-error
Use this command in the terminal to create a compatible zip file, replacing 'custom_plugin' with your specific folder name.
```bash
zip -vr custom-plugin.zip custom_plugin/
```
--------------------------------
### GET /wp-json/rcp/{version}/customers/{customer_id}
Source: https://docs.nexcess.com/software/kadence/restrict-content-pro/rest-api-customers-route
Retrieves details for a specific customer.
```APIDOC
## GET /wp-json/rcp/{version}/customers/{customer_id}
### Description
Retrieves information for a specific customer using their ID, email, or username.
### Method
GET
### Endpoint
/wp-json/rcp/{version}/customers/{customer_id}
### Parameters
#### Path Parameters
- **customer_id** (int) - Required - The customer ID to retrieve.
#### Query Parameters
- **id** (int) - Required - The customer ID to retrieve.
- **user_email** (string) - Required - The email address of the customer to retrieve.
- **user_login** (string) - Required - The username of the customer to retrieve.
```
--------------------------------
### Manually Output the Quickview Button
Source: https://docs.nexcess.com/software/kadence/iconic/quicktray/change-the-quickview-button-position
Insert this code directly into a template file to display the quickview button at a specific location.
```php
```