EPL_Property_Meta Class
| Since | |
|---|---|
2.0 |
|
| Methods | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
public
|
__construct(object $post)
Get things going
Get things going Parameters
Since
|
# | ||||||||||||||||||
public
|
epl_labels(): void
Define Admin labels in epl_settings global variable
Define Admin labels in epl_settings global variable ReturnsAdds the custom admin labels Since
|
# | ||||||||||||||||||
public
|
get_property_meta(string $meta_key, bool $allowzero = true): string|integer
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
ReturnsReturn the value of the meta key, string, or integer. Since
|
# | ||||||||||||||||||
public
|
get_property_inspection_times(bool $ical = true, string $meta_key = 'property_inspection_times'): mixed
Outputs the inspection times based on settings format
Outputs the inspection times based on settings format Parameters
ReturnsReturn formatted inspection times with a iCal link Since
|
# | ||||||||||||||||||
public
|
get_epl_settings(string $key): string
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
ReturnsValue of the setting or if not set nothing is returned Since
|
# | ||||||||||||||||||
public
|
get_property_feature_taxonomy(): mixed
Process Property Features Taxonomy
Process Property Features Taxonomy ReturnsList of features Since
|
# | ||||||||||||||||||
public
|
get_suburb_profile(): string
Suburb profile
Suburb profile ReturnsSuburb/Location name Since
|
# | ||||||||||||||||||
public
|
get_property_auction(bool $admin = false): string
Auction Date/Time
Auction Date/Time Parameters
Returnsformatted auction date Since
|
# | ||||||||||||||||||
public
|
get_property_com_rent(): string
Commercial Rent
Commercial Rent ReturnsCurrency Formatted price Since
|
# | ||||||||||||||||||
public
|
get_property_price_display(): string
Price Display
Price Display ReturnsReturn formatted price based on selected options Since
|
# | ||||||||||||||||||
public
|
get_property_price_sold_display(bool $admin = false): string
Sold price display
Sold price display Parameters
ReturnsReturn sold price if selected or nothing Since
|
# | ||||||||||||||||||
public
|
get_property_price_lease_display(bool $admin = false): string
Lease price display
Lease price display Parameters
ReturnsReturn lease price if selected or nothing Since
|
# | ||||||||||||||||||
public
|
get_property_price_sold_date(integer $sold_price = null): string
Sold date display
Sold date display Parameters
ReturnsReturn sold date if sold Since
|
# | ||||||||||||||||||
public
|
get_property_rent(): string
Rental Price
Rental Price ReturnsCurrency Formatted Rental Price Since
|
# | ||||||||||||||||||
public
|
get_property_bond(): string
Rental Bond
Rental Bond ReturnsFormatted Bond price Since
|
# | ||||||||||||||||||
public
|
get_property_available(bool $admin = false): string
Rental Available Date
Rental Available Date Parameters
ReturnsFormatted date Since
|
# | ||||||||||||||||||
public
|
get_property_land_category(string $tag = 'div', string $class_name = 'land-category'): string
Land category
Land category Parameters
Since
|
# | ||||||||||||||||||
public
|
get_formatted_property_address(bool $street_separator = true, string $separator_symbol = ','): string
Formatted Street level address based on selected display option
Formatted Street level address based on selected display option Parameters
Returnsformatted street address Since
|
# | ||||||||||||||||||
public
|
show_street_address(): bool
Show the street address?
Show the street address? True when the listing's Display Street Address box is ticked. The street address is the lot, unit, street number and street name. Since
|
# | ||||||||||||||||||
public
|
show_suburb(): bool
Show the suburb?
Show the suburb? Always for residential listings. Commercial, commercial land and business listings have a Display Suburb box: their suburb shows when it's ticked or when the street address shows. The same rule as the REST API. Since
|
# | ||||||||||||||||||
public
|
show_address_city(): bool
Show the city in the address?
Show the city in the address? True when Settings > Address > Additional Address Field (the city) is enabled. Since
|
# | ||||||||||||||||||
public
|
show_address_country(): bool
Show the country in the address?
Show the country in the address? True when Settings > Address > Display Country is enabled. Since
|
# | ||||||||||||||||||
public
|
get_property_category(string $tag = 'div', string $class_name = 'property-category'): string
Listing Category
Listing Category Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_commercial_category(string $tag = 'div', string $class_name = 'commercial-category'): string
Get Commercial Category
Get Commercial Category Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_rural_category(string $tag = 'div', string $class_name = 'rural-category'): string
Get Rural Category
Get Rural Category Parameters
Since
|
# | ||||||||||||||||||
public
|
get_price_class(): string
Price Class
Price Class Since
|
# | ||||||||||||||||||
public
|
get_property_tax(): string
Tax
Tax Since
|
# | ||||||||||||||||||
public
|
is_under_offer(): bool
Is the listing under offer?
Is the listing under offer? A listing is under offer when it is marked under offer and is not sold. Since
|
# | ||||||||||||||||||
public
|
has_advertised_price(): bool
Does the listing advertise a price?
Does the listing advertise a price? True when the listing is set to display its price, has a price to display and is not an auction. Listings showing the No Price label (POA) or an auction date advertise no price. Since
|
# | ||||||||||||||||||
public
|
show_price_under_offer(): bool
Show the price on listings that are under offer?
Show the price on listings that are under offer? Only when the Under Offer Price Display setting is set to show the price. Off by default, so under offer listings show only the Under Offer label, as before 3.6. Since
|
# | ||||||||||||||||||
public
|
get_poa_label(string|null $fallback = null): string|null
No Price (POA) label from the settings.
No Price (POA) label from the settings. Parameters
Since
|
# | ||||||||||||||||||
public
|
get_under_offer_price(string $price, string $format = 'span'): string
Under offer price.
Under offer price. Keeps the advertised price visible next to the Under Offer label, for example "Under Offer | $360,000 - $390,000". Returns the Under Offer label on its own when the listing advertises no price or the site hides the price under offer. Parameters
Since
|
# | ||||||||||||||||||
public
|
get_price_plain_value(): string
Plain price value
Plain price value Since
|
# | ||||||||||||||||||
public
|
get_price(): string
Get Price
Get Price Since
|
# | ||||||||||||||||||
public
|
get_price_sticker(): string
Price Sticker
Price Sticker Throws
Since
|
# | ||||||||||||||||||
public
|
get_l_price(): string
Get list style price
Get list style price Since
|
# | ||||||||||||||||||
public
|
get_property_year_built(string $returntype = 'i'): string
Get Year Built
Get Year Built Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_bed(string $returntype = 'i'): string
Get Bedrooms
Get Bedrooms Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_bath(string $returntype = 'i'): string
Get Bathrooms
Get Bathrooms Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_rooms(string $returntype = 'i'): string
Get Rooms
Get Rooms Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_parking(string $returntype = 'i'): string
Get Parking
Get Parking Caluclated value based on number of garages + carports Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_garage(string $returntype = 'i'): string
Get Garage
Get Garage Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_carport(string $returntype = 'i'): string
Get Carport
Get Carport Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_air_conditioning(string $returntype = 'i'): string
Get Air Conditioning
Get Air Conditioning Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_pool(string $returntype = 'i'): string
Get Pool
Get Pool Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_security_system(string $returntype = 'i'): string
Get Security System
Get Security System Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_land_value(string $returntype = 'i'): string
Get Land Value
Get Land Value Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_building_area_value(string $returntype = 'i'): string
Get Building area
Get Building area Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_energy_rating(string $returntype = 'i'): string
Get Building Energy Rating
Get Building Energy Rating Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_new_construction(string $returntype = 'i'): string
Get New Construction
Get New Construction Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_holiday_rental(string $returntype = 'i'): string
Get Holiday Rental
Get Holiday Rental Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_furnished(string $returntype = 'i'): string
Get Furnished
Get Furnished Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_pets(string $returntype = 'i'): string
Get Pets
Get Pets Parameters
Since
|
# | ||||||||||||||||||
public
|
get_property_featured(string $returntype = 'i'): string
Get Featured
Get Featured Parameters
Since
|
# | ||||||||||||||||||
public
|
get_additional_features_html(string $metakey): mixed
Get Additional Features by meta key
Get Additional Features by meta key Parameters
ReturnsValue wrapped in a list item Since
|
# | ||||||||||||||||||
public
|
get_additional_rural_features_html(string $metakey): mixed
Get Additional Rural Features by meta key
Get Additional Rural Features by meta key Parameters
ReturnsValue formatted and wrapped in div with title Since
|
# | ||||||||||||||||||
public
|
get_additional_commercial_features_html(string $metakey): mixed
Get Additional Commercial Features by meta key
Get Additional Commercial Features by meta key Parameters
ReturnsValue formatted and wrapped in div with title Since
|
# | ||||||||||||||||||
public
|
get_additional_commerical_features_html(string $metakey): mixed
Get Additional Commercial Features by meta key.
Get Additional Commercial Features by meta key. Spelling error in this function. Retained to prevent issues. Parameters
ReturnsValue formatted and wrapped in div with title Since
|
# | ||||||||||||||||||
public
|
get_class_from_metakey(string $key, string $search = 'property_'): string
Get class name from meta key
Get class name from meta key Parameters
ReturnsFormatted class name Since
|
# | ||||||||||||||||||
public
|
get_label_from_metakey(string $key, string $search = 'property_'): string
Get Label from meta key
Get Label from meta key Parameters
ReturnsFormatted uppercase words Since
|
# | ||||||||||||||||||
public
|
get_features_from_taxonomy(): mixed
Get features from taxonomy
Get features from taxonomy ReturnsFormatted list items Since
|
# | ||||||||||||||||||
| Properties | |||
|---|---|---|---|
public
static
|
|
$instance
Global Instance
Global Instance |
# |
public
|
|
$post
Global post
Global post |
# |
public
|
|
$epl_settings
Global epl_settings
Global epl_settings |
# |
public
|
|
$meta
Global meta
Global meta |
# |
public
|
|
$post_type
Global post type
Global post type |
# |
public
|
|
$property_post_type
Global EPL Post Type
Global EPL Post Type |
# |
public
|
|
$label_new
Label New option
Label New option |
# |
public
|
|
$sticker_new_range
Sticker Range
Sticker Range |
# |
public
|
|
$label_home_open
Label: Home Open
Label: Home Open |
# |
public
|
|
$label_poa
Label: POA
Label: POA |
# |
public
|
|
$label_under_offer
Label: Under Offer
Label: Under Offer |
# |
public
|
|
$label_sold
Label: Sold
Label: Sold |
# |
public
|
|
$label_leased
Label: Leased
Label: Leased |
# |
public
|
|
$label_bond
Label: Bond
Label: Bond |
# |
public
|
|
$display_bond
Display Bond option
Display Bond option |
# |
public
|
|
$display_price_under_offer
Under Offer Price Display option
Under Offer Price Display option |
# |