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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 
<?php
/**
 * Admin Reports Page
 *
 * @package     EPL
 * @subpackage  Admin/Reports
 * @copyright   Copyright (c) 2019, Merv Barrett
 * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License
 * @since       3.0
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
    exit;
}
// phpcs:disable WordPress.Security.NonceVerification
/**
 * Reports Page
 *
 * Renders the reports page contents.
 *
 * @since 3.0
 * @return void
 */
function epl_reports_page() {
    $current_page = admin_url( 'edit.php?post_type=download&page=epl-reports' );
    $active_tab   = isset( $_GET['tab'] ) ? sanitize_text_field( wp_unslash( $_GET['tab'] ) ) : 'reports';
    ?>
    <div class="wrap">
        <h1 class="nav-tab-wrapper">
            <a href="
            <?php
            echo esc_url(
                add_query_arg(
                    array(
                        'tab'              => 'reports',
                        'settings-updated' => false,
                    ),
                    $current_page
                )
            );
            ?>
            " class="nav-tab <?php echo 'reports' === $active_tab ? esc_attr( 'nav-tab-active' ) : ''; ?>"><?php esc_html_e( 'Reports', 'easy-property-listings' ); ?></a>
            <?php do_action( 'epl_reports_tabs' ); ?>
        </h1>

        <?php
        do_action( 'epl_reports_page_top' );
        do_action( 'epl_reports_tab_' . $active_tab );
        do_action( 'epl_reports_page_bottom' );
        ?>
    </div><!-- .wrap -->
    <?php
}

/**
 * Default Report Views
 *
 * @since 3.0
 * @return array $views Report Views
 */
function epl_reports_default_views() {

    $views = apply_filters( 'epl_report_views', epl_get_active_post_types() );

    return $views;
}

/**
 * Default Report Views
 *
 * Checks the $_GET['view'] parameter to ensure it exists within the default allowed views.
 *
 * @param string $default Default view to use.
 *
 * @since 3.0
 * @return string $view Report View
 */
function epl_get_reporting_view( $default = 'property' ) {

    if ( ! isset( $_GET['view'] ) || ! in_array( $_GET['view'], array_keys( epl_reports_default_views() ), true ) ) {
        $view = $default;
    } else {
        $view = sanitize_text_field( wp_unslash( $_GET['view'] ) );
    }

    return apply_filters( 'epl_get_reporting_view', $view );
}

/**
 * Renders the Reports page
 *
 * @since 3.0
 * @return void
 */
function epl_reports_tab_reports() {

    if ( ! is_admin() || ! epl_reports_access() ) {
        wp_die( esc_html__( 'You do not have permission to access this report', 'easy-property-listings' ), esc_html__( 'Error', 'easy-property-listings' ), array( 'response' => 403 ) );
    }

    $current_view = 'property';
    $views        = epl_reports_default_views();

    if ( isset( $_GET['view'] ) && array_key_exists( sanitize_text_field( wp_unslash( $_GET['view'] ) ), $views ) ) {
        $current_view = sanitize_text_field( wp_unslash( $_GET['view'] ) );
    }

    do_action( 'epl_reports_view_' . $current_view );

}
add_action( 'epl_reports_tab_reports', 'epl_reports_tab_reports' );

/**
 * Renders the Reports Page Views Drop Downs
 *
 * @since 3.0
 * @return void
 */
function epl_report_views() {

    if ( ! is_admin() || ! epl_reports_access() ) {
        return;
    }

    $views        = epl_reports_default_views();
    $current_view = isset( $_GET['view'] ) ? sanitize_text_field( wp_unslash( $_GET['view'] ) ) : 'property';
    ?>
    <form id="epl-reports-filter" method="get">
        <select id="epl-reports-view" name="view">
            <option value="-1"><?php esc_html_e( 'Report Type', 'easy-property-listings' ); ?></option>
            <?php foreach ( $views as $view_id => $label ) : ?>
                <option value="<?php echo esc_attr( $view_id ); ?>" <?php selected( $view_id, $current_view ); ?>><?php echo esc_attr( $label ); ?></option>
            <?php endforeach; ?>
        </select>

        <?php do_action( 'epl_report_view_actions' ); ?>

        <input type="hidden" name="page" value="epl-reports"/>
        <?php submit_button( __( 'Show', 'easy-property-listings' ), 'secondary', 'submit', false ); ?>
    </form>
    <?php
    do_action( 'epl_report_view_actions_after' );
}

