Easy Property Listings 3.5.15 Code Reference
  • Package
  • Class
  • Tree
  • Todo
  • Hook Reference

Packages

  • EPL
    • Admin
      • Actions
      • Classes
        • ContactsTable
        • ReportsGraph
        • Welcome
      • Contacts
      • ContactsActions
      • ContactsFunctions
      • Elements
      • Functions
      • Help
      • HelpSingle
      • Menus
      • MenusAddons
      • MenusExtensions
      • MenusLicenses
      • Plugins
      • Reports
      • ReportsGraphing
      • User
    • Assets
      • ScriptsStyles
      • SVG
    • Classes
      • AuthorLoader
      • AuthorMeta
      • Contact
      • Cron
      • CustomPostType
      • Forms
      • License
      • ListingAdvanced
      • ListingElements
      • MetaboxesCustomFields
      • Pagination
      • PropertyMeta
      • RenderFields
      • RestAPI
      • Search
      • Session
      • Updater
    • Compatibility
      • Extensions
      • Functions
      • Shortcodes
    • Functions
      • Actions
      • ConditionalTags
      • ErrorTracking
      • Formatting
      • Front
      • Global
      • Install
      • Pagination
      • Settings
      • Templates
    • Hooks
      • EnergyCertificate
      • ExternalLinks
      • FloorPlan
      • Map
      • ReadMore
      • WebLink
    • Meta
      • InitCustomFields
      • Meta
    • PostTypes
      • Business
      • Commercial
      • CommercialLand
      • Contact
      • Functions
      • Land
      • Property
      • Rental
      • Rural
    • Shortcode
      • CommercialListingSearch
      • ContactForm
      • Listing
      • ListingAdvanced
      • ListingAuction
      • ListingCategory
      • ListingFeature
      • ListingLocation
      • ListingMetaDoc
      • ListingOpen
      • ListingResults
      • ListingSearch
      • Map
    • Taxonomy
      • BusinessCategories
      • ContactTag
      • Features
      • Location
    • Templates
      • Themes
        • iThemes
        • iThemesBuilder
    • Widget
      • Admin
        • Dashboard
      • Classes
        • Author
        • ContactCapture
        • Gallery
        • Listing
        • Search
      • Functions
  • None
  • WordPress
    • Session

Classes

  • EPL_Property_Meta

Class EPL_Property_Meta

EPL_Property_Meta Class

Package: EPL\Classes\PropertyMeta
Copyright: Copyright (c) 2020, Merv Barrett
License: GNU Public License
Since: 2.0
Located at lib/includes/class-epl-property-meta.php

Methods summary

public
# __construct( array $post )

Get things going

Get things going

Parameters

$post
Post object.

Since

2.0
public
# epl_labels( )

Define Admin labels in epl_settings global variable

Define Admin labels in epl_settings global variable

Returns


Adds the custom admin labels

Since

2.0
public string|integer
# get_property_meta( string $meta_key, boolean $allowzero = true )

Return the meta value based on the meta key.

Return the meta value based on the meta key.

Usage is $property->get_property_meta('meta_key') with the global $property variable defined

Parameters

$meta_key
The meta key to get the value.
$allowzero
Return a 0 value or if false and a value of 0 return nothing. Default True.

Returns

string|integer
Return the value of the meta key, string, or integer.

Since

2.0
public mixed
# get_property_inspection_times( boolean $ical = true, string $meta_key = 'property_inspection_times' )

Outputs the inspection times based on settings format

Outputs the inspection times based on settings format

Parameters

$ical
True to return link with iCal.
$meta_key
The meta key to get the value from default is property_inspection_times.

Returns

mixed
Return formatted inspection times with a iCal link

Since

2.0
3.4.27 Added filter for href, handling of non date inspection values.
3.4.44 Added filter for deciding whether to remove inspection entry.
3.5.3 Fix: Deprecation warning - Make sure inspection time is not null before passing through trim.
3.5.3 Update to use local timestamp.
3.5.13 Tweak: Target blank added to ical link.
public string
# get_epl_settings( string $key )

