Skip to content
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

Standardising Page Builders - Elementor #3144

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

Standardising Page Builders - Elementor #3144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8d18c9a
Standardizing Page Builders - Elementor
JarrydLong Sep 22, 2024
9515bed
Simplifying using pmpro_apply_block_visibility()
dparker1005 Sep 24, 2024
931d6d1
Improved migration, adjusted new settings names
dparker1005 Jan 15, 2025
069b651
Fixing no access message migration
dparker1005 Jan 15, 2025
d1e0ba4
Fixing show no access message migration again
dparker1005 Jan 15, 2025
3e2ab9b
Merge branch 'dev' into elementor-3-0-stand
dparker1005 Jan 15, 2025
54677e3
Using new cache variable for 3.4 (removed non-member option)
dparker1005 Jan 17, 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
6 changes: 3 additions & 3 deletions includes/compatibility/elementor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,18 @@ function pmpro_elementor_compatibility() {
*/
function pmpro_elementor_get_all_levels() {

$levels_array = get_transient( 'pmpro_elementor_levels_cache' );
$levels_array = get_transient( 'pmpro_elementor_levels_cache_3_4' );

if ( empty( $levels_array ) ) {
$all_levels = pmpro_getAllLevels( true, false );

$levels_array = array();

$levels_array[0] = __( 'Non-members', 'paid-memberships-pro' );
foreach( $all_levels as $level ) {
$levels_array[ $level->id ] = $level->name;
}

set_transient( 'pmpro_elementor_levels_cache', $levels_array, 1 * DAY_IN_SECONDS );
set_transient( 'pmpro_elementor_levels_cache_3_4', $levels_array, 1 * DAY_IN_SECONDS );
}

$levels_array = apply_filters( 'pmpro_elementor_levels_array', $levels_array );
Expand All @@ -51,5 +50,6 @@ function pmpro_elementor_get_all_levels() {

function pmpro_elementor_clear_level_cache( $level_id ) {
delete_transient( 'pmpro_elementor_levels_cache' );
delete_transient( 'pmpro_elementor_levels_cache_3_4' );
}
add_action( 'pmpro_save_membership_level', 'pmpro_elementor_clear_level_cache' );
248 changes: 206 additions & 42 deletions includes/compatibility/elementor/class-pmpro-elementor-content-restriction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,45 +14,85 @@ protected function content_restriction() {
add_action( 'elementor/frontend/section/should_render', array( $this, 'pmpro_elementor_should_render' ), 10, 2 );
add_action( 'elementor/frontend/container/should_render', array( $this, 'pmpro_elementor_should_render' ), 10, 2 );

// Migrate settings from old restriction method (pmpro_require_membership) to new method (pmpro_enable).
add_action( 'wp', array( $this, 'migrate_settings' ) ); // Migrate on frontend (also runs when editing but too late).
add_action( 'elementor/editor/before_enqueue_scripts', array( $this, 'migrate_settings' ) ); // Migrate on editor load.

}

// Register controls to sections and widgets
protected function register_controls() {
foreach( $this->locations as $where ) {
add_action('elementor/element/'.$where['element'].'/'.$this->section_name.'/before_section_end', array( $this, 'add_controls' ), 10, 2 );
add_action('elementor/element/'.$where['element'].'/'.$this->section_name.'/before_section_end', array( $this, 'add_controls' ), 10, 2 );
}
}

// Define controls
public function add_controls( $element, $args ) {
$element->add_control(
'pmpro_require_membership_heading', array(
'label' => __( 'Require Membership Level', 'paid-memberships-pro' ),
'type' => Controls_Manager::HEADING,
'separator' => 'before',
)
$element->add_control(
'pmpro_enable', array(
'type' => \Elementor\Controls_Manager::SWITCHER,
'label' => esc_html__( 'Enable Paid Memberships Pro module visibility?', 'textdomain' ),
'default' => 'no',
)
);

$element->add_control(
'pmpro_invert_restrictions', array(
'type' => \Elementor\Controls_Manager::SELECT,
'options' => array(
'0' => esc_html__( 'Show content to...', 'textdomain' ),
Copy link
Contributor

@andrewlimaza andrewlimaza Jan 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'textdomain' instances need to be updated to 'paid-memberships-pro'

'1' => esc_html__( 'Hide content from...', 'textdomain' ),
),
'label_block' => 'true',
'default' => '0',
'condition' => [
'pmpro_enable' => 'yes',
],
)
);

$element->add_control(
'pmpro_require_membership', array(
$element->add_control(
'pmpro_segment', array(
'type' => \Elementor\Controls_Manager::SELECT,
'options' => array(
'all' => esc_html__( 'All Members', 'textdomain' ),
'specific' => esc_html__( 'Specific Membership Levels', 'textdomain' ),
'logged_in' => esc_html__( 'Logged-In Users', 'textdomain' ),
),
'label_block' => 'true',
'default' => 'all',
'condition' => [
'pmpro_enable' => 'yes',
],
)
);

$element->add_control(
'pmpro_levels', array(
'type' => Controls_Manager::SELECT2,
'options' => pmpro_elementor_get_all_levels(),
'multiple' => 'true',
'label_block' => 'true',
'description' => __( 'Require membership level to see this content.', 'paid-memberships-pro' ),
'label' => __( 'Membership Levels', 'paid-memberships-pro' ),
'condition' => [
'pmpro_segment' => 'specific',
'pmpro_enable' => 'yes',
],
)
);

// Only add this option to Widgets as we can replace the contents in widgets, not sections.
if ( 'widget' === $element->get_type() ) {
$element->add_control(
'pmpro_no_access_message', array(
'pmpro_show_noaccess', array(
'label' => esc_html__( 'Show no access message', 'paid-memberships-pro' ),
'type' => \Elementor\Controls_Manager::SWITCHER,
'label_on' => esc_html__( 'Yes', 'paid-memberships-pro' ),
'label_off' => esc_html__( 'No', 'paid-memberships-pro' ),
'return_value' => 'yes',
'default' => 'no',
'condition' => [
'pmpro_enable' => 'yes',
'pmpro_invert_restrictions' => '0',
],
)
);
}
Expand All @@ -70,17 +110,29 @@ public function pmpro_elementor_should_render( $should_render, $element ) {
// Don't hide content in editor mode.
if ( \Elementor\Plugin::$instance->editor->is_edit_mode() ) {
return $should_render;
}

}
// Bypass if it's already hidden.
if ( $should_render === false ) {
return $should_render;
}

// Checks if the element is restricted and then if the user has access.
$should_render = $this->pmpro_elementor_has_access( $element );

return apply_filters( 'pmpro_elementor_section_access', $should_render, $element );
$element_settings = $element->get_active_settings();

// If the block is not being restricted, then the user should be able to view it.
if ( empty( $element_settings['pmpro_enable'] ) || 'no' === $element_settings['pmpro_enable'] ) {
return true;
}

$apply_block_visibility_params = array(
'segment' => $element_settings['pmpro_segment'],
'levels' => $element_settings['pmpro_levels'],
'invert_restrictions' => $element_settings['pmpro_invert_restrictions'],
'show_noaccess' => ! empty( $element_settings['pmpro_show_noaccess'] ),
);
$should_render = ! empty( pmpro_apply_block_visibility( $apply_block_visibility_params, 'sample content' ) );

return apply_filters_deprecated( 'pmpro_elementor_section_access', array( $should_render, $element ), 'TBD' );
}

/**
Expand All @@ -91,48 +143,160 @@ public function pmpro_elementor_should_render( $should_render, $element ) {
public function pmpro_elementor_render_content( $content, $widget ){

// Don't hide content in editor mode.
if ( \Elementor\Plugin::$instance->editor->is_edit_mode() ) {
if ( \Elementor\Plugin::$instance->editor->is_edit_mode() ) {
return $content;
}

// We can only use the no access message on a widget
if ( 'widget' !== $widget->get_type() ) {
return $content;
}

$widget_settings = $widget->get_active_settings();

// If the block is not being restricted, bail.
if ( empty( $widget_settings['pmpro_enable'] ) || 'no' === $widget_settings['pmpro_enable'] ) {
return $content;
}

$show = $this->pmpro_elementor_has_access( $widget );
$widget_settings = $widget->get_active_settings();
// Use the pmpro_apply_block_visibility() method to generate output.
$apply_block_visibility_params = array(
'segment' => $widget_settings['pmpro_segment'],
'levels' => $widget_settings['pmpro_levels'],
'invert_restrictions' => $widget_settings['pmpro_invert_restrictions'],
'show_noaccess' => $widget_settings['pmpro_show_noaccess'],
);
return pmpro_apply_block_visibility( $apply_block_visibility_params, $content );

if ( ! $show ) {
// Show no content message here or not
if ( $widget_settings['pmpro_no_access_message'] === 'yes' ) {
$content = pmpro_get_no_access_message( NULL, $widget_settings['pmpro_require_membership'] );
} else {
$content = '';
}
}

return $content;
}

/**
* Figure out if the user has access to restricted content.
* @return bool True or false based if the user has access to the content or not.
* @since 2.3
* @deprecated TBD
*/
public function pmpro_elementor_has_access( $element ) {
_deprecated_function( __METHOD__, 'TBD' );

$element_settings = $element->get_active_settings();

$restricted_levels = empty( $element_settings['pmpro_require_membership'] ) ? array() : $element_settings['pmpro_require_membership'];
// If the block is not being restricted, then the user has access.
if ( empty( $element_settings['pmpro_enable'] ) || 'no' === $element_settings['pmpro_enable'] ) {
return true;
}

// Just bail if the content isn't restricted at all.
if ( ! $restricted_levels ) {
return true;
// If pmpro_apply_block_visibility returns content, then we want the user to see it.
$apply_block_visibility_params = array(
'segment' => $element_settings['pmpro_segment'],
'levels' => $element_settings['pmpro_levels'],
'invert_restrictions' => $element_settings['pmpro_invert_restrictions'],
'show_noaccess' => $element_settings['pmpro_show_noaccess'],
);
$access = ! empty( pmpro_apply_block_visibility( $apply_block_visibility_params, 'sample content' ) );

return apply_filters( 'pmpro_elementor_has_access', $access, $element, $element_settings['pmpro_levels'] );
}

/**
* Migrate settings from old restriction method (pmpro_require_membership) to new method (pmpro_enable).
*
* @since TBD
*/
public function migrate_settings() {
// Get the post being viewed.
$post_id = get_the_ID();
if ( empty( $post_id ) ) {
return;
}

if ( ! pmpro_hasMembershipLevel( $restricted_levels ) ) {
$access = false;

// Get the _elementor_data for the post.
$elementor_data_string = get_post_meta( $post_id, '_elementor_data', true );
if ( empty( $elementor_data_string ) ) {
return;
}

// Decode the _elementor_data.
$elementor_data = json_decode( $elementor_data_string, true );
if ( empty( $elementor_data ) ) {
return;
}

// Track if we've migrated.
$migrated = false;

// Get the container settings.
$container_settings = $elementor_data[0]['settings'];
if ( isset( $container_settings['pmpro_require_membership'] ) ) {
// Migrate the settings.
$elementor_data[0]['settings'] = $this->migrate_settings_helper( $container_settings );
$migrated = true;
}

// Loop through each element and migrate the settings.
foreach ( $elementor_data[0]['elements'] as $key => $element ) {
// Get the element settings.
$element_settings = $element['settings'];

// If the element has the old pmpro_require_membership setting, migrate it.
if ( isset( $element_settings['pmpro_require_membership'] ) ) {
$elementor_data[0]['elements'][ $key ]['settings'] = $this->migrate_settings_helper( $element_settings );
$migrated = true;
}
}

// If we've migrated, save the updated _elementor_data.
if ( $migrated ) {
update_post_meta( $post_id, '_elementor_data', wp_json_encode( $elementor_data ) );
}
}

/**
* Heloper method for migrating settings from old restriction method (pmpro_require_membership) to new method (pmpro_enable).
*
* @since TBD
*
* @param array $settings The settings array to migrate.
* @return array The migrated settings array.
*/
private function migrate_settings_helper( $settings ) {
// If pmpro_require_membership is not set, bail.
if ( ! isset( $settings['pmpro_require_membership'] ) ) {
return $settings;
}

// Figure out how to migrate the settings.
$settings['pmpro_enable'] = 'yes';
if ( ! in_array( '0', $settings['pmpro_require_membership'] ) ) {
// If '0' is not in the array, then we can copy the pmpro_require_membership value and use "restrict to specific levels".
$settings['pmpro_levels'] = $settings['pmpro_require_membership'];
$settings['pmpro_segment'] = 'specific';
$settings['pmpro_invert_restrictions'] = '0';
$settings['pmpro_show_noaccess'] = empty( $settings['pmpro_no_access_message'] ) ? 'no' : $settings['pmpro_no_access_message'];
} elseif ( 1 === count( $settings['pmpro_require_membership'] ) ) {
// '0' is the only value in the array. This means that we should restrict to non-members.
$settings['pmpro_levels'] = array();
$settings['pmpro_segment'] = 'all';
$settings['pmpro_invert_restrictions'] = '1';
$settings['pmpro_show_noaccess'] = 'no';
} else {
$access = true;
// '0' is in the array, but there are other values. This means that we need to block access to all levels that are not in the array.
// First, get all PMPro level IDs.
$all_levels = pmpro_getAllLevels( true, false );
$all_levels_ids = wp_list_pluck( $all_levels, 'id' );

// Get the levels that are not in the pmpro_require_membership array.
$settings['pmpro_levels'] = array_values( array_diff( $all_levels_ids, $settings['pmpro_require_membership'] ) );
$settings['pmpro_segment'] = 'specific';
$settings['pmpro_invert_restrictions'] = '1';
$settings['pmpro_show_noaccess'] = 'no';
}

return apply_filters( 'pmpro_elementor_has_access', $access, $element, $restricted_levels );
// Remove the old pmpro_require_membership setting.
unset( $settings['pmpro_require_membership'] );
unset( $settings['pmpro_no_access_message'] );

return $settings;
}
}

Expand Down