Difference between revisions of "JReviews:Developers Filters"

From JReviews Documentation
Jump to: navigation, search
Line 344: Line 344:
  
 
==== Description ====
 
==== Description ====
 +
 +
The "trusted_on_create_listing" filter is used to filter the moderation setting when a new listing is created.
  
 
==== Usage ====
 
==== Usage ====
  
−
  57:   return $this->filteredResponse($trust,'trusted_on_create_listing');
+
When the "trusted_on_create_listing" filter is called, it is passed two arguments. The first argument is the current value of the moderation setting. The value is true when the user is trusted to create listings without moderation and false otherwise. The second argument is an associative array with context data.
 +
 
 +
==== Examples ====
 +
 
 +
===== Trust Listing Submission From Users With Published Listings =====
 +
 
 +
<source lang="php">
 +
function trust_published_listing_users($trust, $params)
 +
{
 +
  // Uncomment line below to dump filter arguments to the screen
 +
  // dd($trust, $params);
 +
 
 +
  $userId = (int) $params['data']['Listing']['created_by'];
 +
 
 +
  if ( $userId > 0 )
 +
  {
 +
    $Model = new S2Model();
 +
 
 +
    $query = sprintf('SELECT count(*) FROM %s WHERE %s = %d AND state = 1', EverywhereComContentModel::_LISTING_TABLE, EverywhereComContentModel::_LISTING_USER_ID, $userId);
 +
 
 +
    $count = $Model->query($query,'loadResult');
 +
 
 +
    if ( $count > 0 )
 +
    {
 +
      return true;
 +
    }
 +
  }
 +
 
 +
  return $trust;
 +
}
 +
 
 +
Clickfwd\Hook\Filter::add('trusted_on_create_listing', 'trust_published_listing_users', 10);
 +
</source>
  
 
=== Listing Allows Claims ===
 
=== Listing Allows Claims ===

Revision as of 18:27, 14 February 2018

JReviews 3 comes with Filters that allow you to make certain types of customizations and extend the functionality of JReviews without having to modify core files.

Contents


What is a Filter?

JReviews has many filter hooks strategically placed in the code at points where you may want to change or override the value of a variable at runtime.

Filters can modify data by binding a callback function to a filter hook. When the filter is executed, each callback function is run in order of priority, and can modify the filtered data by returning a new value.

For example, you can use a filter to:

  • Change the page title and metatags of different pages
  • Override the permissions of specific users or user groups for different events (creating listings, reviews, etc.)
  • Add or remove CSS and Scripts to and from the page.

Defining a new Filter Hook

JReviews 3 already comes with many filter hooks and we'll add more over time. However, if you need to create a new filter that is not yet available you would use the following syntax: 

$data = \Clickfwd\Hook\Filter::filter('example_filter_name', $data, ['foo'=>$bar]);

Where:

  • $data is the variable that can be modified by filter callback function
  • $params are other arguments that can be passed to the filter callback function to provide context and their values cannot be modified by the filter.

Using Filter Functions

The following example shows how a callback function is bound to a filter hook: 

function example_filter_callback_function($data, $params = [])
{
   // Modify $data in some way and return it
   return $data;
}
 
Clickfwd\Hook\Filter::add('example_filter_name', 'example_filter_callback_function', $priority = 10);

The $data variable can be modified inside the callback function and must always be returned at the end of the function.

To create new filter functions that are not overwritten on upgrades, create a new file in overrides and place your filter functions there:

Joomla 

/templates/jreviews_overrides/filters/filter_functions.php

WordPress 

/jreviews_overrides/filters/filter_functions.php

Available Filters

Notifications

Listing Inquiry Email Payload

Description

The "modify_inquiry_sender_info" filter is used to filter the inquiry email payload before the email is sent.

Usage

When the "modify_inquiry_sender_info" filter is called, it is passed two arguments. The first argument is an associative array with the email payload ($to, $bcc, $fromEmail, $fromName, $subject, $body). The second argument is an associative array with context data for the $listing and $event that triggered the email. $event is an object that allows retrieving sender user ID and IP address information.

Examples

Modify sender name and email

By default when an inquiry email is sent, the sender name and e-mail address are populated with the information entered in the inquiry form. This allows the recipient of the inquiry to reply directly to the sender. However, in some cases, you may not want the recipient to reply directly to the sender and you can use this filter to modify the email values before it is sent. 