/**
 * Renders the Reports property Graphs
 *
 * @since 3.0
 * @return void
 */
function epl_reports_property() {

    if ( ! is_admin() || ! epl_reports_access() ) {
        return;
    }
    ?>
    <div class="tablenav top">
        <div class="alignleft actions"><?php epl_report_views(); ?></div>
    </div>
    <?php
    epl_reports_graph( 'sold', 'current', '#e50000', '#a5df41' );
}
add_action( 'epl_reports_view_property', 'epl_reports_property' );

/**
 * Renders the Reports rental Graphs
 *
 * @since 3.0
 * @return void
 */
function epl_reports_rental() {

    if ( ! is_admin() || ! epl_reports_access() ) {
        return;
    }
    ?>
    <div class="tablenav top">
        <div class="alignleft actions"><?php epl_report_views(); ?></div>
    </div>
    <?php
    epl_reports_graph( 'leased', 'current', '#e50000', '#a5df41' );
}
add_action( 'epl_reports_view_rental', 'epl_reports_rental' );

/**
 * Renders the Reports land Graphs
 *
 * @since 3.0
 * @return void
 */
function epl_reports_land() {

    if ( ! is_admin() || ! epl_reports_access() ) {
        return;
    }
    ?>
    <div class="tablenav top">
        <div class="alignleft actions"><?php epl_report_views(); ?></div>
    </div>
    <?php
    epl_reports_graph( 'sold', 'current', '#e50000', '#a5df41' );
}
add_action( 'epl_reports_view_land', 'epl_reports_land' );

/**
 * Renders the Reports land Graphs
 *
 * @since 3.0
 * @return void
 */
function epl_reports_commercial() {

    if ( ! is_admin() || ! epl_reports_access() ) {
        return;
    }
    ?>
    <div class="tablenav top">
        <div class="alignleft actions"><?php epl_report_views(); ?></div>
    </div>
    <?php
    epl_reports_graph( 'sold', 'current', '#e50000', '#a5df41' );
}
add_action( 'epl_reports_view_commercial', 'epl_reports_commercial' );

/**
 * Renders the Reports land Graphs
 *
 * @since 3.0
 * @return void
 */
function epl_reports_commercial_land() {

    if ( ! is_admin() || ! epl_reports_access() ) {
        return;
    }
    ?>
    <div class="tablenav top">
        <div class="alignleft actions"><?php epl_report_views(); ?></div>
    </div>
    <?php
    epl_reports_graph( 'sold', 'current', '#e50000', '#a5df41' );
}
add_action( 'epl_reports_view_commercial_land', 'epl_reports_commercial_land' );

/**
 * Renders the Reports land Graphs
 *
 * @since 3.0
 * @return void
 */
function epl_reports_business() {

    if ( ! is_admin() || ! epl_reports_access() ) {
        return;
    }
    ?>
    <div class="tablenav top">
        <div class="alignleft actions"><?php epl_report_views(); ?></div>
    </div>
    <?php
    epl_reports_graph( 'sold', 'current', '#e50000', '#a5df41' );
}
add_action( 'epl_reports_view_business', 'epl_reports_business' );

/**
 * Renders the Reports land Graphs
 *
 * @since 3.0
 * @return void
 */
function epl_reports_rural() {

    if ( ! is_admin() || ! epl_reports_access() ) {
        return;
    }
    ?>
    <div class="tablenav top">
        <div class="alignleft actions"><?php epl_report_views(); ?></div>
    </div>
    <?php
    epl_reports_graph( 'sold', 'current', '#e50000', '#a5df41' );
}
add_action( 'epl_reports_view_rural', 'epl_reports_rural' );

/**
 * Reports Access Roles
 *
 * @since  3.0
 */
function epl_reports_access() {
    $allowed = epl_get_option( 'min_reports_access' );
    $allowed = empty( $allowed ) ? 'level_10' : $allowed;
    return current_user_can( $allowed ) ? true : false;
}
Easy Property Listings 3.5.15 Code Reference API documentation generated by ApiGen