This comprehensive documentation provides a step-by-step guide for installing, activating, configuring data sync, initiating sync, managing listings, and troubleshooting WP AgentBox Sync. If you have further questions or encounter issues not covered here, feel free to reach out to our support team.
Before installing WP AgentBox Sync, ensure you have obtained the API Key and Client ID from AgentBox.
Follow these steps:
Ensure your server meets the following requirements:
Follow these steps to install WP AgentBox Sync:
To unlock WP AgentBox Sync’s full features, you need to activate your license.
Follow these steps:
After activation, you can access the plugin’s dashboard by following these steps:
After activating your license, you can customize the data (listings) that WP AgentBox Sync brings from AgentBox to your WordPress site. Follow these steps:
When you are ready to bring property listings matching your criteria from AgentBox to WordPress, follow these steps:
After the sync is complete, you can view and manage your property listings. Follow these steps:
You have the flexibility to edit, add, or remove details about the synced listings. However, keep in mind the following:
By following these steps, you can have better control over which listings are updated during the sync process.
If you encounter issues during installation or activation, reach out to us our support for assistance.
If you face problems with license activation, double-check the entered details and ensure your server has internet access. If issues persist, contact our support.
If you experience difficulties with the sync process or encounter discrepancies in your listings, refer to our troubleshooting guide in the support documentation. If the issue persists, contact our support team for further assistance.
WP AgentBox Sync provides a comprehensive solution for managing listings retrieved from AgentBox within your WordPress site. To ensure flexibility and efficiency, the plugin comes with a set of metaboxes to store essential listing data, using the default core WordPress meta box functionality.
Upon installation, WP AgentBox Sync enables essential fields by default, providing a seamless integration with AgentBox data. However, we understand that each user’s needs may vary, and not everyone requires all the available fields. To address this, we have implemented a customisable approach that allows users to tailor their listing fields according to their specific requirements.
To add a new field, use the add_filter function provided by WordPress. This filter creates a user interface field that is visible when editing a listing. Below is an example of how to use the filter:
// Example of adding a new field
function custom_listing_field($fields) {
$fields['custom_field'] = array(
'label' => __('Custom Field', 'your-plugin-text-domain'),
'type' => 'text',
// Add any other necessary parameters
);
return $fields;
}
add_filter('your_plugin_listing_fields', 'custom_listing_field');Replace 'your_plugin_listing_fields' with the actual filter hook used by your plugin.
After adding a new field, you need to whitelist its name to allow the meta value to be securely stored in the WordPress database. This is crucial for maintaining data integrity and security. Whitelisting can be done as follows:
// Example of whitelisting a field
function whitelist_custom_field($whitelist) {
$whitelist[] = 'custom_field';
return $whitelist;
}
add_filter('your_plugin_listing_whitelist', 'whitelist_custom_field');Lastly, use the add_filter function to map the AgentBox field reference to the newly created metabox. This step ensures a smooth integration between the external data source and your custom fields:
// Example of mapping AgentBox field reference
function map_agentbox_field($mapping) {
$mapping['custom_field'] = 'agentbox_field_reference';
return $mapping;
}
add_filter('your_plugin_agentbox_mapping', 'map_agentbox_field');Adjust the filter hooks and field names according to your actual implementation.
By following these steps, you can easily customise listing fields to suit your unique requirements while maintaining the security and integrity of your data in WordPress.
WP AgentBox Sync offers a flexible templating system, inspired by the approach taken by WooCommerce. By creating a folder named /templates under your theme directory, you can easily customise the display of listings.
/templates Folder:/templates./plugins/wp-agentbox-sync/templates directory in the plugin folder.WP AgentBox Sync seamlessly integrates with the default WordPress metabox, allowing you to leverage the power of standard WordPress functionality. To further customise the display of your listings, you can create custom post types that default to the WordPress structure.
get_post_meta().// Example of retrieving meta data for a listing
$listing_id = get_the_ID();
$custom_field_value = get_post_meta($listing_id, 'custom_field', true);This approach simplifies the process of working with listing data, providing you with the familiarity and ease of use associated with standard WordPress practices.
Feel free to customise templates based on your specific requirements. By placing your customized templates in the /templates folder, you can effortlessly enhance the visual presentation of your listings.
To create a custom template for the ‘listing’ post type in WP AgentBox Sync, follow these steps:
single-listing.php. <?php
/**
* Template Name: Single Listing
* Description: Custom template for the 'listing' post type.
*/
get_header();
?>get_post_meta() and other relevant functions to retrieve and display the necessary listing data. <?php
$listing_id = get_the_ID();
$custom_field_value = get_post_meta($listing_id, 'custom_field', true);
// Retrieve other listing data as needed
?> <div class="listing">
<h2><?php the_title(); ?></h2>
<p>Custom Field: <?php echo $custom_field_value; ?></p>
<!-- Add more HTML structure and listing details -->
</div> <?php get_footer(); ?>/templates folder.By following these steps, you can create a custom template for the ‘listing’ post type in WP AgentBox Sync, providing you with the flexibility to tailor the display of your listings according to your unique requirements.
Thank you for choosing WP AgentBox Sync!