function modify_inquiry_sender_info($payload)
{
   $payload['fromEmail'] = '[email protected]';
 
   $payload['fromName'] = 'John Smith';
 
   return $payload;
}
 
Clickfwd\Hook\Filter::add('listing_inquiry_email_payload', 'modify_inquiry_sender_info', 10);

Asset Manager

Asset Manager Stylesheets

Description

The "asset_manager_stylesheets" filter is used to filter the stylesheets loaded by JReviews and Add-ons.

Usage

When the "asset_manager_stylesheets" filter is called, it is passed an associative array containing the paths of the stylesheets that will be loaded on the page. The array contains keys for different namespaces used to load stylesheets so it's possible to control the order in which these are loaded. The namespaces are: addon, core, bottom, and top.

Examples

Unload jQuery UI Stylesheet

It is possible to stop specific stylesheets from loading if you want to use your own stylesheets or have already overwritten them in your site's stylesheet. 

function remove_stylesheets($stylesheets)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($stylesheets);
  unset($stylesheets['core']['jquery_ui_theme/jquery-ui-1.9.2.custom.css']);
 
  return $stylesheets;
}
 
Clickfwd\Hook\Filter::add('asset_manager_stylesheets', 'remove_stylesheets', 10);

Asset Manager Scripts

Description

The "asset_manager_scripts" filter is used to filter the scripts loaded by JReviews and Add-ons.

Usage

When the "asset_manager_scripts" filter is called, it is passed an associative array containing the paths of the scripts that will be loaded on the page. The array contains keys for different namespaces used to load scripts so it's possible to control the order in which these are loaded. The namespaces are: addon, core, bottom, and top.

Examples

Unload bxSlider Script
function remove_scripts($scripts)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($scripts);
  unset($jsArray['top']['bxslider-4/jquery.bxslider.min.js']);
 
  return $scripts;
}
 
Clickfwd\Hook\Filter::add('asset_manager_scripts', 'remove_scripts', 10);

Metatags

Page Title Tag

Description

The "page_title_metatag" filter is used to filter the page title tag.

Usage

When the "page_title_metatag" filter is called, it is passed two arguments. The first argument is the page title. The second argument is an associative array with context data. 

function page_title_tag($title, $params)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($title, $params); 
 
  return $title;
}
 
Clickfwd\Hook\Filter::add('page_title_metatag', 'page_title_tag', 10);

Page Robots Metatag

Description

The "page_robots_metatag" filter is used to filter the page robots metatag so you can change the indexing rules for specific pages.

Usage

When the "page_robots_metatag" filter is called, it is passed two arguments. The first argument is the current value of the robots metatag. The second argument is an associative array with context data. 

function change_robots_metatag($robots, $params)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($robots, $params); 
 
  return $robots;
}
 
Clickfwd\Hook\Filter::add('page_robots_metatag', 'change_robots_metatag', 10);

Page Keywords Metatag

Description

The "page_keywords_metatag" filter is used to filter the page keywords metatag.

Usage

When the "page_keywords_metatag" filter is called, it is passed two arguments. The first argument is the current value of the keywords metatag. The second argument is an associative array with context data. 

function change_keywords_metatag($keywords, $params)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($keywords, $params); 
 
  return $keywords;
}
 
Clickfwd\Hook\Filter::add('page_keywords_metatag', 'change_keywords_metatag', 10);

Page Description Metatag

Description

The "page_description_metatag" filter is used to filter the page description metatag.

Usage

When the "page_description_metatag" filter is called, it is passed two arguments. The first argument is the current value of the description metatag. The second argument is an associative array with context data. 

function change_description_metatag($description, $params)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($description, $params); 
 
  return $description;
}
 
Clickfwd\Hook\Filter::add('page_description_metatag', 'change_description_metatag', 10);

Page Canonical Metatag

Description

The "page_canonical_metatag" filter is used to filter the page canonical URL.

Usage

When the "page_canonical_metatag" filter is called, it is passed two arguments. The first argument is the current value of the canonical link URL. The second argument is an associative array with context data. 

function change_canonical_metatag($url, $params)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($url, $params); 
 
  return $url;
}
 
