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_Advanced_Shortcode_Listing
  • EPL_Author
  • EPL_Author_Loader
  • EPL_Author_Meta
  • EPL_Contact
  • EPL_Contact_Reports_Table
  • EPL_CPT
  • EPL_Cron
  • EPL_FORM_BUILDER
  • EPL_Graph
  • EPL_License
  • EPL_Listing_Elements
  • EPL_METABOX
  • EPL_Pagination_Call
  • EPL_Property_Meta
  • EPL_Render_Fields
  • EPL_Rest_API
  • EPL_SEARCH
  • EPL_Search_Fields
  • EPL_Session
  • EPL_SL_Plugin_Updater
  • EPL_Welcome
  • EPL_Widget_Author
  • EPL_Widget_Contact_Capture
  • EPL_Widget_Property_Gallery
  • EPL_Widget_Property_Search
  • EPL_Widget_Recent_Property

Functions

  • EPL
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 
<?php
/**
 * SHORTCODE :: Listing [listing]
 *
 * @package     EPL
 * @subpackage  Shortcode/Listing
 * @copyright   Copyright (c) 2020, Merv Barrett
 * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License
 * @since       1.0
 * @since       3.4 support for third and fourth agents.
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
    exit;
}

// phpcs:disable WordPress.DB.SlowDBQuery

/**
 * Listing Shortcode [listing]
 *
 * This shortcode allows for you to specify the property type(s) using
 * [listing post_type="property,rental" status="current,sold,leased" template="default"] option. You can also
 * limit the number of entries that display. using  [listing limit="5"]
 *
 * @param array $atts Shortcode attributes.
 *
 * @return false|string
 * @since       1.0
 * @since       3.5 make sure meta_query in arg is defined as array, prior usage.
 */
