19min
How to Develop Custom Rules For the Conditional Display Option

Thrive Architect gives you the possibility to register your own custom conditional display rules. This article will show you how you can create them. 
Please note that creating custom rules is an action that should be performed by developers or more tech-savvy persons, as it does require technical knowledge. 
Example 1: You can add a new field, called "Page - Demo" with a subfield called "Title - Demo". It will also add a field called "Number of comments - Demo" to the already existing "User" entity. 
After activating the plugin, the new fields will be visible in the conditional display pop-up of Thrive Architect:
﻿
﻿

Note: You can find this demo example on GitHub, here.
Example 2: we'll show how to create a new rule that is conditioned by whether the user has WP Fusion tags assigned to them or not. 
﻿
﻿
Here are the steps to be taken in order to create a new rule: 
→ Define the entity classFirstly, an entity class will have to be defined. This should describe the subject/entity, as well as its properties.

PHP
|
<?php
class User extends \TCB\ConditionalDisplay\Entity
/**
* @return string
*/
<?php
class User extends \TCB\ConditionalDisplay\Entity
/**
* @return string
*/
﻿
→ Extend the entity class and define specific properties to describe your subjectThe get_key function defines a unique identification key for the entity:
PHP
|
<?php
public static function get_key() {
return 'user_data';
}
<?php
public static function get_key() {
return 'user_data';
}
﻿
The get_label function defines the name of the entity that will be visible to the users.
This will appear inside the visual editor.
PHP
|
<?php
public static function get_label() {
return esc_html__( 'User', 'thrive-cb' );
}
<?php
public static function get_label() {
return esc_html__( 'User', 'thrive-cb' );
}
﻿
The create_object property, upon running the condition logic, will create the entity object containing all the data representing individual fields.

PHP
|
<?php
public function create_object( $param ) {
$user_id = get_current_user_id();

return get_userdata( $user_id );
}
/**
* Determines the display order in the modal entity select
*
* @return int
*/
public static function get_display_order() {
return 0;
}
<?php
public function create_object( $param ) {
$user_id = get_current_user_id();

return get_userdata( $user_id );
}
/**
* Determines the display order in the modal entity select
*
* @return int
*/
public static function get_display_order() {
return 0;
}
﻿
→ Register entity class using the tve_register_condition_entity functionPHP
|
<?php
function tve_register_condition_entity( $entity ) {
TCB\ConditionalDisplay\Entity::register( $entity );
}
<?php
function tve_register_condition_entity( $entity ) {
TCB\ConditionalDisplay\Entity::register( $entity );
}
﻿
As a result, once you put everything together, the code snippet will look like this:
PHP
|
<?php
class User extends \TCB\ConditionalDisplay\Entity {
   /**
   * @return string
   */
   public static function get_key() {
      return 'user_data';
   }

   public static function get_label() {
      return esc_html__( 'User', 'thrive-cb' );
   }

   public function create_object( $param ) {
      $user_id = get_current_user_id();

      return get_userdata( $user_id );
   }

/**
* Determines the display order in the modal entity select
*
* @return int
*/
   public static function get_display_order() {
      return 0;
   }
<?php
class User extends \TCB\ConditionalDisplay\Entity {
   /**
   * @return string
   */
   public static function get_key() {
      return 'user_data';
   }

   public static function get_label() {
      return esc_html__( 'User', 'thrive-cb' );
   }