Clickfwd\Hook\Filter::add('page_canonical_metatag', 'change_canonical_metatag', 10);

Page Prev Metatag

Description

The "page_canonical_metatag" filter is used to filter the page prev metatag.

Usage

When the "page_canonical_metatag" filter is called, it is passed two arguments. The first argument is the current value of the prev link URL. The second argument is an associative array with context data. 

function change_prev_metatag($url, $params)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($url, $params); 
 
  return $url;
}
 
Clickfwd\Hook\Filter::add('page_prev_metatag', 'change_prev_metatag', 10);

Page Next Metatag

Description

The "page_next_metatag" filter is used to filter the page next metatag.

Usage

When the "page_next_metatag" filter is called, it is passed two arguments. The first argument is the current value of the next link URL. The second argument is an associative array with context data. 

function change_next_metatag($url, $params)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($url, $params); 
 
  return $url;
}
 
Clickfwd\Hook\Filter::add('page_next_metatag', 'change_next_metatag', 10);

Listing Detail

Listing Detail Action Buttons

Description

The "listing_detail_action_buttons" filter is used to filter the page next metatag.

Usage

When the "listing_detail_action_buttons" filter is called, it is passed two arguments. The first argument is an associative array of button positions, allowing adding new buttons . The second argument is an associative array with context data.

You can insert buttons in positions 1 through 9.

Examples

Add EasySocial Message Button
function add_easysocial_message_button($positions, $params)
{
  $listing = $params['listing'];
 
  $button = '
    <button type="button" class="jrButton jrSmall"
    data-ck-chat="'.$listing['User']['user_id'].'">
    <i class="fa fa-commenting" aria-hidden="true"></i>
    Contact This Member
    </button>
  ';
 
  $positions[7][] = $button;
 
  return $positions;
}

Listing Permissions

Trusted On Listing Create

Description

The "trusted_on_create_listing" filter is used to filter the moderation setting when a new listing is created.

Usage

When the "trusted_on_create_listing" filter is called, it is passed two arguments. The first argument is the current value of the moderation setting. The value is true when the user is trusted to create listings without moderation and false otherwise. The second argument is an associative array with context data.

Examples

Trust Listing Submission From Users With Published Listings
function trust_published_listing_users($trust, $params)
{
  // Uncomment line below to dump filter arguments to the screen
  // dd($trust, $params);
 
  $userId = (int) $params['data']['Listing']['created_by'];
 
  if ( $userId > 0 )
  {
    $Model = new S2Model();
 
    $query = sprintf('SELECT count(*) FROM %s WHERE %s = %d AND state = 1', EverywhereComContentModel::_LISTING_TABLE, EverywhereComContentModel::_LISTING_USER_ID, $userId);
 
    $count = $Model->query($query,'loadResult');
 
    if ( $count > 0 )
    {
      return true;
    }
  }
 
  return $trust;
}
 
Clickfwd\Hook\Filter::add('trusted_on_create_listing', 'trust_published_listing_users', 10);

Listing Allows Claims

Description

Usage

  85:    return $this->filteredResponse($permission,'listing_allows_claims',$listing);

Listing Allows Inquiries

Description

Usage

 132:    return $this->filteredResponse($permission,'listing_allows_inquiries',$listing);


Listing Allows Favorites

Description

Usage

 150:    return $this->filteredResponse($permission,'listing_allows_favorites',$listing);

Listing Allows User Reviews

Description

Usage

 173:    return $this->filteredResponse($permission,'listing_allows_user_reviews',$listing);

Listing Allows Editor Reviews

Description

Usage

 191:    return $this->filteredResponse($permission,'listing_allows_editor_reviews',$listing);

Listing User Reviews Open

Description

Usage

 207:    return $this->filteredResponse($permission,'listing_user_reviews_opened',$listing);

Listing Editor Reviews Open

Description

Usage

 223:    return $this->filteredResponse($permission,'listing_editor_reviews_opened',$listing);

Can Create Listing

Description

Usage

 251:    $permission = $this->filteredResponse($permission,'can_create_listing',[$listingTypeId]);

Can Update Listing

Description

Usage

 278:    return $this->filteredResponse($permission,'can_update_listing',$listing);

Can Add Listing Metadata

Description