function epl_shortcode_listing_callback( $atts ) {

    $property_types = epl_get_active_post_types();
    if ( ! empty( $property_types ) ) {
        $property_types = array_keys( $property_types );
    }

    $attributes = shortcode_atts(
        array(
            'post_type'    => $property_types, // Post Type.
            'status'       => array( 'current', 'sold', 'leased' ),
            'limit'        => '10', // Number of maximum posts to show.
            'offset'       => '', // Offset posts. When used, pagination is disabled.
            'author'       => '',  // Author of listings.
            'agent'        => '',  // Agent of listings.
            'featured'     => 0,   // Featured listings.
            'template'     => false, // Template can be set to "slim" for home open style template.
            'location'     => '', // Location slug. Should be a name like sorrento.
            'tools_top'    => 'off', // Tools before the loop like Sorter and Grid on or off.
            'tools_bottom' => 'off', // Tools after the loop like pagination on or off.
            'sortby'       => '', // Options: price, date, status, rand (for random) : Default date.
            'sort_order'   => 'DESC', // Sort by ASC or DESC.
            'query_object' => '', // only for internal use . if provided use it instead of custom query.
            'pagination'   => 'on', // Enable or disable pagination.
            'instance_id'  => '1', // Set instance ID when using multiple shortcodes on the same page.
            'class'        => '', // wrapper class.
        ),
        $atts
    );

    if ( is_string( $attributes['post_type'] ) && 'rental' === $attributes['post_type'] ) {
        $meta_key_price = 'property_rent';
    } else {
        $meta_key_price = 'property_price';
    }

    $sort_options = array(
        'price' => $meta_key_price,
        'date'  => 'post_date',
    );
    if ( ! is_array( $attributes['post_type'] ) ) {
        $attributes['post_type'] = array_map( 'trim', explode( ',', $attributes['post_type'] ) );
    }
    $paged = ( get_query_var( 'paged' ) ) ? get_query_var( 'paged' ) : 1;
    $args  = array(
        'post_type'      => $attributes['post_type'],
        'posts_per_page' => $attributes['limit'],
        'paged'          => absint( $paged ),
        'meta_query'     => array(),
    );

    // Offset query does not work with pagination.
    if ( ! empty( $attributes['offset'] ) ) {
        $args['offset']           = $attributes['offset'];
        $attributes['pagination'] = 'off'; // Disable pagination when offset is used.
    }

    $args['meta_query'] = epl_parse_atts( $atts );

    // Listings of specified author.
    if ( ! empty( $attributes['author'] ) ) {
        $attributes['author'] = (array) $attributes['author'];
        if ( is_array( $attributes['author'] ) ) {
            $author_ids           = array_map( 'epl_get_author_id_from_name', $attributes['author'] );
            $attributes['author'] = implode( ',', $author_ids );
        }
        $args['author'] = trim( $attributes['author'] );
    }

    // Listings by specified agent.
    if ( ! empty( $attributes['agent'] ) ) {
        $attributes['agent'] = array_map( 'trim', explode( ',', $attributes['agent'] ) );
        $attributes['agent'] = array_filter( $attributes['agent'] );
        $agent_meta_query    = array(
            'relation' => 'OR',
        );

        foreach ( $attributes['agent'] as $single_agent ) {
            $agent_meta_query[] = array(
                'key'     => 'property_agent',
                'value'   => array( $single_agent, sanitize_user( $single_agent ) ),
                'compare' => 'IN',
            );
            $agent_meta_query[] = array(
                'key'     => 'property_second_agent',
                'value'   => array( $single_agent, sanitize_user( $single_agent ) ),
                'compare' => 'IN',
            );
            if ( in_array( 'commercial', $attributes['post_type'], true ) ||
                in_array( 'commercial_land', $attributes['post_type'], true ) ||
                in_array( 'business', $attributes['post_type'], true )
            ) {

                $agent_meta_query[] = array(
                    'key'     => 'property_third_agent',
                    'value'   => array( $single_agent, sanitize_user( $single_agent ) ),
                    'compare' => 'IN',
                );
                $agent_meta_query[] = array(
                    'key'     => 'property_fourth_agent',
                    'value'   => array( $single_agent, sanitize_user( $single_agent ) ),
                    'compare' => 'IN',
                );

            }
        }

        $args['meta_query'][] = $agent_meta_query;
    }

    // Featured listings.
    if ( $attributes['featured'] ) {
        $args['meta_query'][] = array(
            'key'   => 'property_featured',
            'value' => 'yes',
        );
    }

    if ( ! empty( $attributes['location'] ) ) {
        if ( ! is_array( $attributes['location'] ) ) {
            $attributes['location'] = array_map( 'trim', explode( ',', $attributes['location'] ) );

            $args['tax_query'][] = array(
                'taxonomy' => 'location',
                'field'    => 'slug',
                'terms'    => $attributes['location'],
            );
        }
    }

    if ( ! empty( $attributes['status'] ) ) {
        if ( ! is_array( $attributes['status'] ) ) {
            $attributes['status'] = array_map( 'trim', explode( ',', $attributes['status'] ) );

            $args['meta_query'][] = array(
                'key'     => 'property_status',
                'value'   => $attributes['status'],
                'compare' => 'IN',
            );

            add_filter( 'epl_sorting_options', 'epl_sorting_options_callback' );
        }
    }

    if ( ! empty( $attributes['sortby'] ) ) {
        if ( 'price' === $attributes['sortby'] ) {
            $args['orderby']  = 'meta_value_num';
            $args['meta_key'] = $meta_key_price;
        } elseif ( 'rand' === $attributes['sortby'] ) {
            $args['orderby'] = 'rand';
        } elseif ( 'status' === $attributes['sortby'] ) {
            $args['orderby']  = 'meta_value';
            $args['meta_key'] = 'property_status';
        } else {
            $args['orderby'] = 'post_date';
            $args['order']   = 'DESC';
        }
        $args['order'] = $attributes['sort_order'];
    }

    $args['instance_id'] = $attributes['instance_id'];
    // add sortby arguments to query, if listings sorted by $_GET['sortby'];.
    $args = epl_add_orderby_args( $args, 'shortcode', 'listing' );

    // Option to filter args.
    $args = apply_filters( 'epl_shortcode_listing_args', $args, $attributes );

    $query_open = new WP_Query( $args );

    if ( is_object( $attributes['query_object'] ) ) {
        $query_open = $attributes['query_object'];
    }

    ob_start();
    epl_get_template_part(
        'shortcode-listing.php',
        array(
            'attributes' => $attributes,
            'query_open' => $query_open,
        )
    );
    return ob_get_clean();
}
add_shortcode( 'listing', 'epl_shortcode_listing_callback' );

/**
 * Listing Shortcode Sorting
 *
 * @param array $sorters Array of sorters.
 *
 * @return array
 * @since 1.0
 */
function epl_sorting_options_callback( $sorters ) {
    foreach ( $sorters as $key => &$sorter ) {
        if ( 'status_asc' === $sorter['id'] || 'status_desc' === $sorter['id'] ) {
            unset( $sorters[ $key ] );
        }
    }
    return $sorters;
}
Easy Property Listings 3.5.15 Code Reference API documentation generated by ApiGen