What the WPResidence REST API, child theme, hooks and builders give a developer who standardizes client work on one real estate theme.
Last updated: September 28, 2026
By Cris Bean
If you’re deciding whether to standardize client work on WPResidence, the question is whether this real estate WordPress theme gives you room to extend, script and hand over sites. WPResidence has a REST API for properties, agents, agencies, developers and more, with read and write access (writes need JWT authentication), and a public Postman workspace to test it. You extend the theme through the included child theme, template overrides and action and filter hooks, without editing core files. The Custom Fields Builder adds property fields and search filters from the admin, with no code. WPResidence is an options-and-child-theme framework, not a headless developer SDK.
We build and sell WPResidence.
Yes. External apps can read and write property, agent, agency and developer records through the WPResidence REST API, and a public Postman workspace documents the requests so you can start scripting. The API has 17 route groups, from properties, agents and agencies to invoices, messages and saved searches. See the real estate API overview and the routes and endpoints guide.
The API is built around the records a real estate site runs on: properties, agents, agencies and developers (the development-company profiles), each with list, view, add, edit and delete routes. It also covers invoices, reviews, messages, favorites, saved searches, tour requests, notifications, user registration and the logged-in user's profile.
A portal can pull listings into a separate front end, a custom dashboard can write updates back, and another system can keep agents and listings in sync. Your listings stay in WordPress post types.
Import the Postman collection to see the documented requests, then script the jobs you need: creating properties, updating listings and running sync jobs. Write access needs JWT authentication: install the JWT Authentication for WP-API plugin and add a secret key to wp-config.php before create and update calls work. See authentication for API requests.
None of the safe ways to extend WPResidence touch its core files: the included child theme, template overrides, action and filter hooks, the Custom Fields Builder and Theme Options. Your work lives outside the parent theme, so updates don't overwrite it.
Safe ways to extend WPResidence:
WPResidence comes with a child theme, which is where all site-specific work belongs: custom CSS, template changes and small functions. It sits apart from the parent, so you can update the theme without losing your changes. Build one master child theme, clone it per project, and every build starts from the same tested base.
To change a template, copy that file from the theme into your child theme and edit the copy; WordPress uses your version and leaves the original untouched. Because you never edited core files, an update can't overwrite your work. After a major update, compare your overridden templates with the new versions.
For behavior changes beyond templates, the theme's action and filter hooks let you extend what it does without editing core logic. Check the changelog after each update for changes that affect your code.
Before you write PHP, check the Custom Fields Builder. It adds property fields from the WordPress admin in five types: short text, long text, number, date and dropdown. Define a field such as Energy Class or View Type, and it appears in the property submission form; add it to your search form in the search builder to use it as a filter. For most client sites, the first question is whether the Custom Fields Builder can do it.
The WPResidence help site covers the path from first install to API work, with video tutorials, a changelog for every release, the Postman workspace and private support tickets.
The help articles follow real project steps: installation, demo import, header and footer setup and each Theme Options panel, with screenshots. Troubleshooting articles cover common problems such as 500 errors, maps that don't show and image processing. They shorten debugging on edge cases, but you still need to read them.
The changelog lists new features, template changes and compatibility notes for each release, which helps when you update many client sites. Support runs through private tickets at care.wpestate.org, answered by our in-house team.
A direct license includes a year of updates and support. If you don't renew, the site keeps working; new updates and new tickets stop.
The workflow that holds up across many client sites: build one WPResidence starter, clone it per project, activate a license per live domain, and export your Theme Options so every new site starts from the same settings.
Import a demo, set up the child theme and Theme Options, and treat that install as your base. For each new client, clone it with Duplicator or All-in-One WP Migration; both rewrite URLs and keep serialized data valid. The Theme Options export and import tool copies your settings, including custom property fields, as one file.
Each clone carries your child theme and settings, plus the Studio template builder, 212 Elementor widgets, the property card composer and the search form builder. The first starter takes the most planning.
One live domain counts as one website, and licenses cover one, three or ten websites. On the Studio and Agency licenses you can hand a finished site to the client and move that activation to your next project; see WPResidence pricing. Deactivate the license on staging before you activate it on the live domain.
The White Label screen replaces the WPResidence name and logo in the admin with your own brand.
For most real estate client projects, very little. Theme Options, the Custom Fields Builder, the search form builder, membership packages and 212 Elementor widgets cover most client requests. Custom code is for unusual data rules, and for some experimental business models WPResidence isn't the right base.
Theme Options has hundreds of settings for layout, display and behavior. The Custom Fields Builder adds property fields in five types (short text, long text, number, date and dropdown) that you can use in submission forms and as search filters, and the search builder offers 8 advanced search form types. You also get 50 one-click demos, 212 Elementor widgets and Studio templates for property, agent, agency, developer and category pages. Roles cover User, Agent, Agency and Developer, each with a front-end dashboard, plus a built-in CRM. For international sites, WPEstate Translate is included, the theme ships translation files for 40+ languages with right-to-left support, and WPML and Weglot also work.
WPResidence loads scripts and styles through standard WordPress enqueue calls and uses standard WordPress extension points. For speed, the theme cache stores heavy real estate queries, CSS and JS can be minified, and map pins can be read from a file. Plan on PHP 8 and a memory limit of 256MB or higher, and measure PageSpeed on your own build.
Some experimental business models need a fully custom stack. WPResidence is an options-and-child-theme framework, not a headless SDK: it turns common real estate requests into settings and modules. Gating video or virtual tours for paid members isn't built in and needs a membership or content-restriction plugin, and custom coding isn't part of support. See how WPResidence compares with Houzez.
You can automate WPResidence in two ways: scripts that call the REST API, and webhooks the theme sends when something happens. In Theme Options you set a webhook URL and choose which forms send to it, the Contact Form Builder has its own webhook, and the CRM can send webhooks on CRM events, so leads can go to Zapier, Make or your own endpoint.
For MLS listings, MLSImport, our own plugin, pulls RESO Web API feeds into WordPress as property posts and syncs every hour. You map MLS fields to theme fields once, and you can import by office so each branch shows its own listings.
WPEstate Translate, included with the theme, creates linked copies of properties, agents and agencies per language, with rules for which custom fields are translated and which are copied. Multi-currency stores one price per property and converts it for display, with daily exchange rates from the Currencylayer API or rates you set, and Indian lakh and crore formats.
PayPal, Stripe and wire transfer are built in; turn on WooCommerce payments to use a WooCommerce gateway for packages and listing fees. The HubSpot integration sends contacts, deals and tickets from your forms to HubSpot.
WPResidence has built-in tools for paid listings: packages, featured listing quotas, image limits per listing, hidden prices and role-based dashboards. Gating video or virtual tours for paid members isn't built in and needs a membership or content-restriction plugin.
You can charge per listing or sell membership packages. Each package sets the number of listings, featured listings, images per listing, the billing period and the price, and the theme checks the active package when a user adds or features a property. Packages can be shown to specific roles, and a free package with a small quota lets new users submit before they pay.
Listings belong to the user, not the package, so they stay when a user changes plan. Each listing can hide its price and show a text such as "Price on application".
The number of images per listing comes from the package; video and virtual tours have no per-plan rule. To put them behind a paywall, add a membership or content-restriction plugin and use its rules on the property templates. Social login is built in: Facebook and Google sign-in work with API keys in Theme Options.
PayPal, Stripe and wire transfer are built in, which covers per-listing fees and recurring packages. Use WooCommerce when you need another gateway; WooCommerce doesn't handle recurring membership payments.
The main points of this page.
Read and write properties, agents, agencies and developers, with a public Postman workspace; writes need JWT authentication.
The included child theme, template overrides and hooks keep your changes outside core files.
Theme Options, the Custom Fields Builder and 212 Elementor widgets handle most client requests.
Webhooks send form and CRM events to your endpoint, and MLSImport syncs MLS listings every hour.
Clone one master site per project, export Theme Options, and activate a license per live domain.
WPResidence is an options-and-child-theme framework; experimental models may need a fully custom stack.
Yes. External apps can read and write properties, agents, agencies and developers, plus invoices, reviews, messages, favorites and saved searches. A public Postman workspace documents the requests. Write calls need JWT authentication, which you set up once. For events, the theme and CRM can also send webhooks.
For most client work, no. The Custom Fields Builder, the search form builder, Elementor, membership packages and Theme Options handle most requirements from the admin. PHP is for advanced integrations or unusual data rules, and the child theme and hooks keep that work small.
Yes, that is the intended workflow. Put changes in the included child theme, copy templates into it to override them, and use the theme's action and filter hooks to change behavior.
Both come with the license for a year. Updates bring new features and compatibility fixes; support is private tickets with our in-house team. If you don't renew, the site keeps working and the help articles stay available, but new updates and new tickets stop.
No. One live domain counts as one website, so each client site needs its own license; licenses cover one, three or ten websites. On the Studio and Agency licenses you can move an activation to a new project after handing a site over.
Yes. A demo imports in one click, and most of the rest is branding, first listings and Theme Options, usually a focused day or weekend. Daily work uses Elementor, the admin forms and the front-end property submission.
Photos, yes: each package sets how many images a listing can have. Video and virtual tours have no per-plan rule, so to gate them add a membership or content-restriction plugin. Hiding the price per listing is built in.
Listings belong to the user, not the package, so they stay when the user moves to a paid package, and the new package's limits apply to future submissions.
Elementor is enough for new builds. WPResidence has 212 Elementor widgets for listings, agent profiles, search forms and maps, and it also supports WPBakery. Studio templates and the property card composer handle listing layouts.
Yes. Facebook and Google sign-in are built in; add the API keys in Theme Options and both options appear next to the email and password fields.
Related guides: WPResidence vs Houzez, connecting an MLS feed with MLSImport and WPResidence pricing.