Usage

 296:    return $this->filteredResponse($permission,'can_add_listing_metadata',$listingType);

Can User WYSIWYG Editor in Listing

Description

Usage

 312:    return $this->filteredResponse($permission,'can_use_editor_in_listing',[]);

Can Publish Listing

Description

Usage

 334:    return $this->filteredResponse($permission,'can_publish_listing',$listing);

Can Delete Listing

Description

Usage

 356:    return $this->filteredResponse($permission,'can_delete_listing',$listing);

Can Claim Listing

Description

Usage

 374:    return $this->filteredResponse($permission,'can_claim_listing',$listing);

Can Send Listing Inquiry

Description

Usage

 390:    return $this->filteredResponse($permission,'can_send_listing_inquiry',$listing);

Can Favorite Listing

Description

Usage

 406:    return $this->filteredResponse($permission,'can_favorite_listing',$listing);

Can Feature Listing

Description

Usage

 420:    return $this->filteredResponse($permission,'can_feature_listing',[]);

Can Create User Review For Listing

Description

Usage

 496:    return $this->filteredResponse($permission,'can_create_user_review_for_listing',$listing,$this->getMessage());

Can Create Editor Review For Listing

Description

Usage

 546:    return $this->filteredResponse($permission,'can_create_editor_review_for_listing',$listing,$this->getMessage());

Can Add Review on Listing Create

Description

Usage

 564:    return $this->filteredResponse($permission,'can_add_review_on_listing_create',$listingType);

Can Update Listing Media

Description

Usage

 586:    return $this->filteredResponse($permission,'can_update_listing_media',[$listing,$listingType]);

Can Upload Listing Media

Description

Usage

 624:    return $this->filteredResponse($permission,'can_upload_listing_media',[$listing,$listingType]);

Can Upload Listing Media From URL

Description

Usage

 644:    return $this->filteredResponse($permission,'can_upload_media_from_url_in_listing',$listing);

Can Upload Listing Photo

Description

Usage

 662:    return $this->filteredResponse($permission,'can_upload_listing_photo',[$listing,$listingType]);

Can Upload Listing Video

Description

Usage

 680:    return $this->filteredResponse($permission,'can_upload_listing_video');

Can Upload Listing Audio

Description

Usage

 698:    return $this->filteredResponse($permission,'can_upload_listing_audio',[$listing,$listingType]);

Can Upload Listing Attachment

Description

Usage

 716:    return $this->filteredResponse($permission,'can_upload_listing_attachment',[$listing,$listingType]);

Media Permissions

Trusted On Create Photo

Description

Usage

  30:    return $this->filteredResponse($trust,'trusted_on_create_photo');

Trusted On Create Video

Description

Usage

  49:    return $this->filteredResponse($trust,'trusted_on_create_video');

Trusted On Create Audio

Description

Usage

  68:    return $this->filteredResponse($trust,'trusted_on_create_audio');

Trusted On Create Attachment

Description

Usage

  87:    return $this->filteredResponse($trust,'trusted_on_create_attachment');

Media Allows Voting

Description

Usage

 105:    return $this->filteredResponse($permission,'media_allows_voting',$listing);

Media Allows Report

Description

Usage

 121:    return $this->filteredResponse($permission,'media_allows_report',$listing);

Can Update Media In Listing

Description

Usage

 149:    return $this->filteredResponse($permission,'can_update_media_in_listing',[$listing,$media]);

Can Delete Media In Listing

Description

Usage

 177:    return $this->filteredResponse($permission,'can_delete_media_in_listing',[$listing,$media]);

Can Publish Media In Listing

Description

Usage

 205:    return $this->filteredResponse($permission,'can_publish_media_in_listing',[$listing,$media]);

Can Set Main Media

Description

Usage

 237:    return $this->filteredResponse($permission,'can_set_main_media',[$listing,$media]);

Can Update Media Details

Description

Usage

 259:    return $this->filteredResponse($permission,'can_update_media_details',[$listing,$media]);

Can Vote on Media

Description

Usage

 286:    return $this->filteredResponse($permission,'can_vote_on_media',[$listing,$media]);

Can Report Media

Description

Usage

 302:    return $this->filteredResponse($permission,'can_report_media',$listing);

Can Download Attachment

Description

