{"id":19,"date":"2026-09-16T10:28:31","date_gmt":"2026-09-16T10:28:31","guid":{"rendered":"https:\/\/docs.latw.ai\/uncategorized\/php-api\/"},"modified":"2026-09-16T10:28:31","modified_gmt":"2026-09-16T10:28:31","slug":"php-api","status":"publish","type":"post","link":"https:\/\/docs.latw.ai\/pl\/esti-to-wordpress\/php-api\/","title":{"rendered":"PHP API"},"content":{"rendered":"

PHP API: the osfec_*<\/code> functions<\/h1>\n

These functions are the plugin’s public API. They live in includes\/functions.php<\/code>, load on plugins_loaded<\/code> and are
\navailable anywhere in the theme.<\/p>\n

Every function that takes a $post_id<\/code> defaults to the current post in the loop.<\/p>\n

Reading fields<\/h2>\n

osfec_field( string $key, ?int $post_id = null ): mixed<\/code><\/h3>\n

One meta value, without<\/strong> the _osfec_<\/code> prefix. The workhorse.<\/p>\n

$price = osfec_field( 'price' );        \/\/ '540000' or ''\n$city  = osfec_field( 'city', $id );    \/\/ 'Bia\u0142ystok'<\/code><\/pre>\n
Missing fields return ''<\/code>, because empty values are never stored. See the data model<\/a> for the
\nfull key list.<\/p>\n
osfec_photos( ?int $post_id = null ): array<\/code><\/h3>\n
The full-size photo URLs, decoded from JSON. Empty array when the offer has none.<\/p>\n
foreach ( osfec_photos() as $url ) { \u2026 }<\/code><\/pre>\n
osfec_photo_thumb( string $url ): string<\/code><\/h3>\n
Converts a full-size Esti URL into its thumbnail variant (_max<\/code> \u2192 _min<\/code>). There is no _small<\/code>.<\/p>\n
osfec_agent( ?int $post_id = null ): array<\/code><\/h3>\n
The agent behind the offer, merged from two sources: the offer’s own meta carries the name, e-mail and phone; the photo,
\nrole and office come from the directory synchronized separately, matched on the Esti agent ID. The directory wins on
\nevery field it actually carries.<\/p>\n
Returns name<\/code>, photo<\/code>, position<\/code>, office<\/code>, email<\/code>, phone<\/code> \u2014 always all six keys, ''<\/code> where unknown.<\/p>\n
$agent = osfec_agent();\n\nif ( $agent['name'] ) {\n    printf( '<a href=\"tel:%s\">%s<\/a>', esc_attr( $agent['phone'] ), esc_html( $agent['name'] ) );\n}<\/code><\/pre>\n
Formatting<\/h2>\n
osfec_format_price( $price, string $currency = '' ): string<\/code><\/h3>\n
Localised number plus the currency code. An empty price returns the translated “Price on request”<\/strong>, so guard the
\nvalue yourself if you need a different empty state.<\/p>\n
osfec_format_price( '540000', 'PLN' );  \/\/ '540 000 PLN'\nosfec_format_price( '' );               \/\/ 'Price on request'<\/code><\/pre>\n
osfec_format_area( $area ): string<\/code><\/h3>\n
Localised number plus m\u00b2<\/code>; whole numbers lose their decimals. Empty input returns ''<\/code>.<\/p>\n
osfec_location( ?int $post_id = null ): string<\/code><\/h3>\n
Street, city and commune as one line, empties and duplicates removed: Lipowa, Bia\u0142ystok<\/code>.<\/p>\n
osfec_type_label( ?int $post_id = null ): string<\/code><\/h3>\n
The short type label, without the bracketed variant: Dzia\u0142ka (Rolna)<\/code> \u2192 Dzia\u0142ka<\/code>. Use osfec_field( 'type_label' )<\/code>
\nfor the full one.<\/p>\n
osfec_transaction_label( string $slug ): string<\/code><\/h3>\n
sale<\/code> \u2192 “Sale”, rent<\/code> \u2192 “Rent”, purchase<\/code> \u2192 “Purchase”, lease<\/code> \u2192 “Lease”. Unknown slugs return ''<\/code>.<\/p>\n
osfec_market_label( string $slug ): string<\/code><\/h3>\n
primary<\/code> \u2192 “Primary market”, secondary<\/code> \u2192 “Secondary market”.<\/p>\n
Both label functions are translated through the plugin’s text domain.<\/p>\n
Dictionary-backed attributes<\/h2>\n
Some Esti fields arrive as bare numeric IDs. Never print them raw.<\/p>\n
osfec_attribute_label( string $key, ?int $post_id = null ): string<\/code><\/h3>\n
Reads the meta key and resolves it in one step. Returns ''<\/code> when the dictionary cannot name the ID<\/strong> \u2014 the template
\nis expected to drop the row in that case.<\/p>\n
$heating = osfec_attribute_label( 'building_heating' );\n\nif ( '' !== $heating ) {\n    echo esc_html( $heating );\n}<\/code><\/pre>\n
osfec_dictionary_label( $id ): string<\/code><\/h3>\n
The lower-level version: resolves an ID you already have.<\/p>\n
Building filter controls<\/h2>\n
osfec_type_options(): array<\/code><\/h3>\n
Type slug \u2192 label, for the offers currently in the catalogue. The slugs match the type<\/code> filter parameter. Cached for 6
\nhours.<\/p>\n
osfec_subtype_options(): array<\/code><\/h3>\n
Subtype slug \u2192 label (rolna<\/code> \u2192 Rolna<\/code>). Built the same way, so it fills up after the first synchronization.<\/p>\n
osfec_slug_map( string $key ): array<\/code><\/h3>\n
Slug \u2192 raw value for any meta key, built from the values actually stored. This is what makes ?city=bialystok<\/code> find
\noffers whose stored city is Bia\u0142ystok<\/code>.<\/p>\n
$cities = osfec_slug_map( 'city' );   \/\/ [ 'bialystok' => 'Bia\u0142ystok', \u2026 ]<\/code><\/pre>\n
Cached for 6 hours and flushed at the end of every successful run. Each call runs a DISTINCT<\/code> query on wp_postmeta<\/code>
\nwhen the cache is cold, so call it once and reuse the result.<\/p>\n
Templates and page structure<\/h2>\n
osfec_get_template( string $name, array $args = array() ): void<\/code><\/h3>\n
Includes a template part, letting the theme override it. $name<\/code> is relative to the plugin’s templates\/<\/code> directory; the
\ntheme’s copy lives under osfec\/<\/code> in the theme root. The array reaches the template as $args<\/code>.
\nSee Overriding templates<\/a>.<\/p>\n
osfec_get_template( 'parts\/card.php', array( 'post_id' => get_the_ID() ) );<\/code><\/pre>\n
osfec_header()<\/code> \/ osfec_footer()<\/code><\/h3>\n
Open and close a plugin page with the active theme’s own chrome.<\/p>\n
On a classic theme they are get_header()<\/code> and get_footer()<\/code>. On a block theme they render the theme’s header and
\nfooter template parts inside a .wp-site-blocks<\/code> wrapper, and open a <main class=\"osfec-main\"><\/code> between them \u2014 because
\nget_header()<\/code> on a block theme falls back to the theme-compatibility stub, an ancient markup block carrying none of the
\ntheme’s navigation, colours or fonts.<\/p>\n
Use them in any full-page template you write for the offer post type, and always in pairs.<\/p>\n
Class-level entry points you may need<\/h2>\n
Not helper functions, but part of the surface a custom UI uses:<\/p>\n\n\n\n\n\n\n\n\n\n\n
Call<\/th>\nPurpose<\/th>\n<\/tr>\n<\/thead>\n
OSFEC_Query::request()<\/code><\/td>\nThe whitelisted, sanitized GET parameters as an array<\/td>\n<\/tr>\n
OSFEC_Query::build_args( $request, $base )<\/code><\/td>\nThose parameters as WP_Query<\/code> arguments merged into your own<\/td>\n<\/tr>\n
OSFEC_Query::archive_url( $request )<\/code><\/td>\nThe archive URL with filters applied<\/td>\n<\/tr>\n
OSFEC_Settings::value( $key, $default )<\/code><\/td>\nOne setting<\/td>\n<\/tr>\n
OSFEC_CPT::POST_TYPE<\/code><\/td>\n'osfec_offer'<\/code><\/td>\n<\/tr>\n
OSFEC_Mapper::thumbnail_url( $url )<\/code><\/td>\nThe same conversion osfec_photo_thumb()<\/code> performs<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Escaping<\/h2>\n
None of these functions escape their output \u2014 they return data, not markup. Escape at the point of printing:
\nesc_html()<\/code> for text, esc_url()<\/code> for URLs, esc_attr()<\/code> for attributes.<\/p>\n","protected":false},"excerpt":{"rendered":"
PHP API: the osfec_* functions These functions are the plugin’s public API. They live in includes\/functions.php, load on plugins_loaded and are available anywhere in the theme.\u2026<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_latwm_translated_slug":"","footnotes":""},"categories":[2],"tags":[],"class_list":["post-19","post","type-post","status-publish","format-standard","hentry","category-esti-to-wordpress"],"_links":{"self":[{"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/posts\/19","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/comments?post=19"}],"version-history":[{"count":1,"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/posts\/19\/revisions"}],"predecessor-version":[{"id":52,"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/posts\/19\/revisions\/52"}],"wp:attachment":[{"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/media?parent=19"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/categories?post=19"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.latw.ai\/pl\/wp-json\/wp\/v2\/tags?post=19"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}