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_SEARCH
  • EPL_Search_Fields

Class EPL_SEARCH

EPL_SEARCH Class

Package: EPL\Classes\Search
Copyright: Copyright (c) 2020, Merv Barrett
License: GNU Public License
Since: 3.1
Located at lib/includes/class-epl-search.php

Methods summary

public
# __construct( WP_Query $query, array $data )

Get things going

Get things going

Parameters

$query
object of the wp_query object.
$data
associative array for fields to search.

Since

3.2
3.5.13 Setting page name to null on search pages.
protected array
# altered_fields( )

These are list of fields which are not directly queried, but their value is used to query other meta data / post data / tax data

These are list of fields which are not directly queried, but their value is used to query other meta data / post data / tax data

Returns

array
public
# sanitize_recursive( array|string $data )

Sanitize an array of data recursively.

Sanitize an array of data recursively.

Parameters

$data
The data to be sanitized.

Since

3.5.0
protected
# sanitize_data( )

Sanitize whole GET & POST array, insures security from XSS

Sanitize whole GET & POST array, insures security from XSS

Since

3.5.0 replaced depricated code for sanitization.
protected
# fields_to_skip( )

Set list of fields which are not to be queried

Set list of fields which are not to be queried

protected
# skip_unnecessary_fields( )

Skip unnecessay fields

Skip unnecessay fields

protected
# set_per_page( )

Set per page for query

Set per page for query

protected
# set_pagination( )

Set pagination for query

Set pagination for query

protected
# set_title( )

Set title for query

Set title for query

protected
# set_property_agent( )

Set property agent for query

Set property agent for query

protected
# set_post_type( )

Set post type for query

Set post type for query

Since

3.4.12 Added support for 'all' post type.
protected
# modify_fields( )

Modify meta keys according to data received, for special cases

Modify meta keys according to data received, for special cases

protected
# set_query( )

Set queries meta, Tax

Set queries meta, Tax

protected
# set_meta_query( )

Set meta query for the search object

Set meta query for the search object

protected
# set_tax_query( )

Set tax query for the search object

Set tax query for the search object

protected
# prepare_query( )

Prepare the query

Prepare the query

public
# epl_search_query_pre_search( )

Pre search query

Pre search query

protected
# prepare_meta_query( array $query_field, string $value )

Prepare meta query

Prepare meta query

Parameters

$query_field
Field to query.
$value
Value of field.
protected boolean
# is_query_multiple( array $query_field )

Checks if given meta query is multiple

Checks if given meta query is multiple

Parameters

$query_field
Field to query.

Returns

boolean
protected string
# multiple_relation( array $query_field )

Returns relationship for the multiple query

Returns relationship for the multiple query

Parameters

$query_field
Field to query.

Returns

string
protected
# multiple_meta_query( array $query_field, string $data )

Set multiple meta query

Set multiple meta query

Parameters

$query_field
Field to query.
$data
Data value.
protected
# single_meta_query( array $query_field, string $data )

Set single meta query

Set single meta query

Parameters

$query_field
Field to query.
$data
Data value.
protected
# preprocess_meta_query( )

Preprocess meta query

Preprocess meta query

Since

3.1.0
3.4.30 Fix: Only variables can be passed via reference.
protected
# prepare_tax_query( array $query_field, string $value )

Prepare taxonomy query

Prepare taxonomy query

Parameters

$query_field
Field to query.
$value
Data value.
protected
# prepare_special_query( array $query_field, string $value )

Prepare special query

Prepare special query

Parameters

$query_field
Field to query.
$value
Data value.
public array
# get_posts( )

Return array of posts based on search data

Return array of posts based on search data

Returns

array

Properties summary

public array $data

Holds the submitted form data.

Holds the submitted form data.

#
public array $skip_fields

Holds skipped fields.

Holds skipped fields.

#
public array $form_fields

Holds Array of form fields.

Holds Array of form fields.

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