Usage

 323:    return $this->filteredResponse($permission,'can_download_attachment',$media);

Review Permissions

Trusted on Create User Review

Description

Usage

  28:    return $this->filteredResponse($trust,'trusted_on_create_user_review');

Trusted on Update User Review

Description

Usage

  45:    return $this->filteredResponse($trust,'trusted_on_update_user_review');

Trusted on Create Editor Review

Description

Usage

  58:    return $this->filteredResponse($trust,'trusted_on_create_editor_review');

Trusted on Update Editor Review

Description

Usage

  71:    return $this->filteredResponse($trust,'trusted_on_update_editor_review');

Trusted on Create Review Owner Reply

Description

Usage

  84:    return $this->filteredResponse($trust,'trusted_on_create_review_owner_reply');

Review Allows Report

Description

Usage

 104:    return $this->filteredResponse($permission,'review_allows_report',$review);

Review Allows Voting

Description

Usage

 124:    return $this->filteredResponse($permission,'review_allows_voting',$review);

Review Allows Replies

Description

Usage

 140:    return $this->filteredResponse($permission,'review_allows_replies',$review);

Review Allows Discussions

Description

Usage

 156:    return $this->filteredResponse($permission,'review_allows_discussions',$review);

Can Update Review

Description

Usage

 180:    return $this->filteredResponse($permission,'can_update_review',$review);

Can Reply To Review

Description

Usage

 204:    return $this->filteredResponse($permission,'can_reply_to_review',[$listing,$review]);

Can Delete Review Reply

Description

Usage

 220:    return $this->filteredResponse($permission,'can_delete_review_reply',$listing);

Can Report Review

Description

Usage

 236:    return $this->filteredResponse($permission,'can_report_review',$review);

Can Vote On Review

Description

Usage

 261:    return $this->filteredResponse($permission,'can_vote_on_review',$review);

Can Create Review Comment

Description

Usage

 279:    return $this->filteredResponse($permission,'can_create_review_post',$review);

Can Upload Review Media

Description

Usage

 319:    return $this->filteredResponse($permission,'can_upload_review_media',$review);

Can Upload Review Media From URL

Description

Usage

 337:    return $this->filteredResponse($permission,'can_upload_media_from_url_in_review',$review);

Can Upload Review Photo

Description

Usage

 353:    return $this->filteredResponse($permission,'can_upload_review_photo',$review);

Can Upload Review Video

Description

Usage

 369:    return $this->filteredResponse($permission,'can_upload_review_video',$review);

Can Upload Review Audio

Description

Usage

 385:    return $this->filteredResponse($permission,'can_upload_review_audio',$review);

Can Upload Review Attachment

Description

Usage

 401:    return $this->filteredResponse($permission,'can_upload_review_attachment',$review);

Review Discussion Permissions

Trusted on Create Review Discussion

Description

Usage

  26:    return $this->filteredResponse($trust,'trusted_on_create_review_discussion');

Review Discussion Allows Report

Description

Usage

  48:    return $this->filteredResponse($permission,'review_discussion_allows_report',$post);

Can Report Review Discussion

Description

Usage

  64:    return $this->filteredResponse($permission,'can_report_review_discussion',$post);

Can Update Review Discussion

Description

Usage

  86:    return $this->filteredResponse($permission,'can_update_review_discussion',[$post,$review]);

Can Delete Review Discussion

Description

Usage

 108:    return $this->filteredResponse($permission,'can_delete_review_discussion',[$post,$review]);

Field Permissions

Can View Field in Listing Detail Page

Description

Usage

  59:    return $this->filteredResponse($permission,'can_view_field_in_detail_page',$field);

Can View Field in Listing Detail Page

Description

Usage

  59:    return $this->filteredResponse($permission,'can_view_field_in_list_page',$field);

Can View Field in Listing Detail Page

Description

Usage

  59:    return $this->filteredResponse($permission,'can_view_field_in_comparison_page',$field);

Can Read Field

Description

Usage

  87:    return $this->filteredResponse($permission,'can_read_field',[$fname]);

Can Write Field

Description

Usage

 115:    return $this->filteredResponse($permission,'can_write_field',[$fname]);
Retrieved from "https://docs.jreviews.com/index.php?title=JReviews:Developers_Filters&oldid=4509"