2022-04-02 10:26:41 +02:00
< ? php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
* Main class file for the Widget Visibility module .
*
* @ package automattic / jetpack
*/
2019-11-15 23:26:29 +01:00
2025-08-27 08:44:30 +02:00
use Automattic\Block_Scanner ;
2019-11-15 23:26:29 +01:00
use Automattic\Jetpack\Assets ;
2025-12-12 13:13:07 +01:00
if ( ! defined ( 'ABSPATH' ) ) {
exit ( 0 );
}
2019-11-15 23:26:29 +01:00
/**
2021-07-23 11:58:50 +02:00
* Hide or show legacy widgets conditionally .
*
* This class has two responsiblities - administrating the conditions in which legacy widgets may be hidden or shown
* and hiding / showing the legacy widgets on the front - end of the site , depending upon the evaluation of those conditions .
*
* Administrating the conditions can be done in one of four different WordPress screens , plus direct use of the API and
* is supplemented with a legacy widget preview screen . The four different admin screens are
*
* Gutenberg widget experience - widget admin ( widgets . php + API + legacy widget preview )
* Gutenberg widget experience - Customizer ( customizer screen / API + API + legacy widget preview )
* Classic widget experience - widget admin ( widgets . php + admin - ajax XHR requests )
* Classic widget experience - Customizer ( customizer screen / API )
*
* An introduction to the API endpoints can be found here : https :// make . wordpress . org / core / 2021 / 06 / 29 / rest - api - changes - in - wordpress - 5 - 8 /
2019-11-15 23:26:29 +01:00
*/
class Jetpack_Widget_Conditions {
2022-04-02 10:26:41 +02:00
/**
* Stores condition for template_redirect action .
*
* @ var bool
*/
public static $passed_template_redirect = false ;
2019-11-15 23:26:29 +01:00
2022-04-02 10:26:41 +02:00
/**
* Class initializer .
*/
2019-11-15 23:26:29 +01:00
public static function init () {
2021-07-23 11:58:50 +02:00
global $pagenow ;
// The Gutenberg based widget experience will show a preview of legacy widgets by including a URL beginning
// widgets.php?legacy-widget-preview inside an iframe. Previews don't need widget editing loaded and also don't
// want to run the filter - if the widget is filtered out it'll be empty, which would be confusing.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset ( $_GET [ 'legacy-widget-preview' ] ) ) {
return ;
}
// If action is posted and it's save-widget then it's relevant to widget conditions, otherwise it's something
// else and it's not worth registering hooks.
// phpcs:ignore WordPress.Security.NonceVerification.Missing
2022-04-02 10:26:41 +02:00
if ( isset ( $_POST [ 'action' ] ) && ! isset ( $_POST [ 'customize_changeset_uuid' ] ) && ! in_array ( $_POST [ 'action' ], array ( 'save-widget' , 'update-widget' ), true ) ) {
2021-07-23 11:58:50 +02:00
return ;
}
// API call to *list* the widget types doesn't use editing visibility or display widgets.
2023-12-07 09:44:11 +01:00
if ( isset ( $_SERVER [ 'REQUEST_URI' ] ) && str_contains ( $_SERVER [ 'REQUEST_URI' ], '/widget-types?' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
2021-07-23 11:58:50 +02:00
return ;
}
$add_data_assets_to_page = false ;
$add_html_to_form = false ;
$handle_widget_updates = false ;
2022-04-02 10:26:41 +02:00
$add_block_controls = false ;
2021-07-23 11:58:50 +02:00
2022-04-02 10:26:41 +02:00
// Check to see if using the customizer, but not using the preview. The preview should filter out widgets,
// the customizer controls in the sidebar should not (so they can be edited).
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$customizer_not_previewer = is_customize_preview () && ! isset ( $_GET [ 'customize_changeset_uuid' ] );
2023-09-26 10:24:36 +02:00
$using_classic_experience = ! wp_use_widgets_block_editor ();
2021-07-23 11:58:50 +02:00
if ( $using_classic_experience &&
2022-04-02 10:26:41 +02:00
( $customizer_not_previewer || 'widgets.php' === $pagenow ||
2021-07-23 11:58:50 +02:00
// phpcs:ignore WordPress.Security.NonceVerification.Missing
( 'admin-ajax.php' === $pagenow && array_key_exists ( 'action' , $_POST ) && 'save-widget' === $_POST [ 'action' ] )
)
) {
$add_data_assets_to_page = true ;
$add_html_to_form = true ;
$handle_widget_updates = true ;
} else {
// On a screen that is hosting the API in the gutenberg editing experience.
2022-04-02 10:26:41 +02:00
if ( $customizer_not_previewer || 'widgets.php' === $pagenow ) {
2021-07-23 11:58:50 +02:00
$add_data_assets_to_page = true ;
2022-04-02 10:26:41 +02:00
$add_block_controls = true ;
2021-07-23 11:58:50 +02:00
}
// Encoding for a particular widget end point.
2022-06-16 14:01:47 +02:00
if ( isset ( $_SERVER [ 'REQUEST_URI' ] ) && 1 === preg_match ( '|/widget-types/.*/encode|' , $_SERVER [ 'REQUEST_URI' ] ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
2021-07-23 11:58:50 +02:00
$add_html_to_form = true ;
$handle_widget_updates = true ;
}
// Batch API is usually saving but could be anything.
2022-04-02 10:26:41 +02:00
$current_url = ! empty ( $_SERVER [ 'REQUEST_URI' ] ) ? esc_url_raw ( wp_unslash ( $_SERVER [ 'REQUEST_URI' ] ) ) : '' ;
2023-12-07 09:44:11 +01:00
if ( str_contains ( $current_url , '/wp-json/batch/v1' ) || 1 === preg_match ( '/^\/wp\/v2\/sites\/\d+\/batch\/v1/' , $current_url ) ) {
2021-07-23 11:58:50 +02:00
$handle_widget_updates = true ;
$add_html_to_form = true ;
}
// Saving widgets via non-batch API. This isn't used within WordPress but could be used by third parties in theory.
2023-12-07 09:44:11 +01:00
if ( isset ( $_SERVER [ 'REQUEST_METHOD' ] ) && 'GET' !== $_SERVER [ 'REQUEST_METHOD' ] && str_contains ( $_SERVER [ 'REQUEST_URI' ], '/wp/v2/widgets' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
2021-07-23 11:58:50 +02:00
$handle_widget_updates = true ;
$add_html_to_form = true ;
}
}
if ( $add_html_to_form ) {
2019-11-15 23:26:29 +01:00
add_action ( 'in_widget_form' , array ( __CLASS__ , 'widget_conditions_admin' ), 10 , 3 );
2021-07-23 11:58:50 +02:00
}
if ( $handle_widget_updates ) {
add_filter ( 'widget_update_callback' , array ( __CLASS__ , 'widget_update' ), 10 , 3 );
}
if ( $add_data_assets_to_page ) {
add_action ( 'sidebar_admin_setup' , array ( __CLASS__ , 'widget_admin_setup' ) );
}
2022-04-02 10:26:41 +02:00
if ( $add_block_controls ) {
add_action ( 'enqueue_block_editor_assets' , array ( __CLASS__ , 'setup_block_controls' ) );
}
2021-07-23 11:58:50 +02:00
if ( ! $add_html_to_form && ! $handle_widget_updates && ! $add_data_assets_to_page &&
! in_array ( $pagenow , array ( 'wp-login.php' , 'wp-register.php' ), true )
) {
// Not hit any known widget admin endpoint, register widget display hooks instead.
2019-11-15 23:26:29 +01:00
add_filter ( 'widget_display_callback' , array ( __CLASS__ , 'filter_widget' ) );
add_filter ( 'sidebars_widgets' , array ( __CLASS__ , 'sidebars_widgets' ) );
add_action ( 'template_redirect' , array ( __CLASS__ , 'template_redirect' ) );
}
}
2022-04-02 10:26:41 +02:00
/**
* Enqueue the block - based widget visibility scripts .
*/
public static function setup_block_controls () {
Assets :: register_script (
'widget-visibility-editor' ,
'_inc/build/widget-visibility/editor/index.js' ,
JETPACK__PLUGIN_FILE ,
array (
'in_footer' => true ,
'textdomain' => 'jetpack' ,
)
);
Assets :: enqueue_script ( 'widget-visibility-editor' );
}
/**
* Add the 'conditions' attribute , where visibility rules are stored , to some blocks .
*
* We normally add the block attributes in the browser ' s javascript env only ,
* but these blocks use a ServerSideRender dynamic preview , so the php env needs
* to know about the new attribute , too .
*/
public static function add_block_attributes_filter () {
2023-09-26 10:24:36 +02:00
$blocks = array (
2022-04-02 10:26:41 +02:00
// These use <ServerSideRender>.
'core/calendar' ,
'core/latest-comments' ,
'core/rss' ,
'core/archives' ,
'core/tag-cloud' ,
'core/page-list' ,
'core/latest-posts' ,
2022-12-15 17:41:53 +01:00
'woocommerce/product-categories' ,
2022-04-02 10:26:41 +02:00
);
2023-09-26 10:24:36 +02:00
/**
* Filters the list of widget visibility blocks using < ServerSideRender >.
*
* @ since 12.4
*
* @ module widget - visibility
*
* @ param string [] $blocks Array of block names from WordPress core and WooCommerce .
*/
$blocks_to_add_visibility_conditions = apply_filters ( 'jetpack_widget_visibility_server_side_render_blocks' , $blocks );
2022-04-02 10:26:41 +02:00
2025-02-28 08:42:11 +01:00
/**
* Block registration filter callback .
*
* @ param array $settings Array of arguments for registering a block type .
* @ param string $name Block type name including namespace .
* @ return array
*/
2023-09-26 10:24:36 +02:00
$filter_metadata_registration = function ( $settings , $name ) use ( $blocks_to_add_visibility_conditions ) {
if ( in_array ( $name , $blocks_to_add_visibility_conditions , true ) && ! empty ( $settings [ 'attributes' ] ) ) {
2022-04-02 10:26:41 +02:00
$settings [ 'attributes' ][ 'conditions' ] = array (
'type' => 'object' ,
);
}
return $settings ;
};
2023-09-26 10:24:36 +02:00
add_filter ( 'register_block_type_args' , $filter_metadata_registration , 10 , 2 );
2022-04-02 10:26:41 +02:00
}
2021-07-23 11:58:50 +02:00
/**
* Prepare the interface for editing widgets - loading css , javascript & data
*/
2019-11-15 23:26:29 +01:00
public static function widget_admin_setup () {
2021-07-23 11:58:50 +02:00
wp_enqueue_style ( 'widget-conditions' , plugins_url ( 'widget-conditions/widget-conditions.css' , __FILE__ ), array ( 'widgets' ), JETPACK__VERSION );
2019-11-15 23:26:29 +01:00
wp_style_add_data ( 'widget-conditions' , 'rtl' , 'replace' );
wp_enqueue_script (
'widget-conditions' ,
Assets :: get_file_url_for_environment (
'_inc/build/widget-visibility/widget-conditions/widget-conditions.min.js' ,
'modules/widget-visibility/widget-conditions/widget-conditions.js'
),
array ( 'jquery' , 'jquery-ui-core' ),
2021-07-23 11:58:50 +02:00
JETPACK__VERSION ,
2019-11-15 23:26:29 +01:00
true
);
// Set up a single copy of all of the data that Widget Visibility needs.
// This allows all widget conditions to reuse the same data, keeping page size down
// and eliminating the AJAX calls we used to have to use to fetch the minor rule options.
$widget_conditions_data = array ();
$widget_conditions_data [ 'category' ] = array ();
$widget_conditions_data [ 'category' ][] = array ( '' , __ ( 'All category pages' , 'jetpack' ) );
$categories = get_categories (
array (
2020-11-18 09:10:44 +01:00
/**
* Specific a maximum number of categories to query for the Widget visibility UI .
*
* @ module widget - visibility
*
* @ since 9.1 . 0
*
* @ param int $number Maximum number of categories displayed in the Widget visibility UI .
*/
'number' => ( int ) apply_filters ( 'jetpack_widget_visibility_max_number_categories' , 1000 ),
2019-11-15 23:26:29 +01:00
'orderby' => 'count' ,
'order' => 'DESC' ,
)
);
usort ( $categories , array ( __CLASS__ , 'strcasecmp_name' ) );
foreach ( $categories as $category ) {
$widget_conditions_data [ 'category' ][] = array ( ( string ) $category -> term_id , $category -> name );
}
$widget_conditions_data [ 'loggedin' ] = array ();
$widget_conditions_data [ 'loggedin' ][] = array ( 'loggedin' , __ ( 'Logged In' , 'jetpack' ) );
$widget_conditions_data [ 'loggedin' ][] = array ( 'loggedout' , __ ( 'Logged Out' , 'jetpack' ) );
$widget_conditions_data [ 'author' ] = array ();
$widget_conditions_data [ 'author' ][] = array ( '' , __ ( 'All author pages' , 'jetpack' ) );
2022-04-02 10:26:41 +02:00
/*
* Query for users with publish caps .
*/
$authors_args = array (
'orderby' => 'name' ,
'capability' => array ( 'edit_posts' ),
'fields' => array ( 'ID' , 'display_name' ),
2019-11-15 23:26:29 +01:00
);
2022-04-02 10:26:41 +02:00
$authors = get_users ( $authors_args );
2019-11-15 23:26:29 +01:00
foreach ( $authors as $author ) {
$widget_conditions_data [ 'author' ][] = array ( ( string ) $author -> ID , $author -> display_name );
}
$widget_conditions_data [ 'role' ] = array ();
global $wp_roles ;
foreach ( $wp_roles -> roles as $role_key => $role ) {
$widget_conditions_data [ 'role' ][] = array ( ( string ) $role_key , $role [ 'name' ] );
}
$widget_conditions_data [ 'tag' ] = array ();
$widget_conditions_data [ 'tag' ][] = array ( '' , __ ( 'All tag pages' , 'jetpack' ) );
$tags = get_tags (
array (
2020-11-18 09:10:44 +01:00
/**
* Specific a maximum number of tags to query for the Widget visibility UI .
*
* @ module widget - visibility
*
* @ since 9.1 . 0
*
* @ param int $number Maximum number of tags displayed in the Widget visibility UI .
*/
'number' => ( int ) apply_filters ( 'jetpack_widget_visibility_max_number_tags' , 1000 ),
2019-11-15 23:26:29 +01:00
'orderby' => 'count' ,
'order' => 'DESC' ,
)
);
usort ( $tags , array ( __CLASS__ , 'strcasecmp_name' ) );
foreach ( $tags as $tag ) {
$widget_conditions_data [ 'tag' ][] = array ( ( string ) $tag -> term_id , $tag -> name );
}
$widget_conditions_data [ 'date' ] = array ();
$widget_conditions_data [ 'date' ][] = array ( '' , __ ( 'All date archives' , 'jetpack' ) );
$widget_conditions_data [ 'date' ][] = array ( 'day' , __ ( 'Daily archives' , 'jetpack' ) );
$widget_conditions_data [ 'date' ][] = array ( 'month' , __ ( 'Monthly archives' , 'jetpack' ) );
$widget_conditions_data [ 'date' ][] = array ( 'year' , __ ( 'Yearly archives' , 'jetpack' ) );
$widget_conditions_data [ 'page' ] = array ();
$widget_conditions_data [ 'page' ][] = array ( 'front' , __ ( 'Front page' , 'jetpack' ) );
$widget_conditions_data [ 'page' ][] = array ( 'posts' , __ ( 'Posts page' , 'jetpack' ) );
$widget_conditions_data [ 'page' ][] = array ( 'archive' , __ ( 'Archive page' , 'jetpack' ) );
$widget_conditions_data [ 'page' ][] = array ( '404' , __ ( '404 error page' , 'jetpack' ) );
$widget_conditions_data [ 'page' ][] = array ( 'search' , __ ( 'Search results' , 'jetpack' ) );
$post_types = get_post_types ( array ( 'public' => true ), 'objects' );
$widget_conditions_post_types = array ();
$widget_conditions_post_type_archives = array ();
foreach ( $post_types as $post_type ) {
$widget_conditions_post_types [] = array ( 'post_type-' . $post_type -> name , $post_type -> labels -> singular_name );
$widget_conditions_post_type_archives [] = array ( 'post_type_archive-' . $post_type -> name , $post_type -> labels -> name );
}
$widget_conditions_data [ 'page' ][] = array ( __ ( 'Post type:' , 'jetpack' ), $widget_conditions_post_types );
$widget_conditions_data [ 'page' ][] = array ( __ ( 'Post type Archives:' , 'jetpack' ), $widget_conditions_post_type_archives );
2020-11-18 09:10:44 +01:00
$pages = self :: get_pages ();
$dropdown_tree_args = array (
'depth' => 0 ,
'child_of' => 0 ,
'selected' => 0 ,
'echo' => false ,
'name' => 'page_id' ,
'id' => '' ,
'class' => '' ,
'show_option_none' => '' ,
'show_option_no_change' => '' ,
'option_none_value' => '' ,
'value_field' => 'ID' ,
);
2022-04-02 10:26:41 +02:00
$pages_dropdown = walk_page_dropdown_tree ( $pages , 0 , $dropdown_tree_args );
2019-11-15 23:26:29 +01:00
preg_match_all ( '/value=.([0-9]+).[^>]*>([^<]+)</' , $pages_dropdown , $page_ids_and_titles , PREG_SET_ORDER );
$static_pages = array ();
foreach ( $page_ids_and_titles as $page_id_and_title ) {
$static_pages [] = array ( ( string ) $page_id_and_title [ 1 ], $page_id_and_title [ 2 ] );
}
$widget_conditions_data [ 'page' ][] = array ( __ ( 'Static page:' , 'jetpack' ), $static_pages );
$widget_conditions_data [ 'taxonomy' ] = array ();
$widget_conditions_data [ 'taxonomy' ][] = array ( '' , __ ( 'All taxonomy pages' , 'jetpack' ) );
$taxonomies = get_taxonomies (
/**
* Filters args passed to get_taxonomies .
*
* @ see https :// developer . wordpress . org / reference / functions / get_taxonomies /
*
* @ since 5.3 . 0
*
* @ module widget - visibility
*
* @ param array $args Widget Visibility taxonomy arguments .
*/
apply_filters ( 'jetpack_widget_visibility_tax_args' , array ( '_builtin' => false ) ),
'objects'
);
usort ( $taxonomies , array ( __CLASS__ , 'strcasecmp_name' ) );
foreach ( $taxonomies as $taxonomy ) {
$taxonomy_terms = get_terms (
array ( $taxonomy -> name ),
array (
'number' => 250 ,
'hide_empty' => false ,
)
);
$widget_conditions_terms = array ();
2021-09-07 21:40:48 +02:00
$widget_conditions_terms [] = array ( $taxonomy -> name , $taxonomy -> labels -> all_items );
2019-11-15 23:26:29 +01:00
foreach ( $taxonomy_terms as $term ) {
$widget_conditions_terms [] = array ( $taxonomy -> name . '_tax_' . $term -> term_id , $term -> name );
}
$widget_conditions_data [ 'taxonomy' ][] = array ( $taxonomy -> labels -> name . ':' , $widget_conditions_terms );
}
wp_localize_script ( 'widget-conditions' , 'widget_conditions_data' , $widget_conditions_data );
// Save a list of the IDs of all pages that have children for dynamically showing the "Include children" checkbox.
2020-11-18 09:10:44 +01:00
$all_pages = self :: get_pages ();
2019-11-15 23:26:29 +01:00
$all_parents = array ();
foreach ( $all_pages as $page ) {
if ( $page -> post_parent ) {
$all_parents [ ( string ) $page -> post_parent ] = true ;
}
}
$front_page_id = get_option ( 'page_on_front' );
if ( isset ( $all_parents [ $front_page_id ] ) ) {
$all_parents [ 'front' ] = true ;
}
wp_localize_script ( 'widget-conditions' , 'widget_conditions_parent_pages' , $all_parents );
}
2020-11-18 09:10:44 +01:00
/**
2021-09-07 21:40:48 +02:00
* Retrieves a full list of all pages , containing just the IDs , post_parent , post_title , and post_status fields .
2020-12-10 14:04:11 +01:00
*
* Since the WordPress ' `get_pages` function does not allow us to fetch only the fields mentioned
* above , we need to introduce a custom method using a direct SQL query fetching those .
*
2021-09-07 21:40:48 +02:00
* By fetching only those four fields and not populating the object cache for all the pages , we can
2020-12-10 14:04:11 +01:00
* improve the performance of the query on sites having a lot of pages .
*
* @ see https :// core . trac . wordpress . org / ticket / 51469
*
2021-09-07 21:40:48 +02:00
* @ return array List of all pages on the site ( stdClass objects containing ID , post_title , post_parent , and post_status only ) .
2020-12-10 14:04:11 +01:00
*/
2020-11-18 09:10:44 +01:00
public static function get_pages () {
global $wpdb ;
$last_changed = wp_cache_get_last_changed ( 'posts' );
$cache_key = " get_pages: $last_changed " ;
$pages = wp_cache_get ( $cache_key , 'widget_conditions' );
if ( false === $pages ) {
2021-09-07 21:40:48 +02:00
$pages = $wpdb -> get_results ( " SELECT { $wpdb -> posts } .ID, { $wpdb -> posts } .post_parent, { $wpdb -> posts } .post_title, { $wpdb -> posts } .post_status FROM { $wpdb -> posts } WHERE { $wpdb -> posts } .post_type = 'page' AND { $wpdb -> posts } .post_status = 'publish' ORDER BY { $wpdb -> posts } .post_title ASC " );
2020-11-18 09:10:44 +01:00
wp_cache_set ( $cache_key , $pages , 'widget_conditions' );
}
// Copy-pasted from the get_pages function. For usage in the `widget_conditions_get_pages` filter.
$parsed_args = array (
'child_of' => 0 ,
'sort_order' => 'ASC' ,
'sort_column' => 'post_title' ,
'hierarchical' => 1 ,
'exclude' => array (),
'include' => array (),
'meta_key' => '' ,
'meta_value' => '' ,
'authors' => '' ,
'parent' => - 1 ,
'exclude_tree' => array (),
'number' => '' ,
'offset' => 0 ,
'post_type' => 'page' ,
'post_status' => 'publish' ,
);
/**
* Filters the retrieved list of pages .
*
* @ since 9.1 . 0
*
* @ module widget - visibility
*
2021-09-07 21:40:48 +02:00
* @ param stdClass [] $pages Array of objects containing only the ID , post_parent , post_title , and post_status fields .
2020-11-18 09:10:44 +01:00
* @ param array $parsed_args Array of get_pages () arguments .
*/
return apply_filters ( 'jetpack_widget_visibility_get_pages' , $pages , $parsed_args );
}
2019-11-15 23:26:29 +01:00
/**
* Add the widget conditions to each widget in the admin .
*
2021-07-23 11:58:50 +02:00
* @ param WP_Widget $widget Widget to add conditions settings to .
* @ param null $return unused .
* @ param array $instance The widget settings .
2019-11-15 23:26:29 +01:00
*/
public static function widget_conditions_admin ( $widget , $return , $instance ) {
$conditions = array ();
if ( isset ( $instance [ 'conditions' ] ) ) {
$conditions = $instance [ 'conditions' ];
}
if ( ! isset ( $conditions [ 'action' ] ) ) {
$conditions [ 'action' ] = 'show' ;
}
if ( empty ( $conditions [ 'rules' ] ) ) {
$conditions [ 'rules' ][] = array (
'major' => '' ,
'minor' => '' ,
'has_children' => '' ,
);
}
if ( empty ( $conditions [ 'match_all' ] ) ) {
$conditions [ 'match_all' ] = false ;
}
?>
< div
class = "
widget - conditional
< ? php
2021-07-23 11:58:50 +02:00
// $_POST['widget-conditions-visible'] is used in the classic widget experience to decide whether to
// display the visibility panel open, e.g. when saving. In the gutenberg widget experience the POST
// value will always be empty, but this is fine - it doesn't rerender the HTML when saving anyway.
2019-11-15 23:26:29 +01:00
if (
2022-04-02 10:26:41 +02:00
// phpcs:ignore WordPress.Security.NonceVerification.Missing
empty ( $_POST [ 'widget-conditions-visible' ] ) || '0' === $_POST [ 'widget-conditions-visible' ]
2019-11-15 23:26:29 +01:00
) {
?>
widget - conditional - hide
< ? php
}
?>
< ? php
if ( ! empty ( $conditions [ 'match_all' ] ) && $conditions [ 'match_all' ] ) {
?>
intersection
< ? php
} else {
?>
conjunction
< ? php
}
?>
" >
< input type = " hidden " name = " widget-conditions-visible " value = "
< ? php
2022-04-02 10:26:41 +02:00
if ( isset ( $_POST [ 'widget-conditions-visible' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
2022-06-16 14:01:47 +02:00
echo esc_attr ( filter_var ( wp_unslash ( $_POST [ 'widget-conditions-visible' ] ) ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
} else {
echo 0 ;
}
?>
" />
2019-11-15 23:26:29 +01:00
< ? php
2022-04-02 10:26:41 +02:00
if ( ! isset ( $_POST [ 'widget-conditions-visible' ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
2019-11-15 23:26:29 +01:00
?>
2021-07-23 11:58:50 +02:00
< a href = " # " class = " button display-options " >< ? php esc_html_e ( 'Visibility' , 'jetpack' ); ?> </a><?php } ?>
2019-11-15 23:26:29 +01:00
< div class = " widget-conditional-inner " >
< div class = " condition-top " >
2021-07-23 11:58:50 +02:00
< ? php
printf (
// translators: %s is a HTML select widget for widget visibility, 'show' and 'hide' are it's options. It will read like 'show if' or 'hide if'.
esc_html_x ( '%s if:' , 'placeholder: dropdown menu to select widget visibility; hide if or show if' , 'jetpack' ),
'<select name="' . esc_attr ( $widget -> get_field_name ( 'conditions[action]' ) ) . ' " >
< option value = " show " ' . selected( $conditions[' action '], ' show ', false ) . ' > ' . esc_html_x( ' Show ', ' Used in the " %s if: " translation for the widget visibility dropdown ', ' jetpack ' ) . ' </ option >
< option value = " hide " ' . selected( $conditions[' action '], ' hide ', false ) . ' > ' . esc_html_x( ' Hide ', ' Used in the " %s if: " translation for the widget visibility dropdown ', ' jetpack ' ) . ' </ option >
</ select > '
);
?>
2019-11-15 23:26:29 +01:00
</ div ><!-- . condition - top -->
< div class = " conditions " >
< ? php
foreach ( $conditions [ 'rules' ] as $rule_index => $rule ) {
$rule = wp_parse_args (
$rule ,
array (
'major' => '' ,
'minor' => '' ,
'has_children' => '' ,
)
);
?>
< div class = " condition " data - rule - major = " <?php echo esc_attr( $rule['major'] ); ?> " data - rule - minor = " <?php echo esc_attr( $rule['minor'] ); ?> " data - rule - has - children = " <?php echo esc_attr( $rule['has_children'] ); ?> " >
< div class = " selection alignleft " >
2021-07-23 11:58:50 +02:00
< select class = " conditions-rule-major " name = " <?php echo esc_attr( $widget->get_field_name ( 'conditions[rules_major][]' ) ); ?> " >
2019-11-15 23:26:29 +01:00
< option value = " " < ? php selected ( '' , $rule [ 'major' ] ); ?> ><?php echo esc_html_x( '-- Select --', 'Used as the default option in a dropdown list', 'jetpack' ); ?></option>
< option value = " category " < ? php selected ( 'category' , $rule [ 'major' ] ); ?> ><?php esc_html_e( 'Category', 'jetpack' ); ?></option>
< option value = " author " < ? php selected ( 'author' , $rule [ 'major' ] ); ?> ><?php echo esc_html_x( 'Author', 'Noun, as in: "The author of this post is..."', 'jetpack' ); ?></option>
2022-04-02 10:26:41 +02:00
< ? php if ( ! ( defined ( 'IS_WPCOM' ) && IS_WPCOM ) ) { // this doesn't work on .com because of caching. ?>
2019-11-15 23:26:29 +01:00
< option value = " loggedin " < ? php selected ( 'loggedin' , $rule [ 'major' ] ); ?> ><?php echo esc_html_x( 'User', 'Noun', 'jetpack' ); ?></option>
< option value = " role " < ? php selected ( 'role' , $rule [ 'major' ] ); ?> ><?php echo esc_html_x( 'Role', 'Noun, as in: "The user role of that can access this widget is..."', 'jetpack' ); ?></option>
< ? php } ?>
< option value = " tag " < ? php selected ( 'tag' , $rule [ 'major' ] ); ?> ><?php echo esc_html_x( 'Tag', 'Noun, as in: "This post has one tag."', 'jetpack' ); ?></option>
< option value = " date " < ? php selected ( 'date' , $rule [ 'major' ] ); ?> ><?php echo esc_html_x( 'Date', 'Noun, as in: "This page is a date archive."', 'jetpack' ); ?></option>
< option value = " page " < ? php selected ( 'page' , $rule [ 'major' ] ); ?> ><?php echo esc_html_x( 'Page', 'Example: The user is looking at a page, not a post.', 'jetpack' ); ?></option>
< ? php if ( get_taxonomies ( array ( '_builtin' => false ) ) ) : ?>
< option value = " taxonomy " < ? php selected ( 'taxonomy' , $rule [ 'major' ] ); ?> ><?php echo esc_html_x( 'Taxonomy', 'Noun, as in: "This post has one taxonomy."', 'jetpack' ); ?></option>
< ? php endif ; ?>
</ select >
2022-04-02 10:26:41 +02:00
< ? php echo esc_html_x ( 'is' , 'Widget Visibility: {Rule Major [Page]} is {Rule Minor [Search results]}' , 'jetpack' ); ?>
2019-11-15 23:26:29 +01:00
2021-07-23 11:58:50 +02:00
< select class = " conditions-rule-minor " name = " <?php echo esc_attr( $widget->get_field_name ( 'conditions[rules_minor][]' ) ); ?> "
2019-11-15 23:26:29 +01:00
< ? php
if ( ! $rule [ 'major' ] ) {
2022-04-02 10:26:41 +02:00
echo ' disabled="disabled"' ;
}
?>
>
2019-11-15 23:26:29 +01:00
< ? php
/*
Include the currently selected value so that if the widget is saved without
2022-04-02 10:26:41 +02:00
expanding the Visibility section , we don ' t lose the minor part of the rule .
If it is opened , this list is cleared out and populated with all the values .
*/
2019-11-15 23:26:29 +01:00
?>
< option value = " <?php echo esc_attr( $rule['minor'] ); ?> " selected = " selected " ></ option >
</ select >
< span class = " conditions-rule-has-children "
< ? php
if ( ! $rule [ 'has_children' ] ) {
2022-04-02 10:26:41 +02:00
echo ' style="display: none;"' ;
}
?>
>
2019-11-15 23:26:29 +01:00
< label >
2021-07-23 11:58:50 +02:00
< input type = " checkbox " name = " <?php echo esc_attr( $widget->get_field_name ( " conditions [ page_children ][ $rule_index ] " ) ); ?> " value = " has " < ? php checked ( $rule [ 'has_children' ], true ); ?> />
2019-11-15 23:26:29 +01:00
< ? php echo esc_html_x ( 'Include children' , 'Checkbox on Widget Visibility if children of the selected page should be included in the visibility rule.' , 'jetpack' ); ?>
</ label >
</ span >
</ div >
< div class = " condition-control " >
< span class = " condition-conjunction " >
< ? php echo esc_html_x ( 'or' , 'Shown between widget visibility conditions.' , 'jetpack' ); ?>
</ span >
< span class = " condition-intersection " >
< ? php echo esc_html_x ( 'and' , 'Shown between widget visibility conditions.' , 'jetpack' ); ?>
</ span >
< div class = " actions alignright " >
< a href = " # " class = " delete-condition dashicons dashicons-no " >< ? php esc_html_e ( 'Delete' , 'jetpack' ); ?> </a><a href="#" class="add-condition dashicons dashicons-plus"><?php esc_html_e( 'Add', 'jetpack' ); ?></a>
</ div >
</ div >
</ div ><!-- . condition -->
< ? php
}
?>
</ div ><!-- . conditions -->
< div class = " conditions " >
< div class = " condition-top " >
< label >
< input
type = " checkbox "
2021-07-23 11:58:50 +02:00
name = " <?php echo esc_attr( $widget->get_field_name ( 'conditions[match_all]' ) ); ?> "
2019-11-15 23:26:29 +01:00
value = " 1 "
class = " conditions-match-all "
< ? php checked ( $conditions [ 'match_all' ], '1' ); ?> />
< ? php esc_html_e ( 'Match all conditions' , 'jetpack' ); ?>
</ label >
</ div ><!-- . condition - top -->
</ div ><!-- . conditions -->
</ div ><!-- . widget - conditional - inner -->
</ div ><!-- . widget - conditional -->
< ? php
}
/**
* On an AJAX update of the widget settings , process the display conditions .
*
2021-07-23 11:58:50 +02:00
* @ param array $instance The current instance ' s settings .
2019-11-15 23:26:29 +01:00
* @ param array $new_instance New settings for this instance as input by the user .
* @ param array $old_instance Old settings for this instance .
* @ return array Modified settings .
*/
public static function widget_update ( $instance , $new_instance , $old_instance ) {
$conditions = array ();
2021-07-23 11:58:50 +02:00
$conditions [ 'action' ] = isset ( $new_instance [ 'conditions' ][ 'action' ] ) ? $new_instance [ 'conditions' ][ 'action' ] : null ;
2022-04-02 10:26:41 +02:00
$conditions [ 'match_all' ] = ! empty ( $new_instance [ 'conditions' ][ 'match_all' ] ) ? '1' : '0' ;
2021-07-23 11:58:50 +02:00
$conditions [ 'rules' ] = isset ( $new_instance [ 'conditions' ][ 'rules' ] ) ? $new_instance [ 'conditions' ][ 'rules' ] : array ();
if ( isset ( $new_instance [ 'conditions' ][ 'rules_major' ] ) ) {
foreach ( $new_instance [ 'conditions' ][ 'rules_major' ] as $index => $major_rule ) {
if ( ! $major_rule ) {
continue ;
}
2019-11-15 23:26:29 +01:00
2021-07-23 11:58:50 +02:00
$conditions [ 'rules' ][] = array (
'major' => $major_rule ,
'minor' => isset ( $new_instance [ 'conditions' ][ 'rules_minor' ][ $index ] ) ? $new_instance [ 'conditions' ][ 'rules_minor' ][ $index ] : '' ,
'has_children' => isset ( $new_instance [ 'conditions' ][ 'page_children' ][ $index ] ) ? true : false ,
);
2019-11-15 23:26:29 +01:00
}
}
if ( ! empty ( $conditions [ 'rules' ] ) ) {
$instance [ 'conditions' ] = $conditions ;
2021-07-23 11:58:50 +02:00
} elseif ( empty ( $new_instance [ 'conditions' ][ 'rules' ] ) ) {
2019-11-15 23:26:29 +01:00
unset ( $instance [ 'conditions' ] );
}
if (
( isset ( $instance [ 'conditions' ] ) && ! isset ( $old_instance [ 'conditions' ] ) )
||
(
isset ( $instance [ 'conditions' ], $old_instance [ 'conditions' ] )
&&
2022-04-02 10:26:41 +02:00
serialize ( $instance [ 'conditions' ] ) !== serialize ( $old_instance [ 'conditions' ] ) // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
2019-11-15 23:26:29 +01:00
)
) {
/**
* Fires after the widget visibility conditions are saved .
*
* @ module widget - visibility
*
* @ since 2.4 . 0
*/
do_action ( 'widget_conditions_save' );
} elseif ( ! isset ( $instance [ 'conditions' ] ) && isset ( $old_instance [ 'conditions' ] ) ) {
/**
* Fires after the widget visibility conditions are deleted .
*
* @ module widget - visibility
*
* @ since 2.4 . 0
*/
do_action ( 'widget_conditions_delete' );
}
return $instance ;
}
/**
* Filter the list of widgets for a sidebar so that active sidebars work as expected .
*
* @ param array $widget_areas An array of widget areas and their widgets .
* @ return array The modified $widget_area array .
*/
public static function sidebars_widgets ( $widget_areas ) {
$settings = array ();
2023-04-26 17:39:43 +02:00
if ( ! is_array ( $widget_areas ) ) {
return $widget_areas ;
}
2019-11-15 23:26:29 +01:00
foreach ( $widget_areas as $widget_area => $widgets ) {
if ( empty ( $widgets ) ) {
continue ;
}
if ( ! is_array ( $widgets ) ) {
continue ;
}
2022-04-02 10:26:41 +02:00
if ( 'wp_inactive_widgets' === $widget_area ) {
2019-11-15 23:26:29 +01:00
continue ;
}
foreach ( $widgets as $position => $widget_id ) {
// Find the conditions for this widget.
if ( preg_match ( '/^(.+?)-(\d+)$/' , $widget_id , $matches ) ) {
$id_base = $matches [ 1 ];
2020-11-18 09:10:44 +01:00
$widget_number = ( int ) $matches [ 2 ];
2019-11-15 23:26:29 +01:00
} else {
$id_base = $widget_id ;
$widget_number = null ;
}
if ( ! isset ( $settings [ $id_base ] ) ) {
$settings [ $id_base ] = get_option ( 'widget_' . $id_base );
}
2022-04-02 10:26:41 +02:00
// New multi widget (WP_Widget).
2022-06-16 14:01:47 +02:00
if ( $widget_number !== null ) {
2019-11-15 23:26:29 +01:00
if ( isset ( $settings [ $id_base ][ $widget_number ] ) && false === self :: filter_widget ( $settings [ $id_base ][ $widget_number ] ) ) {
unset ( $widget_areas [ $widget_area ][ $position ] );
}
2022-04-02 10:26:41 +02:00
} elseif ( ! empty ( $settings [ $id_base ] ) && false === self :: filter_widget ( $settings [ $id_base ] ) ) { // Old single widget.
2019-11-15 23:26:29 +01:00
unset ( $widget_areas [ $widget_area ][ $position ] );
}
}
}
return $widget_areas ;
}
2022-04-02 10:26:41 +02:00
/**
* Set field $passed_template_redirect to true .
*/
2019-11-15 23:26:29 +01:00
public static function template_redirect () {
self :: $passed_template_redirect = true ;
}
/**
2022-04-02 10:26:41 +02:00
* Generates a condition key based on the rule array .
2019-11-15 23:26:29 +01:00
*
2022-04-02 10:26:41 +02:00
* @ param array $rule rule data .
2019-11-15 23:26:29 +01:00
* @ return string key used to retrieve the condition .
*/
2022-04-02 10:26:41 +02:00
public static function generate_condition_key ( $rule ) {
2019-11-15 23:26:29 +01:00
if ( isset ( $rule [ 'has_children' ] ) ) {
return $rule [ 'major' ] . ':' . $rule [ 'minor' ] . ':' . $rule [ 'has_children' ];
}
return $rule [ 'major' ] . ':' . $rule [ 'minor' ];
}
2025-12-12 13:13:07 +01:00
/**
* Normalize widget `content` into a string suitable for block scanning .
*
* @ since 15.1
*
* @ param mixed $content The widget instance 'content' value .
* @ return string | false Normalized string content or false if none .
*/
private static function normalize_widget_content ( $content ) {
if ( empty ( $content ) ) {
return false ;
}
if ( is_string ( $content ) ) {
return $content ;
}
if ( ! is_array ( $content ) ) {
return false ;
}
if ( isset ( $content [ 'content' ] ) && is_string ( $content [ 'content' ] ) ) {
return $content [ 'content' ];
}
if ( isset ( $content [ 0 ] ) && is_array ( $content [ 0 ] ) && isset ( $content [ 0 ][ 'blockName' ] ) ) {
// Looks like a parsed blocks array.
return serialize_blocks ( $content );
}
// Unknown array shape: treat as no visibility rules.
return false ;
}
2019-11-15 23:26:29 +01:00
/**
* Determine whether the widget should be displayed based on conditions set by the user .
*
* @ param array $instance The widget settings .
* @ return array Settings to display or bool false to hide .
*/
public static function filter_widget ( $instance ) {
2021-07-23 11:58:50 +02:00
// Don't filter widgets from the REST API when it's called via the widgets admin page - otherwise they could get
// filtered out and become impossible to edit.
2023-12-07 09:44:11 +01:00
if ( strpos ( wp_get_raw_referer (), '/wp-admin/widgets.php' ) && isset ( $_SERVER [ 'REQUEST_URI' ] ) && str_contains ( filter_var ( wp_unslash ( $_SERVER [ 'REQUEST_URI' ] ) ), '/wp-json/' ) ) {
2021-07-23 11:58:50 +02:00
return $instance ;
}
2022-04-02 10:26:41 +02:00
// WordPress.com specific check - here, referer ends in /rest-proxy/ and doesn't tell us what's requesting.
$current_url = ! empty ( $_SERVER [ 'REQUEST_URI' ] ) ? esc_url_raw ( wp_unslash ( $_SERVER [ 'REQUEST_URI' ] ) ) : '' ;
$nonce = ! empty ( $_REQUEST [ '_gutenberg_nonce' ] ) ? sanitize_text_field ( wp_unslash ( $_REQUEST [ '_gutenberg_nonce' ] ) ) : '' ;
$context = ! empty ( $_REQUEST [ 'context' ] ) ? sanitize_text_field ( wp_unslash ( $_REQUEST [ 'context' ] ) ) : '' ;
if ( wp_verify_nonce ( $nonce , 'gutenberg_request' ) &&
1 === preg_match ( '~^/wp/v2/sites/\d+/(sidebars|widgets)~' , $current_url ) && 'edit' === $context ) {
return $instance ;
}
2021-07-23 11:58:50 +02:00
2022-04-02 10:26:41 +02:00
if ( ! empty ( $instance [ 'conditions' ][ 'rules' ] ) ) {
// Legacy widgets: visibility found.
if ( self :: filter_widget_check_conditions ( $instance [ 'conditions' ] ) ) {
return $instance ;
}
return false ;
2025-12-12 13:13:07 +01:00
}
2025-08-27 08:44:30 +02:00
2025-12-12 13:13:07 +01:00
if ( empty ( $instance [ 'content' ] ) ) {
return $instance ;
}
$content = self :: normalize_widget_content ( isset ( $instance [ 'content' ] ) ? $instance [ 'content' ] : null );
2025-08-27 08:44:30 +02:00
2025-12-12 13:13:07 +01:00
if ( false === $content || ! has_blocks ( $content ) ) {
// No visibility found.
return $instance ;
}
2025-08-27 08:44:30 +02:00
2025-12-12 13:13:07 +01:00
$scanner = Block_Scanner :: create ( $content );
if ( ! $scanner ) {
// No Rules: Display widget.
return $instance ;
}
2025-08-27 08:44:30 +02:00
2025-12-12 13:13:07 +01:00
// Find the first block that opens
while ( $scanner -> next_delimiter () ) {
if ( ! $scanner -> opens_block () ) {
continue ;
}
$attributes = $scanner -> allocate_and_return_parsed_attributes ();
2025-08-27 08:44:30 +02:00
2025-12-12 13:13:07 +01:00
if ( ! is_array ( $attributes ) || empty ( $attributes [ 'conditions' ][ 'rules' ] ) ) {
// No Rules: Display widget.
return $instance ;
}
if ( self :: filter_widget_check_conditions ( $attributes [ 'conditions' ] ) ) {
// Rules passed checks: Display widget.
return $instance ;
2022-04-02 10:26:41 +02:00
}
2025-12-12 13:13:07 +01:00
// Rules failed checks: Hide widget.
return false ;
}
2022-04-02 10:26:41 +02:00
// No visibility found.
return $instance ;
}
/**
* Determine whether the widget should be displayed based on conditions set by the user .
*
* @ param array $conditions Visibility Conditions : An array with keys 'rules' , 'action' , and 'match_all' .
* @ return bool If the widget controlled by these conditions should show .
*/
public static function filter_widget_check_conditions ( $conditions ) {
global $wp_query ;
2019-11-15 23:26:29 +01:00
// Store the results of all in-page condition lookups so that multiple widgets with
// the same visibility conditions don't result in duplicate DB queries.
static $condition_result_cache = array ();
$condition_result = false ;
2022-04-02 10:26:41 +02:00
foreach ( $conditions [ 'rules' ] as $rule ) {
2019-11-15 23:26:29 +01:00
$condition_result = false ;
$condition_key = self :: generate_condition_key ( $rule );
if ( isset ( $condition_result_cache [ $condition_key ] ) ) {
$condition_result = $condition_result_cache [ $condition_key ];
} else {
switch ( $rule [ 'major' ] ) {
case 'date' :
switch ( $rule [ 'minor' ] ) {
case '' :
$condition_result = is_date ();
break ;
case 'month' :
$condition_result = is_month ();
break ;
case 'day' :
$condition_result = is_day ();
break ;
case 'year' :
$condition_result = is_year ();
break ;
}
break ;
case 'page' :
// Previously hardcoded post type options.
2022-04-02 10:26:41 +02:00
if ( 'post' === $rule [ 'minor' ] ) {
2019-11-15 23:26:29 +01:00
$rule [ 'minor' ] = 'post_type-post' ;
} elseif ( ! $rule [ 'minor' ] ) {
$rule [ 'minor' ] = 'post_type-page' ;
}
switch ( $rule [ 'minor' ] ) {
case '404' :
$condition_result = is_404 ();
break ;
case 'search' :
$condition_result = is_search ();
break ;
case 'archive' :
$condition_result = is_archive ();
break ;
case 'posts' :
$condition_result = $wp_query -> is_posts_page ;
break ;
case 'home' :
$condition_result = is_home ();
break ;
case 'front' :
if ( current_theme_supports ( 'infinite-scroll' ) ) {
$condition_result = is_front_page ();
} else {
$condition_result = is_front_page () && ! is_paged ();
}
break ;
default :
2023-12-07 09:44:11 +01:00
if ( str_starts_with ( $rule [ 'minor' ], 'post_type-' ) ) {
2019-11-15 23:26:29 +01:00
$condition_result = is_singular ( substr ( $rule [ 'minor' ], 10 ) );
2023-12-07 09:44:11 +01:00
} elseif ( str_starts_with ( $rule [ 'minor' ], 'post_type_archive-' ) ) {
2019-11-15 23:26:29 +01:00
$condition_result = is_post_type_archive ( substr ( $rule [ 'minor' ], 18 ) );
2022-04-02 10:26:41 +02:00
} elseif ( get_option ( 'page_for_posts' ) === $rule [ 'minor' ] ) {
// If $rule['minor'] is a page ID which is also the posts page.
2019-11-15 23:26:29 +01:00
$condition_result = $wp_query -> is_posts_page ;
} else {
// $rule['minor'] is a page ID
2022-04-02 10:26:41 +02:00
$condition_result = is_page () && ( get_the_ID () === ( int ) $rule [ 'minor' ] );
2019-11-15 23:26:29 +01:00
2022-04-02 10:26:41 +02:00
// Check if $rule['minor'] is parent of page ID.
2019-11-15 23:26:29 +01:00
if ( ! $condition_result && isset ( $rule [ 'has_children' ] ) && $rule [ 'has_children' ] ) {
2022-04-02 10:26:41 +02:00
$condition_result = wp_get_post_parent_id ( get_the_ID () ) === ( int ) $rule [ 'minor' ];
2019-11-15 23:26:29 +01:00
}
}
break ;
}
break ;
case 'tag' :
// All tag pages.
if ( ! $rule [ 'minor' ] ) {
if ( is_tag () ) {
$condition_result = true ;
} elseif ( is_singular () ) {
2022-04-02 10:26:41 +02:00
if ( in_array ( 'post_tag' , get_post_taxonomies (), true ) ) {
2019-11-15 23:26:29 +01:00
$condition_result = true ;
}
}
break ;
}
// All pages with the specified tag term.
if ( is_tag ( $rule [ 'minor' ] ) ) {
$condition_result = true ;
} elseif ( is_singular () && has_term ( $rule [ 'minor' ], 'post_tag' ) ) {
$condition_result = true ;
}
break ;
case 'category' :
// All category pages.
if ( ! $rule [ 'minor' ] ) {
if ( is_category () ) {
$condition_result = true ;
} elseif ( is_singular () ) {
2022-04-02 10:26:41 +02:00
if ( in_array ( 'category' , get_post_taxonomies (), true ) ) {
2019-11-15 23:26:29 +01:00
$condition_result = true ;
}
}
break ;
}
// All pages with the specified category term.
if ( is_category ( $rule [ 'minor' ] ) ) {
$condition_result = true ;
} elseif ( is_singular () && has_term ( $rule [ 'minor' ], 'category' ) ) {
$condition_result = true ;
}
break ;
case 'loggedin' :
$condition_result = is_user_logged_in ();
if ( 'loggedin' !== $rule [ 'minor' ] ) {
$condition_result = ! $condition_result ;
}
break ;
case 'author' :
if ( ! $rule [ 'minor' ] && is_author () ) {
$condition_result = true ;
} elseif ( $rule [ 'minor' ] && is_author ( $rule [ 'minor' ] ) ) {
$condition_result = true ;
2025-02-28 08:42:11 +01:00
} elseif ( is_singular () && $rule [ 'minor' ] ) {
$post = get_post ();
if ( $post && $rule [ 'minor' ] === $post -> post_author ) {
$condition_result = true ;
}
2019-11-15 23:26:29 +01:00
}
break ;
case 'role' :
if ( is_user_logged_in () ) {
$current_user = wp_get_current_user ();
$user_roles = $current_user -> roles ;
2022-04-02 10:26:41 +02:00
if ( in_array ( $rule [ 'minor' ], $user_roles , true ) ) {
2019-11-15 23:26:29 +01:00
$condition_result = true ;
} else {
$condition_result = false ;
}
} else {
$condition_result = false ;
}
break ;
case 'post_type' :
2023-12-07 09:44:11 +01:00
if ( str_starts_with ( $rule [ 'minor' ], 'post_type-' ) ) {
2019-11-15 23:26:29 +01:00
$condition_result = is_singular ( substr ( $rule [ 'minor' ], 10 ) );
2023-12-07 09:44:11 +01:00
} elseif ( str_starts_with ( $rule [ 'minor' ], 'post_type_archive-' ) ) {
2019-11-15 23:26:29 +01:00
$condition_result = is_post_type_archive ( substr ( $rule [ 'minor' ], 18 ) );
}
break ;
case 'taxonomy' :
// All taxonomy pages.
if ( ! $rule [ 'minor' ] ) {
if ( is_archive () ) {
if ( is_tag () || is_category () || is_tax () ) {
$condition_result = true ;
}
} elseif ( is_singular () ) {
$post_taxonomies = get_post_taxonomies ();
$condition_result = ! empty ( $post_taxonomies );
}
break ;
}
// Specified taxonomy page.
2022-04-02 10:26:41 +02:00
$term = explode ( '_tax_' , $rule [ 'minor' ] ); // $term[0] is taxonomy name; $term[1] is term id.
2019-11-15 23:26:29 +01:00
if ( isset ( $term [ 0 ] ) && isset ( $term [ 1 ] ) ) {
$term [ 1 ] = self :: maybe_get_split_term ( $term [ 1 ], $term [ 0 ] );
}
// All pages of the specified taxonomy.
if ( ! isset ( $term [ 1 ] ) || ! $term [ 1 ] ) {
if ( is_tax ( $term [ 0 ] ) ) {
$condition_result = true ;
} elseif ( is_singular () ) {
2022-04-02 10:26:41 +02:00
if ( in_array ( $term [ 0 ], get_post_taxonomies (), true ) ) {
2019-11-15 23:26:29 +01:00
$condition_result = true ;
}
}
break ;
}
// All pages with the specified taxonomy term.
if ( is_tax ( $term [ 0 ], $term [ 1 ] ) ) {
$condition_result = true ;
} elseif ( is_singular () && has_term ( $term [ 1 ], $term [ 0 ] ) ) {
$condition_result = true ;
}
break ;
}
if ( $condition_result || self :: $passed_template_redirect ) {
// Some of the conditions will return false when checked before the template_redirect
// action has been called, like is_page(). Only store positive lookup results, which
// won't be false positives, before template_redirect, and everything after.
$condition_result_cache [ $condition_key ] = $condition_result ;
}
}
if (
2022-04-02 10:26:41 +02:00
isset ( $conditions [ 'match_all' ] )
&& '1' === $conditions [ 'match_all' ]
2019-11-15 23:26:29 +01:00
&& ! $condition_result
) {
2022-04-02 10:26:41 +02:00
// In case the match_all flag was set we quit on first failed condition.
2019-11-15 23:26:29 +01:00
break ;
} elseif (
(
2022-04-02 10:26:41 +02:00
empty ( $conditions [ 'match_all' ] )
|| '1' !== $conditions [ 'match_all' ]
2019-11-15 23:26:29 +01:00
)
&& $condition_result
) {
2022-04-02 10:26:41 +02:00
// Only quit on first condition if the match_all flag was not set.
2019-11-15 23:26:29 +01:00
break ;
}
}
if (
(
2022-04-02 10:26:41 +02:00
'show' === $conditions [ 'action' ]
2019-11-15 23:26:29 +01:00
&& ! $condition_result
) || (
2022-04-02 10:26:41 +02:00
'hide' === $conditions [ 'action' ]
2019-11-15 23:26:29 +01:00
&& $condition_result
)
) {
return false ;
}
2022-04-02 10:26:41 +02:00
return true ;
2019-11-15 23:26:29 +01:00
}
2022-04-02 10:26:41 +02:00
/**
* Helper function wrapping strcasecmp to compare term names .
*
* @ param string $a str1 .
* @ param string $b str2 .
*/
2019-11-15 23:26:29 +01:00
public static function strcasecmp_name ( $a , $b ) {
return strcasecmp ( $a -> name , $b -> name );
}
2022-04-02 10:26:41 +02:00
/**
* Determine if provided term has been split .
*
* @ param int $old_term_id Old term id to test .
* @ param string $taxonomy Taxonmy that $old_term_id belongs to .
*/
2019-11-15 23:26:29 +01:00
public static function maybe_get_split_term ( $old_term_id = '' , $taxonomy = '' ) {
$term_id = $old_term_id ;
2022-04-02 10:26:41 +02:00
if ( 'tag' === $taxonomy ) {
2019-11-15 23:26:29 +01:00
$taxonomy = 'post_tag' ;
}
2022-04-02 10:26:41 +02:00
$new_term_id = wp_get_split_term ( $old_term_id , $taxonomy );
if ( $new_term_id ) {
2019-11-15 23:26:29 +01:00
$term_id = $new_term_id ;
}
return $term_id ;
}
/**
* Upgrade routine to go through all widgets and move the Post Type
* setting to its newer location .
*
* @ since 4.7 . 1
*/
2022-04-02 10:26:41 +02:00
public static function migrate_post_type_rules () {
2025-04-25 12:30:07 +02:00
global $wp_widget_factory , $wp_registered_widgets ;
'@phan-var \WP_Widget_Factory $wp_widget_factory' ;
2019-11-15 23:26:29 +01:00
$sidebars_widgets = get_option ( 'sidebars_widgets' );
2025-12-12 13:13:07 +01:00
if ( ! is_array ( $sidebars_widgets ) ) {
return ;
}
2022-04-02 10:26:41 +02:00
// Going through all sidebars and through inactive and orphaned widgets.
foreach ( $sidebars_widgets as $sidebar ) {
2019-11-15 23:26:29 +01:00
if ( ! is_array ( $sidebar ) ) {
continue ;
}
2022-04-02 10:26:41 +02:00
foreach ( $sidebar as $widget ) {
2019-11-15 23:26:29 +01:00
// $widget is the id of the widget
if ( empty ( $wp_registered_widgets [ $widget ] ) ) {
continue ;
}
2025-04-25 12:30:07 +02:00
$id_base = wp_parse_widget_id ( $widget )[ 'id_base' ];
$widget_object = $wp_widget_factory -> get_widget_object ( $id_base );
if ( ! $widget_object ) {
continue ;
}
$instances = get_option ( $widget_object -> option_name );
2019-11-15 23:26:29 +01:00
2022-06-16 14:01:47 +02:00
if ( ! is_array ( $instances ) || empty ( $instances ) ) {
continue ;
}
2022-04-02 10:26:41 +02:00
// Going through each instance of the widget.
2019-11-15 23:26:29 +01:00
foreach ( $instances as $number => $instance ) {
if (
! is_array ( $instance ) ||
2025-12-12 13:13:07 +01:00
empty ( $instance [ 'conditions' ][ 'rules' ] ) ||
! is_array ( $instance [ 'conditions' ][ 'rules' ] )
2019-11-15 23:26:29 +01:00
) {
continue ;
}
2022-04-02 10:26:41 +02:00
// Going through all visibility rules.
2019-11-15 23:26:29 +01:00
foreach ( $instance [ 'conditions' ][ 'rules' ] as $index => $rule ) {
2022-04-02 10:26:41 +02:00
// We only need Post Type rules.
2019-11-15 23:26:29 +01:00
if ( 'post_type' !== $rule [ 'major' ] ) {
continue ;
}
$rule_type = false ;
2022-04-02 10:26:41 +02:00
// Post type or type archive rule.
2023-12-07 09:44:11 +01:00
if ( str_starts_with ( $rule [ 'minor' ], 'post_type_archive' ) ) {
2019-11-15 23:26:29 +01:00
$rule_type = 'post_type_archive' ;
2023-12-07 09:44:11 +01:00
} elseif ( str_starts_with ( $rule [ 'minor' ], 'post_type' ) ) {
2019-11-15 23:26:29 +01:00
$rule_type = 'post_type' ;
}
if ( $rule_type ) {
$post_type = substr ( $rule [ 'minor' ], strlen ( $rule_type ) + 1 );
$rule [ 'minor' ] = $rule_type . '-' . $post_type ;
$rule [ 'major' ] = 'page' ;
$instances [ $number ][ 'conditions' ][ 'rules' ][ $index ] = $rule ;
}
}
}
2025-04-25 12:30:07 +02:00
update_option ( $widget_object -> option_name , $instances );
2019-11-15 23:26:29 +01:00
}
}
}
}
add_action ( 'init' , array ( 'Jetpack_Widget_Conditions' , 'init' ) );
2022-04-02 10:26:41 +02:00
// Add the 'conditions' attribute to server side rendered blocks
// 'init' happens too late to hook on block registration.
global $pagenow ;
$current_url = ! empty ( $_SERVER [ 'REQUEST_URI' ] ) ? esc_url_raw ( wp_unslash ( $_SERVER [ 'REQUEST_URI' ] ) ) : '' ;
2022-12-15 17:41:53 +01:00
if ( is_customize_preview ()
|| 'widgets.php' === $pagenow
2023-12-07 09:44:11 +01:00
|| str_contains ( $current_url , '/wp-json/wp/v2/block-renderer' )
2022-12-15 17:41:53 +01:00
|| 1 === preg_match ( '~^/wp/v2/sites/\d+/block-renderer~' , $current_url )
) {
2022-04-02 10:26:41 +02:00
Jetpack_Widget_Conditions :: add_block_attributes_filter ();
}