   public function create_object( $param ) {
      $user_id = get_current_user_id();

      return get_userdata( $user_id );
   }

/**
* Determines the display order in the modal entity select
*
* @return int
*/
   public static function get_display_order() {
      return 0;
   }
﻿
→ Create an entity field that will be used to fetch the specific entity data which the condition will be tested onExample (in the visual editor): 
﻿
﻿
→ Extend the field class and define specific properties to describe your field
﻿
﻿
PHP
|
<?php
class User_Wpfusion_Tags extends \TCB\ConditionalDisplay\Field {
/**
* @return string
*/
<?php
class User_Wpfusion_Tags extends \TCB\ConditionalDisplay\Field {
/**
* @return string
*/
﻿
The get_key function defines a unique identification key for the field.
PHP
|
<?php
public static function get_key() {
   return 'user_wpfusion_tags';
}
<?php
public static function get_key() {
   return 'user_wpfusion_tags';
}
﻿
The get_label function defines the name of the field that will be visible to the users.
This will appear inside the visual editor.
PHP
|
<?php
public static function get_label() {
return __( 'Has WP Fusion tags', TVE_DASH_TRANSLATE_DOMAIN );
}

<?php
public static function get_label() {
return __( 'Has WP Fusion tags', TVE_DASH_TRANSLATE_DOMAIN );
}
﻿
The get_conditions property describes the type of condition that the field data represents.
PHP
|
<?php
public static function get_conditions() {
   return [ 'autocomplete' ];
}

/**
* @return string
*/

public static function get_entity() {
   return 'user_data';
}
<?php
public static function get_conditions() {
   return [ 'autocomplete' ];
}

/**
* @return string
*/

public static function get_entity() {
   return 'user_data';
}
﻿
The get_conditions type can be one of the registered types of conditions that extend the condition class, or you can create your own and register it, using the tve_register_condition function:
PHP
|
<?php
/**
* Register a new condition
*
* @param \TCB\ConditionalDisplay\Condition\string $condition
*/
function tve_register_condition( $condition ) {
   TCB\ConditionalDisplay\Condition:: register ( $condition 0;
}
<?php
/**
* Register a new condition
*
* @param \TCB\ConditionalDisplay\Condition\string $condition
*/
function tve_register_condition( $condition ) {
   TCB\ConditionalDisplay\Condition:: register ( $condition 0;
}
﻿
Use the condition class as a parameter. 
The get_value property has to be defined. This will fetch the value from the entity upon running the condition logic.
PHP
|
<?php
public function get_value( $user_data ) {
   $tags = wp_fusion()->user->get_tags( $user_data->ID );
   return empty( $tags ) ? '' : $tags;
}
public static function get_options( $selected_values = [], $searched_keyword = '' ) {
$levels = [];
<?php
public function get_value( $user_data ) {
   $tags = wp_fusion()->user->get_tags( $user_data->ID );
   return empty( $tags ) ? '' : $tags;
}
public static function get_options( $selected_values = [], $searched_keyword = '' ) {
$levels = [];
﻿

The $user_data parameter will contain the entity data object.
→ For multiple-choice fields:The property get_options has to be defined and the values/label pairs of options have to be provided.

PHP
|
<?php
public static function get_options( $selected_values = [], $searched_keyword = '' ) {
$levels = [];

   foreach ( wp_fusion()->settings->get_available_tags_flat() as $tag ) {
      if ( static::filter_options( $tag, $tag, $selected_values, $searched_keyword ) ) {
         $levels[] = [
            'value' => (string) $tag,
            'label' => $tag,
         ];
      }
   }
return $levels;
}
<?php
public static function get_options( $selected_values = [], $searched_keyword = '' ) {
$levels = [];

   foreach ( wp_fusion()->settings->get_available_tags_flat() as $tag ) {
      if ( static::filter_options( $tag, $tag, $selected_values, $searched_keyword ) ) {
         $levels[] = [
            'value' => (string) $tag,
            'label' => $tag,
         ];
      }
   }
return $levels;
}
﻿
$selected_values will contain the values already chosen;
$searched_keyword will be used to filter dropdown results;
As a result, once you put everything together, the code snippet looks like this:
PHP
|
<?php
class User_Wpfusion_Tags extends \TCB\ConditionalDisplay\Field {
/**
* @return string
*/
   public static function get_key() {
      return 'user_wpfusion_tags';
   }

   public static function get_label() {
      return __( 'Has WP Fusion tags', TVE_DASH_TRANSLATE_DOMAIN );
   }

   public static function get_conditions() {
      return [ 'autocomplete' ];
   }

/**
* @return string
*/

   public static function get_entity() {
      return 'user_data';
   }

   public function get_value( $user_data ) {
      $tags = wp_fusion()->user->get_tags( $user_data->ID );
      return empty( $tags ) ? '' : $tags;
   }

   public static function get_options( $selected_values = [],  $searched_keyword = '' ) {
      $levels = [];

      foreach ( wp_fusion()->settings->get_available_tags_flat() as $tag ) {
         if ( static::filter_options( $tag, $tag, $selected_values, $searched_keyword ) ) {
            $levels[] = [
               'value' => (string) $tag,
               'label' => $tag,
            ];
         }
      }

      return $levels;
}

   public static function get_autocomplete_placeholder() {
      return __( 'Search tags', TVE_DASH_TRANSLATE_DOMAIN );
}
}
<?php
class User_Wpfusion_Tags extends \TCB\ConditionalDisplay\Field {
/**
* @return string
*/
   public static function get_key() {
      return 'user_wpfusion_tags';
   }

   public static function get_label() {
      return __( 'Has WP Fusion tags', TVE_DASH_TRANSLATE_DOMAIN );
   }

   public static function get_conditions() {
      return [ 'autocomplete' ];
   }

/**
* @return string
*/

   public static function get_entity() {
      return 'user_data';
   }

   public function get_value( $user_data ) {
      $tags = wp_fusion()->user->get_tags( $user_data->ID );
      return empty( $tags ) ? '' : $tags;
   }

   public static function get_options( $selected_values = [],  $searched_keyword = '' ) {
      $levels = [];

      foreach ( wp_fusion()->settings->get_available_tags_flat() as $tag ) {
         if ( static::filter_options( $tag, $tag, $selected_values, $searched_keyword ) ) {
            $levels[] = [
               'value' => (string) $tag,
               'label' => $tag,
            ];
         }
      }

      return $levels;
}

   public static function get_autocomplete_placeholder() {
      return __( 'Search tags', TVE_DASH_TRANSLATE_DOMAIN );
}
}
﻿
→ Register the field class using the tve_register_condition_field functionPHP
|
<?php
/**
*Register a new condition field
*
*@param TCB\ConditionalDisplay\Field|string $field
*/

function tve_register_condition_field( $field ) {
   TCB\ConditionalDisplay\Field::register( $field );
}
<?php
/**
*Register a new condition field
*
*@param TCB\ConditionalDisplay\Field|string $field
*/

function tve_register_condition_field( $field ) {
   TCB\ConditionalDisplay\Field::register( $field );
}
﻿
﻿
Updated 03 Mar 2023
Did this page help you?
Yes
UP NEXT
Untitled doc
Docs powered by archbee
TABLE OF CONTENTS
→ Define the entity class
→ Extend the entity class and define specific properties to describe your subject
→ Register entity class using the tve_register_condition_entity function
→ Create an entity field that will be used to fetch the specific entity data which the condition will be tested on
→ Extend the field class and define specific properties to describe your field
→ For multiple-choice fields:
→ Register the field class using the tve_register_condition_field function