Add a custom class to directory buttons to help them better match other buttons on the site.

Usage

add_filter( 'wpbdp_button_class', 'add_bd_button_class' );

Parameters

• $class (string) The classes to add. Defaults to ‘button'.

Examples

add_filter( 'wpbdp_button_class', 'add_bd_button_class' );
function add_bd_button_class( $class ) {
  $class .= ' ast-button';
  return $class;
}

Change Log

Added in version 6.3.4

This hook allows directory emails to be sent from an alternative email instead of the admin email.

Usage

add_filter( 'wpbdp_email_from', 'change_admin_email' );

Parameters

• $email (string)

Examples

add_filter( 'wpbdp_email_from', 'change_admin_email' );
function change_admin_email_bloginfo( $email) {
	return 'email@example.com';
}

Change Log

Added in version 5.13

Force the user dropdown to autocomplete or not. By default, it will show the ajax list for users in the listing edit page.

Usage

add_filter( 'wpbdp_admin_listing_owner_mode', 'wpbdp_admin_listing_owner_mode' );

Parameters

The values for the return string are either:

• inline for inline (show all users)
• ajax for ajax select mode (type to search for a user)

Examples

add_filter( 'wpbdp_admin_listing_owner_mode', 'wpbdp_admin_listing_owner_mode' );
function wpbdp_admin_listing_owner_mode( $mode ) {
	return 'inline';
}

Change Log

Added in version 5.14

Automatically replace words throughout the front-end of your directory.

Usage

add_filter( 'wpbdp_custom_strings', 'bd_replace_strings' );

Parameters

$strings (array) A list of strings to replace

Examples

function bd_replace_strings( $strings ) {
    $strings['Region']  = 'Location';
    $strings['Regions'] = 'Locations';
    return $strings;
}
add_filter( 'wpbdp_custom_strings', 'bd_replace_strings' );

Change Log

Added in version 5.13

This hook can be used to include or edit Schema.org items for each form field; here's an example to illustrate field filtering.

Usage

add_action( 'wpbdp_field_schema_org', 'wpbdp_schema_org_fields' );

Parameters

• $schema (array)
• $field (object)
• $post_id (string)

Examples

add_filter('wpbdp_field_schema_org', 'wpbdp_schema_org_fields', 10, 3 );
function wpbdp_schema_org_fields( $schema, $field, $post_id ) {
    // Using field ID
    if ( 10 == $field->get_id() ) { // Replace the value 10 with the value of the field if you need
        $schema['legalName'] = $field->plain_value( $post_id );
    }

    // Using field Shortname
    if ( 'business_fax' === $field->get_shortname() ) { // Replace the business_fax value with the value of the Shortname you need
        $schema['faxNumber'] = $field->plain_value( $post_id );
    }


    return $schema;
}

This hook can be used to always mark paid listings as published, regardless of default status.

Usage

add_filter( 'wpbdp_paid_listing_status', 'mark_listing_as_published' );

Parameters

• $new_status (string)
• $payment (array)

Examples

add_filter( 'wpbdp_paid_listing_status', 'mark_listing_as_published' );
function bd_mark_paid_listing_as_published( $new_status, $payment ) {
    $new_status = 'publish';
    return $new_status;
}

Change Log

Added in version 3.5.4

This hook can be used to get the list of pages the plugin is used on.

Usage

add_filter( 'wpbdp_get_page_ids', 'my_custom_function' );

Parameters

• $page_ids (array)

Examples

add_filter( 'wpbdp_get_page_ids', 'add_another_bd_page', 10, 2 );
function add_another_bd_page( $page_ids ) {
    $page_ids[] = '25'; // add a new page id.
    return $page_ids;
}

Change Log

Added in version 5.9

This hook can be used to prevent Business Directory from controlling the page template.

Usage

add_filter( 'wpbdp_allow_template_override' );

Parameters

• $allow (bool) Defaults to TRUE

Examples

add_filter( 'wpbdp_allow_template_override', '__return_false' );

Change Log

Added in version 5.9

This hook can be used to override template file.

Usage

add_filter( 'wpbdp_use_template_[template id]', 'bd_replace_template' );

Parameters

• $path (string) Path of the file to be used to replace the template

Examples

add_filter( 'wpbdp_use_template_listings', 'bd_replace_template' );
function bd_replace_template( $path ) {
    $path = 'place here the path to the new template file';
    return $path;
}

Change Log

Added in version 5.9.2

This hook can be used to show the first page when it's skipped (it's automatically skipped if there's only 1 category and 1 plan to choose from). If someone wants the plan to show first, use this hook

Usage

add_filter( 'wpbdp_skip_page_1' );

Parameters

• $skip (bool)

Examples

add_filter( 'wpbdp_skip_page_1', '__return_false' );