Get the setting based on the key

Get the setting based on the key

Usage is $property->get_epl_settings('meta_key') with the global $property variable defined

Parameters

$key
Option key name.

Returns

string
Value of the setting or if not set nothing is returned

Since

2.0
public mixed
# get_property_feature_taxonomy( )

Process Property Features Taxonomy

Process Property Features Taxonomy

Returns

mixed
List of features

Since

2.0
public string
# get_suburb_profile( )

Suburb profile

Suburb profile

Returns

string
Suburb/Location name

Since

2.0
public string
# get_property_auction( boolean $admin = false )

Auction Date/Time

Auction Date/Time

Parameters

$admin
true/false True will return on frontend.

Returns

string
formatted auction date

Since

2.0.0
3.4.38 Added epl_get_property_auction_date_time_separator filter for date/time separator.
public string
# get_property_com_rent( )

Commercial Rent

Commercial Rent

Returns

string
Currency Formatted price

Since

2.0
public string
# get_property_price_display( )

Price Display

Price Display

Returns

string
Return formatted price based on selected options

Since

2.0
public string
# get_property_price_sold_display( boolean $admin = false )

Sold price display

Sold price display

Parameters

$admin
True for frontend.

Returns

string
Return sold price if selected or nothing

Since

2.0
public string
# get_property_price_lease_display( boolean $admin = false )

Lease price display

Lease price display

Parameters

$admin
True for front end usage.

Returns

string
Return lease price if selected or nothing

Since

3.1
public string
# get_property_price_sold_date( integer $sold_price = null )

Sold date display

Sold date display

Parameters

$sold_price
Sold price.

Returns

string
Return sold date if sold

Since

2.0
public string
# get_property_rent( )

Rental Price

Rental Price

Returns

string
Currency Formatted Rental Price

Since

2.0
public string
# get_property_bond( )

Rental Bond

Rental Bond

Returns

string
Formatted Bond price

Since

2.0
public string
# get_property_available( boolean $admin = false )

Rental Available Date

Rental Available Date

Parameters

$admin
True for front end usage.

Returns

string
Formatted date

Since

2.0.0
3.4.38 Added epl_get_property_available_date_time_separator filter for date/time separator.
3.5.0 Fixed time shown when only date string.
public string
# get_property_land_category( string $tag = 'div', string $class = 'land-category' )

Land category

Land category

Parameters

$tag
HTML wrapper type, default div.
$class
name, default land-category.

Returns

string

Since

2.0.0
3.4.42 Fix: Filter name was incorrect changed to epl_get_property_land_category.
public string
# get_formatted_property_address( boolean $street_separator = true, string $separator_symbol = ',' )

Formatted Street level address based on selected display option

Formatted Street level address based on selected display option

Parameters

$street_separator
Output a address separator after the street address.
$separator_symbol
Symbol to use as the address separator, default is a comma.

Returns

string
formatted street address

Since

2.0.0
3.4.8 Corrected spacing if value is present. Implemented separator with existing filter.
public string
# get_property_category( string $tag = 'div', string $class = 'property-category' )

Listing Category

Listing Category

Parameters

$tag
HTML wrapper type, default div.
$class
name, default property-category.

Returns

string

Since

2.0
public string
# get_property_commercial_category( string $tag = 'div', string $class = 'commercial-category' )

Get Commercial Category

Get Commercial Category

Parameters

$tag
HTML wrapper type, default div.
$class
name, default commercial-category.

Returns

string

Since

2.0
public string
# get_property_rural_category( string $tag = 'div', string $class = 'rural-category' )

Get Rural Category

Get Rural Category

Parameters

$tag
HTML wrapper type, default div.
$class
name, default rural-category.

Returns

string

Since

3.1.12
public string
# get_price_class( )

Price Class

Price Class

Returns

string

Since

