Documentation

static PBAPI::get_addon

Gets an add-on instance by slug. Add-ons are only available if they are active.

Arguments

1. string Add-on slug.

Return

1. POSTS_BRIDGE\Addon|null Add-on instance, if found, null otherwise.

Example

$addon = PBAPI::get_addon( 'dolibarr' );
if ( $addon && $addon->ping( 'Dolibarr' ) ) {
	$backend_endpoints = $addon->get_endpoints( 'Dolibarr', 'POST' );
}

static PBAPI::get_post_types

Gets the list of registered post types.

Return

1. string[] List of post type names.

Example

$post_types = PBAPI::get_post_types();
foreach ( $post_types as $post_type ) {
	echo $post_type;
}

static PBAPI::get_custom_post_types

Gets the list of registered custom post types configurations.

Return

1. array[] Custom post types registration data.

Example

$cpts = PBAPI::get_custom_post_types();
foreach ( $cpts as $name => $cpt_args ) {
	if ( ! $cpt_args['public'] ) {
        # do something
    }
}

static PBAPI::get_custom_post_type

Gets a custom post type registration data by name

Return

1. array|null Registration data or null

Example

$event_data = PBAPI::get_custom_post_type( 'event' );
if ( $event_data ) {
	$event_data['public'] = true;
    PBAPI::register_custom_post_type( 'event', $event_data );
}

static PBAPI::register_custom_post_type

Registers a new custom post type in WordPress.

Arguments

1. string Post type name.
2. array Post type registration parameters.

Return

1. boolean Registration result.

Example

$success = PBAPI::register_custom_post_type(
    'event',
    array(
        'label'          => 'Events',
        'singular_label' => 'Event',
        'public'         => true,
        'show_in_rest'   => true,
        'rest_base'      => 'events',
    ),
);

if ( ! $success ) {
	# handle registration error
}

static PBAPI::unregister_custom_post_type

Unregisters a custom post type from WordPress. Only applies to the custom post types registered with Posts Bridge.

Return

1. boolean Unregistration result.

Example

$result = PBAPI::unregister_custom_post_type( 'event' );
if ( $result ) {
    # do something
}

static PBAPI::get_remote_cpts

Gets the list of bridged post type names.

Return

1. string[] List of bridged post type names.

Example

$rcpts = PBAPI::get_remote_cpts();
foreac ( $rcpts as $rcpt ) {
    echo $rcpt;
}

static FBAPI::get_bridge

Searches for a bridge by post type name.

Arguments

1. string Post type name.

Return

1. POSTS_BRIDGE\Post_Bridge|null Bridge object or null.

Example

$bridge = PBAPI::get_bridge( 'event' );
if ( $bridge ) {
	$events = $bridge->fetch_all();

    if ( is_wp_error( $response ) ) {
        # handle error
    }
}

static FBAPI::get_bridges

Returns the list of available bridges.

Return

1. POSTS_BRIDGE\Post_Bridge[] Array of bridge objects.

Example

$bridges = PBAPI::get_bridges();
foreach ( $bridges as $bridge ) {
	# do something
}

static FBAPI::get_addon_bridges

Returns the list of available bridges filtered by add-on slug.

Arguments

1. string Add-on slug.

Return

1. POSTS_BRIDGE\Post_Bridge[] Array of bridge objects.

Example

$bridges = PBAPI::get_addon_bridges( 'odoo' );
foreach ( $bridges as $bridge ) {
	if ( ! $bridge->is_valid ) {
        continue;
    }

    # do something
}

static FBAPI::save_bridge

Creates or updates the bridge data in the database.

Arguments

1. array Bridge data.
2. string Add-on slug.

Return

1. boolean Update result.

Example

$bridge_data = array(
    'post_type'     => 'event',
    'backend'       => 'Google Calendar',
    'endpoint'      => '/calendars/v3/calendar/[email protected]/events',
    'method'        => 'GET',
    'field_mappers' => array(
        array(
            'name'    => 'summary',
            'foreign' => 'post_title',
        ),       
        array(
            'name'    => 'description',
            'foreign' => 'post_excerpt',
        ),
        array(
            'name'    => 'start_date',
            'foreign' => 'start.date',
        ),
        array(
            'name'    => 'end_date',
            'foreign' => 'end.date',
        ),
    ),
    'tax_mappers' => array(),
);

$result = PBAPI::save_bridge( $bridge_data, 'gcalendar' );
if ( ! $result ) {
    # handle error
}

static FBAPI::delete_bridge

Remove the bridge from the database.

Arguments

1. string Bridge name.
2. string Add-on slug.

Return

1. boolean Update result.

Example

$result = PBAPI::delete_bridge( 'events', 'gcalendar' );
if ( $result ) {
    # do something
}

static PBAPI::get_backends

Returns the list of available backends.

Return

1. POSTS_BRIDGE\Http\Backend[] Array of backend objects.

Example

$backends = PBAPI::get_backends();
foreach ( $backends as $backend ) {
	if ( str_starts_with( $backend->base_url, 'http://' ) {
        $data = $backend->data();
        $data['base_url'] = str_replace( 'http://', 'https://', $data['base_url'] );
        PBAPI::save_backend( $data );
    }
}

static PBAPI::get_backend

Searches for a backend by name.

Arguments

1. string Backend name.

Return

1. POSTS_BRIDGE\Http\Backend|null Backend object or null.

Example

$backend = PBAPI::get_backend( 'Dolibarr' );
if ( $backend ) {
	$response = $backend->get( '/api/index.php/status' );
    if ( is_wp_error( $response ) ) {
         # handle error
    }
}

static PBAPI::save_backend

Creates or updates the backend data in the database.

Arguments

1. array Backend data.

Return

1. boolean Update result.

Example

$result = PBAPI::save_backend( array(
    'name'       => 'Odoo',
    'base_url'   => 'https://erp.example.coop',
    'headers'    => array(
        'Content-Type' => 'application/json',
    ),
    'credential' => 'John Doe RPC',
) );

static PBAPI::delete_backend

Removes the backend from the database.

Arguments

1. string Backend name.

Return

1. boolean Update result.

Example

$result = PBAPI::delete_backend( 'Odoo' );
if ( $result ) {
     # do something
}

static PBAPI::get_credentials

Returns the list of available HTTP credentials.

Return

1. POSTS_BRIDGE\Http\Credential[] Array of credential objects.

Example

$credentials = PBAPI::get_credentials();
foreach ( $credentials as $credential ) {
	if ( 'RPC' === $credential->schema ) {
        $rpc_credentials[] = $credential;
    }
}

static PBAPI::get_credential

Searches for a credential by name.

Arguments

1. string Credential name.

Return

1. POSTS_BRIDGE\Http\Credential|null Credential object or null.

$credential = PBAPI::get_credential( 'Google Console Client' );
if ( $credential ) {
	$authorization = $credential->authorization();
}

static PBAPI::save_credential

Creates or updates the credential data in the database.

Arguments

1. array Credential data.

Return

1. boolean Update result.

Example

$result = PBAPI::save_credential( array(
    'name'          => 'Airtable Token',
    'schema'        => 'Bearer',
    'access_token'  => 'abcd123456789',
) );

static PBAPI::delete_credential

Removes the credential from the database.

Arguments

1. string Credential name.

Return

1. boolean Update result.

Example

$result = PBAPI::delete_credential( 'Airtable Token' );
if ( $result ) {
    # do something
}