Skip to content

Standardizing Page Builders - Divi #3146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
JarrydLong wants to merge 2 commits into
base: dev
Choose a base branch
from
Draft

Standardizing Page Builders - Divi #3146

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3ab054
Standardizing Page Builders - Divi
JarrydLong Sep 22, 2024
6841292
Improvements to Divi modules
andrewlimaza May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 168 additions & 30 deletions includes/compatibility/divi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,17 @@ function __construct(){
}

add_action( 'pmpro_element_class', array( __CLASS__, 'pmpro_element_class' ), 10, 2 );
add_action( 'et_pb_module_shortcode_attributes', array( __CLASS__, 'map_pmpro_divi_legacy_settings_on_page_load' ), 10, 3 );
}

/**
* Add "Paid Memberships Pro" toggle to Divi (row and section) settings modal.
*
* @since TBD
*
* @param array $modules The Divi modules.
* @return array $modules The modified Divi modules.
*/
public static function toggle( $modules ) {

if ( isset( $modules['et_pb_row'] ) && is_object( $modules['et_pb_row'] ) ) {
Expand All @@ -28,19 +37,71 @@ public static function toggle( $modules ) {

}

/**
* Add settings to the Divi row and section settings modal for Paid Memberships Pro.
*
* @since TBD
*
* @param array $settings The Divi module settings.
* @return array $settings The modified Divi module settings.
*/
public static function row_settings( $settings ) {


$settings['pmpro_enable'] = array(
'tab_slug' => 'custom_css',
'label' => __( 'Enable Paid Memberships Pro content visibility?', 'paid-memberships-pro' ),
'type' => 'yes_no_button',
'options' => array(
'off' => __( 'No', 'paid-memberships-pro' ),
'on' => __( 'Yes', 'paid-memberships-pro' ),
),
'toggle_slug' => 'paid-memberships-pro',
);

$settings['pmpro_invert_restrictions'] = array(
'tab_slug' => 'custom_css',
'label' => __( 'Content Visibility', 'paid-memberships-pro' ),
'type' => 'select',
'options' => array(
'hide' => __( 'Hide content from...', 'paid-memberships-pro' ),
'show' => __( 'Show content to...', 'paid-memberships-pro' ),
),
'toggle_slug' => 'paid-memberships-pro',
'show_if' => array(
'pmpro_enable' => 'on',
),
);

$settings['paid-memberships-pro'] = array(
$settings['pmpro_segment'] = array(
'tab_slug' => 'custom_css',
'label' => __( 'Restrict Row by Level', 'paid-memberships-pro' ),
'type' => 'select',
'options' => array(
'all' => __( 'All Members', 'paid-memberships-pro' ),
'specific' => __( 'Specific Membership Levels', 'paid-memberships-pro' ),
'logged_in' => __( 'Logged-In Users', 'paid-memberships-pro' ),
),
'toggle_slug' => 'paid-memberships-pro',
'show_if' => array(
'pmpro_enable' => 'on'
),
);

$settings['pmpro_levels'] = array(
'tab_slug' => 'custom_css',
'label' => __( 'Membership Levels', 'paid-memberships-pro' ),
'description' => __( 'Enter comma-separated level IDs.', 'paid-memberships-pro' ),
'type' => 'text',
'default' => '',
'option_category' => 'configuration',
'toggle_slug' => 'paid-memberships-pro',
'show_if' => array(
'pmpro_enable' => 'on',
'pmpro_segment' => 'specific',
),
);

$settings['pmpro_show_no_access_message'] = array(
$settings['pmpro_show_noaccess'] = array(
'tab_slug' => 'custom_css',
'label' => __( 'Show no access message', 'paid-memberships-pro' ),
'description' => __( 'Displays a no access message to non-members.', 'paid-memberships-pro' ),
Expand All @@ -50,46 +111,92 @@ public static function row_settings( $settings ) {
'on' => __( 'Yes', 'paid-memberships-pro' ),
),
'toggle_slug' => 'paid-memberships-pro',
'show_if' => array(
'pmpro_enable' => 'on',
'pmpro_invert_restrictions' => 'show'
),
);

return $settings;

}

public static function restrict_content( $output, $props, $attrs, $slug ) {

/**
* Restrict Divi content based on PMPro membership levels access.
*
* @since TBD
*
* @param [type] $output
* @param [type] $props
* @param [type] $attrs
* @param [type] $slug
*
* @return string $output Returns the output of the content, in some cases it may be a blank string.
*/
public static function restrict_content( $output, $props, $attrs, $slug ) {
// Always allow content in Divi builder mode
if ( et_fb_is_enabled() ) {
return $output;
}

if ( et_fb_is_enabled() ) {
// Don't try to run this logic on anything besides a row or section since we only add restrictions to these modules.
if ( $slug !== 'et_pb_row' && $slug !== 'et_pb_section' ) {
return $output;
}
}

if( !isset( $props['paid-memberships-pro'] ) ){
return $output;
}

$level = $props['paid-memberships-pro'];

if ( empty( trim( $level ) ) || trim( $level ) === '0' ) {
// If PMPro restriction isn’t turned on, let's migrate some options.
if ( ! isset( $props['pmpro_enable'] ) || $props['pmpro_enable'] !== 'on' ) {
return $output;
}

// Determine if we're in “show” or “hide” mode, defaulting to 'show'.
$show_mode = $props['pmpro_invert_restrictions'] ?? 'show';

if( strpos( $level, "," ) ) {
//they specified many levels
$levels = explode( ",", $level );
// Pick the right segment key based on mode.
$segment = $props['pmpro_segment'] ?? 'all';

// If “specific” but no levels provided, just show content
if ( $segment === 'specific' ) {
$level_string = trim( $props['pmpro_levels'] ?? '' );

// If no levels are provided, restrict to all levels
if ( $level_string !== '0' && $level_string === '' ) {
$levels = array();
} else {
// Build an array of level IDs from a comma-separated string
$levels = strpos( $level_string, ',' ) !== false ? array_map( 'trim', explode( ',', $level_string ) ) : array( $level_string );
}
} else {
//they specified just one level
$levels = array( $level );
$levels = array();
}

if( pmpro_hasMembershipLevel( $levels ) ){
return $output;
} else {
if ( ! empty( $props['pmpro_show_no_access_message'] ) && 'on' === $props['pmpro_show_no_access_message'] ) {
return pmpro_get_no_access_message( NULL, $levels );
} else {
return '';
}

}
//Check access based on segment chosen.
switch ( $segment ) {
case 'all':
$has_access = pmpro_hasMembershipLevel();
break;
case 'specific':
$has_access = pmpro_hasMembershipLevel( $levels );
break;
case 'logged_in':
$has_access = is_user_logged_in();
break;
default:
return $output;
}

// If in “show” mode & they have access, OR in “hide” mode & they do NOT have access, show the content.
if ( ( $show_mode == 'show' && $has_access ) || ( $show_mode == 'hide' && ! $has_access ) ) {
return $output;
}

// Otherwise, they don’t have access—show message or nothing
if ( isset( $props['pmpro_show_noaccess'] ) && $props['pmpro_show_noaccess'] === 'on' ) {
return pmpro_get_no_access_message( null, $levels );
}

// In case we ever make it here, just return nothing. This means they don't have access?
return '';
}

/**
Expand All @@ -103,5 +210,36 @@ public static function pmpro_element_class( $class, $element ) {
}
return $class;
}

/**
* Swap out any legacy settings that may happen on page load/frontend.
*
* @since TBD
*
* @param [type] $props
* @param [type] $atts
* @param [type] $slugs
* @return array $props The shortcode properties with the mapped props.
*/
static function map_pmpro_divi_legacy_settings_on_page_load( $props, $atts, $slugs ) {
if ( isset( $props['pmpro_enable'] ) || ! isset( $props['paid-memberships-pro'] ) ) {
return $props;
}

// Do nothing
if ( empty( $props['paid-memberships-pro'] ) ) {
return $props;
}

// Let's convert to the new props based on the old props.
$props['pmpro_enable'] = 'on';
$props['pmpro_segment'] = 'specific';
$props['pmpro_levels'] = $props['paid-memberships-pro'];
$props['pmpro_invert_restrictions'] = 'show';
$props['pmpro_show_noaccess'] = $props['pmpro_show_no_access_message'] ?? 'off';

return $props;
}

}
new PMProDivi();
new PMProDivi();