2.0
public string
# get_property_tax( )

Tax

Tax

Returns

string

Since

2.0
public string
# get_price_plain_value( )

Plain price value

Plain price value

Returns

string

Since

2.0.0
3.4.38 Using label_poa for no rental price. Added epl_price_rent_period filter. Added filter epl_pa_price for P.A label.
public string
# get_price( )

Get Price

Get Price

Returns

string

Since

2.0
3.4.27 Fixed rent period translation.
3.4.28 Using label_poa for no rental price. Added epl_price_rent_period filter. Added filter epl_pa_price for P.A label.
3.4.38 Commercial listing type "both" now shows sale & lease prices.
public string
# get_price_sticker( )

Price Sticker

Price Sticker

Returns

string

Throws

Exception
PHP 5.3 notice.

Since

2.0
3.5 Added fix for trim when string string is null.
3.5.14 Added missing new status sticker for commercial listings.
public string
# get_l_price( )

Get list style price

Get list style price

Returns

string

Since

2.0.0
3.4.38 Added epl_price_rent_period filter. Added filter epl_pa_price for P.A label.
public string
# get_property_year_built( string $returntype = 'i' )

Get Year Built

Get Year Built

Parameters

$returntype
Options i = span, v = value, d = string, l = list item, t = text.

Returns

string

Since

2.0
3.5.0 Added filter for empty values.
public string
# get_property_bed( string $returntype = 'i' )

Get Bedrooms

Get Bedrooms

Parameters

$returntype
Options i = span, v = value, d = string, l = list item, t = text, s = svg icon.

Returns

string

Since

2.0
3.5.0 Added filter for empty values.
public string
# get_property_bath( string $returntype = 'i' )

Get Bathrooms

Get Bathrooms

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item, s = svg icon.

Returns

string

Since

2.0
3.5.0 Added filter for empty values.
public string
# get_property_rooms( string $returntype = 'i' )

Get Rooms

Get Rooms

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

2.0
3.5.0 Added filter for empty values.
public string
# get_property_parking( string $returntype = 'i' )

Get Parking

Get Parking

Caluclated value based on number of garages + carports

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item, s = svg icon.

Returns

string

Since

2.0
3.4.20 New filter epl_total_parking_spaces for value.
3.4.21 Removed first check.
3.5.0 Added filter for empty values.
public string
# get_property_garage( string $returntype = 'i' )

Get Garage

Get Garage

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

2.0
3.5.0 Added filter for empty values.
public string
# get_property_carport( string $returntype = 'i' )

Get Carport

Get Carport

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

2.0
3.4.5 Fixed the incorrect meta key
3.5.0 Added filter for empty values.
public string
# get_property_air_conditioning( string $returntype = 'i' )

Get Air Conditioning

Get Air Conditioning

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item, s = svg icon.

Returns

string

Since

2.0
3.5.0 Added filter for empty values.
public string
# get_property_pool( string $returntype = 'i' )

Get Pool

Get Pool

Parameters

$returntype
Options Options i = span, v = raw value, t = text, d = string, l = list item, s = svg icon.

Returns

string

Since

2.0
3.5.0 Added filter for empty values.
public string
# get_property_security_system( string $returntype = 'i' )

Get Security System

Get Security System

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

2.0
3.5.0 Added filter for empty values.
public string
# get_property_land_value( string $returntype = 'i' )

Get Land Value

Get Land Value

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

2.0
3.4.38 Fix: Don't display land area when it's < 0.
3.4.42 Fix : Fatal error if area is non numeric.
public string
# get_property_building_area_value( string $returntype = 'i' )

Get Building area

Get Building area

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

2.0
3.4.42 Fix : Fatal error if area is non numeric.
public string
# get_property_energy_rating( string $returntype = 'i' )

Get Building Energy Rating

Get Building Energy Rating

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

3.1.20
public string
# get_property_new_construction( string $returntype = 'i' )

Get New Construction

Get New Construction

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

