ms_model_membership_set_rule

Set protection Rule Model.

Description

apply_filters( 'ms_model_membership_set_rule', (unknown) $rule, (unknown) $rule_type, (unknown) $instance ); 

Note for network-wide mode: In DB the rules for each site are stored in different objects. When loading a membership we will always load 1 instance of each rule_type, and this is the instance that belongs to the current site! Instances for other sites are not accessible. -> This is why we do not use/need a site_id or similar in this function.

Parameters (3)

0. $rule (unknown)
The rule.
1. $rule_type (unknown)
The rule type.
2. $instance (unknown)
The this.

Usage

To run the hook, copy the example below.
  1. $rule = apply_filters( 'ms_model_membership_set_rule', $rule, $rule_type, $instance ); 
  2.  
  3. if ( !empty( $rule ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the ms_model_membership_set_rule callback 
  2. function filter_ms_model_membership_set_rule( $rule, $rule_type, $instance ) { 
  3. // make filter magic happen here... 
  4. return $rule
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'ms_model_membership_set_rule', 'filter_ms_model_membership_set_rule', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'ms_model_membership_set_rule', 'filter_ms_model_membership_set_rule', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/app/model/class-ms-model-membership.php  
  1. $this->_rules[ $rule_type ] = apply_filters(