2.0
3.5.13 Using value bool checker function.
public string
# get_property_holiday_rental( string $returntype = 'i' )

Get Holiday Rental

Get Holiday Rental

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

3.2
3.5.13 Using value bool checker function.
public string
# get_property_furnished( string $returntype = 'i' )

Get Furnished

Get Furnished

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

3.2
3.5.13 Using value bool checker function.
public string
# get_property_pets( string $returntype = 'i' )

Get Pets

Get Pets

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

3.3
3.5.13 Using value bool checker function.
public string
# get_property_featured( string $returntype = 'i' )

Get Featured

Get Featured

Parameters

$returntype
Options i = span, v = raw value, t = text, d = string, l = list item.

Returns

string

Since

3.3
3.5.13 Using value bool checker function.
public mixed
# get_additional_features_html( string $metakey )

Get Additional Features by meta key

Get Additional Features by meta key

Parameters

$metakey
Meta key name.

Returns

mixed
Value wrapped in a list item

Since

2.0
3.4.35 Tweak: Support for true/false values in features checklist.
3.4.44 Parking Comments Label before value.
public mixed
# get_additional_rural_features_html( string $metakey )

Get Additional Rural Features by meta key

Get Additional Rural Features by meta key

Parameters

$metakey
Meta key name.

Returns

mixed
Value formatted and wrapped in div with title

Since

2.0
public mixed
# get_additional_commercial_features_html( string $metakey )

Get Additional Commercial Features by meta key

Get Additional Commercial Features by meta key

Parameters

$metakey
Meta key name.

Returns

mixed
Value formatted and wrapped in div with title

Since

2.0.0
3.4.27
public mixed
# get_additional_commerical_features_html( string $metakey )

Get Additional Commercial Features by meta key.

Get Additional Commercial Features by meta key.

Spelling error in this function. Retained to prevent issues.

Parameters

$metakey
Meta key name.

Returns

mixed
Value formatted and wrapped in div with title

Since

2.0.0
public string
# get_class_from_metakey( string $key, string $search = 'property_' )

Get class name from meta key

Get class name from meta key

Parameters

$key
Meta key.
$search
Meta key prefix to search for and remove from class, property_ is default.

Returns

string
Formatted class name

Since

2.0
public string
# get_label_from_metakey( string $key, string $search = 'property_' )

Get Label from meta key

Get Label from meta key

Parameters

$key
Meta key.
$search
Meta key prefix to search for and remove from class, property_ is default.

Returns

string
Formatted uppercase words

Since

2.0

Depricated

since 3.2
public mixed
# get_features_from_taxonomy( )

Get features from taxonomy

Get features from taxonomy

Returns

mixed
Formatted list items

Since

2.0

Properties summary

public static $instance

Global Instance

Global Instance

Since

2.0
#
public $post

Global post

Global post

Since

2.0
#
public $epl_settings

Global epl_settings

Global epl_settings

Since

2.0
#
public $meta

Global meta

Global meta

Since

2.0
#
public $post_type

Global post type

Global post type

Since

2.0
#
public $property_post_type

Global EPL Post Type

Global EPL Post Type

Since

2.0
#
public $label_new

Label New option

Label New option

Since

3.4.44
#
public $sticker_new_range

Sticker Range

Sticker Range

Since

3.4.44
#
public $label_home_open

Label: Home Open

Label: Home Open

Since

3.4.44
#
public $label_poa

Label: POA

Label: POA

Since

3.4.44
#
public $label_under_offer

Label: Under Offer

Label: Under Offer

Since

3.4.44
#
public $label_sold

Label: Sold

Label: Sold

Since

3.4.44
#
public $label_leased

Label: Leased

Label: Leased

Since

3.4.44
#
public $label_bond

Label: Bond

Label: Bond

Since

3.4.44
#
public $display_bond

Display Bond option

Display Bond option

Since

3.4.44
#
Easy Property Listings 3.5.15 Code Reference API documentation generated by ApiGen