em['properties']['dynamicContent']['related']) &&
$item['properties']['dynamicContent']['related'] === true &&
!empty($item['properties']['dynamicContent']['relatedCollection'])
) {
$result[$item['properties']['dynamicContent']['relatedCollection']] = true;
}
}
return $result;
}
public static function get_custom_fonts_tags()
{
$custom_fonts = HelperFunctions::get_global_data_using_key(KIRKI_USER_CUSTOM_FONTS_META_KEY);
if ($custom_fonts) {
$s = '';
foreach ($custom_fonts as $key => $fonts_data) {
$s .= self::getFontsHTMLMarkup($fonts_data);
}
return $s;
}
}
public static function getFontsHTMLMarkup($fonts_data)
{
if (isset($fonts_data['fontUrl'])) {
$font_url = isset($fonts_data['localUrl']) ? $fonts_data['localUrl'] : $fonts_data['fontUrl'];
//phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedStylesheet
return '';
}
return '';
}
/**
* Generate new id and html string for: symbol, collection etc.
*
* @param array $data blocks.
* @param array $style_blocks style_blocks.
* @param string $root data root.
*/
public static function rec_update_data_id_then_return_new_html($data, $style_blocks, $root = 'body', $options = [], $get_style = true)
{
$data_helper = new DataHelper();
$data_helper->rec_update_data_id_to_new_id($data, $style_blocks, $root, null);
$data = $data_helper->temp_data;
$style_blocks = $data_helper->temp_styles;
$root = isset($data_helper->temp_ids[$root]) ? $data_helper->temp_ids[$root] : false;
$params = array(
'blocks' => $data,
'style_blocks' => $style_blocks,
'root' => $root,
'post_id' => null,
'options' => $options,
'get_style' => $get_style,
'get_all_style_forcefully_if_get_style_true' => true,//this will generate collection first item all style
);
return self::get_html_using_preview_script($params);
}
// hook
public static function kirki_html_generator($s, $post_id, $staging_version = false)
{
$d = self::is_kirki_type_data($post_id, $staging_version);
if ($d) {
$params = array(
'blocks' => $d['blocks'],
'style_blocks' => $d['styles'],
'root' => 'root',
'post_id' => $post_id,
);
return self::get_html_using_preview_script($params);
}
return false;
}
/**
* Find symbol for post id using condition
* it will find and return selected symbols html and css;
*
* @param string $type : post | user
* @param array $context : post object or user object
* @return symbol || bool(false)
*/
public static function find_template_for_this_context($type = 'post', $context = null)
{
$templates = Page::fetch_list('kirki_template', true, array('publish'));
if (!$templates || !$context)
return false;
foreach ($templates as $key => $template) {
if (isset($template['conditions'])) {
$conditions = $template['conditions'];
if ($type === 'user') {
if (self::check_all_conditions_for_this_user($context, $conditions)) {
return $template;
}
} else if ($type === 'post') {
if (self::check_all_conditions_for_this_post($context, $conditions)) {
return $template;
}
} else if ($type === 'term') {
if (self::check_all_conditions_for_this_term($context, $conditions)) {
return $template;
}
}
}
}
return false;
}
/**
* Generate popup html
*
* @return strint
*/
public static function get_page_popups_html()
{
global $post;
if ($post) {
$popups = self::get_page_popups();
if (count($popups) > 0) {
$s = '';
foreach ($popups as $key => $popup) {
$params = array(
'blocks' => $popup['blocks'],
'style_blocks' => $popup['styleBlocks'],
'root' => $popup['root'],
'post_id' => $popup['id'],
);
$s .= self::get_html_using_preview_script($params);
}
return do_shortcode($s);
}
}
return '';
}
/**
* Get Custom popups
* it will find and return selected popups;
*
* @return array
*/
public static function get_page_popups()
{
global $post;
if ($post) {
$popups = Page::fetch_list('kirki_popup', true, array('publish'));
return self::find_popups_for_this_post($popups, $post);
}
return array();
}
/**
* Find popups for post id using condition
* it will find and return selected popups arr;
*
* @param object $popups popup block object.
* @param object $post post object.
* @return popups || [];
*/
public static function find_popups_for_this_post($popups, $post)
{
$arr = array();
$post_id = $post->ID;
foreach ($popups as $key => $popup) {
$popup = self::format_single_popup_data_for_html_print($popup);
if (self::check_popup_pagearr_logic($popup, $post_id)) {
$arr[] = $popup;
}
}
return $arr;
}
private static function format_single_popup_data_for_html_print($popup)
{
if (!$popup['blocks'])
return $popup;
$root = false;
foreach ($popup['blocks'] as $key2 => &$b) {
if ('root' === $b['parentId']) {
$root = $b['id'];
if (isset($b['properties']['attributes'])) {
$b['properties']['attributes']['popup-id'] = $popup['id'];
} else {
$b['properties']['attributes'] = array(
'popup-id' => $popup['id'],
);
}
$popup['root'] = $root;
}
}
return $popup;
}
/**
* Check popup is active apply for this post or not.
*
* @param array $popup popup from Page::fetch_list.
* @param int $post_id wp post id.
* @return bool
*/
private static function check_popup_pagearr_logic($popup, $post_id)
{
if (!isset($popup['root']))
return false;
$root = $popup['root'];
if ($root && isset($popup['blocks'][$root]['properties']['popup']['visibilityConditions'])) {
$conditions = $popup['blocks'][$root]['properties']['popup']['visibilityConditions'];
$post = get_post($post_id);
if (self::check_all_conditions_for_this_post($post, $conditions) || in_array($popup['id'], Preview::$only_used_popup_id_array, true)) {
return true;
}
}
return false;
}
/**
* Check all conditon for this post
* This method will match all the condition and return true or false
* category = * || post_type
* taxonomy = 1=single post || * = all post || taxonomy slug
* apply[to] = * = all || id = post id || term id
* visibility = show || hide
*
* @param object $post post object.
* @param object $conditions symbol visibility condiotions object.
*
* @return Boolean
*/
public static function check_all_conditions_for_this_post($post, $conditions)
{
$show_flag = false;
$hide_flag = false;
foreach ($conditions as $key => $condition) {
if (!isset($condition['from'])) {
$condition['from'] = 'post';
}
if ($condition['from'] === 'term') {
return false;
}
if (isset($condition['category'])) {
//legacy
if ($condition['category'] === '*') {
$condition['type'] = '*';
} else {
$condition['post_type'] = $condition['category'];
$condition['type'] = 'post';
}
}
if (!isset($condition['visibility'])) {
$condition['visibility'] = 'show';
}
if ($condition['type'] === '*') {
// Entire site
$show_flag = $condition['visibility'] === 'show';
} elseif ($condition['type'] === 'post') {
if ($condition['post_type'] === $post->post_type) {
// Post type related
if ($condition['where'] == '*') {
// All posts
$show_flag = $condition['visibility'] === 'show';
} elseif ($condition['where'] == 'single') {
// Single post
if ($condition['to'] === $post->ID) {
$show_flag = $condition['visibility'] === 'show';
$hide_flag = $condition['visibility'] === 'hide';
}
} else {
// Taxonomy
$taxonomy = $condition['where'];
$term = $condition['to'];
if ($term === '*') {
// All terms
$show_flag = $condition['visibility'] === 'show';
} else {
if (has_term($term, $taxonomy, $post->ID)) {
$show_flag = $condition['visibility'] === 'show';
$hide_flag = $condition['visibility'] === 'hide';
}
}
}
}
}
// If hide flag is set, stop and return false
if ($hide_flag) {
return false;
}
}
return $show_flag;
}
public static function check_all_conditions_for_this_term($term, $conditions)
{
$show_flag = false;
$hide_flag = false;
foreach ($conditions as $key => $condition) {
if (!isset($condition['visibility'])) {
$condition['visibility'] = 'show';
}
if (!isset($condition['from'])) {
$condition['from'] = 'post';
}
if ($condition['from'] !== 'term') {
return false;
}
if ($condition['type'] === '*') {
// Entire site
$show_flag = $condition['visibility'] === 'show';
} elseif ($condition['type'] === 'post') {
if ($condition['post_type'] === $term['post_type']) {
// Post type related
if ($condition['where'] == '*') {
// All posts
$show_flag = $condition['visibility'] === 'show';
} else {
// Taxonomy
$taxonomy = $condition['where'];
$con_term = $condition['to'];
if ($con_term === '*') {
// All terms
$show_flag = $condition['visibility'] === 'show';
} else {
if ($term['taxonomy'] == $con_term) {
$show_flag = $condition['visibility'] === 'show';
$hide_flag = $condition['visibility'] === 'hide';
}
}
}
}
}
// If hide flag is set, stop and return false
if ($hide_flag) {
return false;
}
}
return $show_flag;
}
public static function check_all_conditions_for_this_user($user, $conditions)
{
$show_flag = false;
$hide_flag = false;
foreach ($conditions as $key => $condition) {
if (isset($condition['category'])) {
//legacy
if ($condition['category'] === '*') {
$condition['type'] = '*';
} else {
$condition['post_type'] = $condition['category'];
$condition['type'] = 'post';
}
}
if (!isset($condition['visibility'])) {
$condition['visibility'] = 'show';
}
if ($condition['type'] === '*') {
// Entire site
$show_flag = $condition['visibility'] === 'show';
} elseif ($condition['type'] === 'user') {
if ($condition['where'] === '*') {
$show_flag = $condition['visibility'] === 'show';
} elseif ($condition['where'] === 'role') {
$user_role = $condition['to'];
if ($user_role === '*') {
$show_flag = $condition['visibility'] === 'show';
} else {
$curr_user = $user;
if (in_array($user_role, $curr_user['roles'])) {
$show_flag = $condition['visibility'] === 'show';
}
}
}
}
if ($hide_flag) {
return false;
}
}
return $show_flag;
}
private static function attribute_in_post_table($attr = '')
{
$post_table_attributes = array(
'ID',
'post_author',
'post_date',
'post_date_gmt',
'post_content',
'post_title',
'post_excerpt',
'post_status',
'post_name',
'post_type',
'post_category',
'term'
);
return in_array($attr, $post_table_attributes, true);
}
private static function sort_filters_by_relation($filter_items = array())
{
$sorted_array = array();
if (is_array($filter_items)) {
array_walk($filter_items, function ($item) use (&$sorted_array) {
$relation_raw = isset($item['relation']) ? $item['relation'] : 'OR';
$relation = in_array(strtoupper($relation_raw), ['AND', 'OR'], true) ? strtoupper($relation_raw) : 'OR';
if (!isset($sorted_array[$relation])) {
$sorted_array[$relation] = array();
}
unset($item['relation']);
$sorted_array[$relation][] = $item;
});
}
return $sorted_array;
}
/**
* text, number, date/time, options, switch
*/
private static function post_table_filter_query($filter_item, $data_type)
{
$field_name = $filter_item['id'];
$sorted_array = self::sort_filters_by_relation($filter_item['items']);
$where_sql = '';
array_walk($sorted_array, function ($sorted_array_item, $condition) use ($data_type, $field_name, &$where_sql) {
global $wpdb;
$conditions = array();
$column_name = "$wpdb->posts.$field_name";
array_walk($sorted_array_item, function ($filter_condition_item) use ($data_type, $column_name, &$conditions) {
switch ($data_type) {
case 'text': {
$conditions[] = PostsQueryUtils::post_table_text_query($column_name, $filter_condition_item['condition'], $filter_condition_item['value']);
break;
}
// case 'date': {
// $conditions[] = PostsQueryUtils::post_table_text_query($column_name, $filter_condition_item['condition'], $filter_condition_item['value']);
// break;
// }
// case 'number': {
// $conditions[] = PostsQueryUtils::post_table_number_query($column_name, $filter_condition_item['condition'], $filter_condition_item['value']);
// break;
// }
// case 'option': {
// $conditions[] = PostsQueryUtils::post_table_options_query($column_name, $filter_condition_item['condition'], $filter_condition_item['value']);
// break;
// }
// case 'switch': {
// $conditions[] = PostsQueryUtils::post_table_switch_query($column_name, $filter_condition_item['condition'], $filter_condition_item['value']);
// break;
// }
default: {
break;
}
}
});
if (empty($conditions)) {
return;
}
$condition_sql = implode(" {$condition} ", $conditions);
if ('OR' === $condition) {
$condition_sql = "({$condition_sql})";
}
/**
* A query to
* [x start with 'JoomShaper' or 'IcoFont' or 'Kirki'
* and contains 'website' and ends with 'Ollyo']
* will be like below:
*
* AND (x LIKE 'JoomShaper%' OR x LIKE 'IcoFont%' OR x LIKE 'Kirki%') AND x LIKE '%website%' AND x LIKE '%Ollyo'
*/
$where_sql .= " AND $condition_sql";
});
if (empty($where_sql)) {
return null;
}
$callback = function ($where) use ($where_sql) {
$where .= $where_sql;
return $where;
};
add_filter('posts_where', $callback);
return $callback;
}
/**
* text, number, date/time, options, switch
* help: https://wordpress.stackexchange.com/questions/159426/meta-query-with-string-starting-like-pattern
*/
private static function post_meta_table_filter_query($filter_item, $key, $data_type)
{
$sorted_array = self::sort_filters_by_relation($filter_item['items']);
$meta_query = array();
array_walk($sorted_array, function ($sorted_array_item, $condition) use (&$meta_query, $key, $data_type) {
if (count($sorted_array_item) > 0) {
$condition_arr = array('relation' => $condition);
array_walk($sorted_array_item, function ($filter_condition_item) use (&$condition_arr, $key, $data_type) {
switch ($data_type) {
case 'text': {
$condition_arr[] = PostsQueryUtils::post_meta_table_text_query($key, $filter_condition_item['condition'], $filter_condition_item['value']);
break;
}
case 'date': {
$condition_arr[] = PostsQueryUtils::post_meta_table_date_query($key, $filter_condition_item); // ['start-date' => '', 'end-date' => '']);
break;
}
case 'number': {
$condition_arr[] = PostsQueryUtils::post_meta_table_number_query($key, $filter_condition_item['condition'], $filter_condition_item['value']);
break;
}
case 'option': {
$condition_arr[] = PostsQueryUtils::post_meta_table_options_query($key, $filter_condition_item['condition'], $filter_condition_item['values']);
break;
}
case 'switch': {
$condition_arr[] = PostsQueryUtils::post_meta_table_switch_query($key, $filter_condition_item['condition']);
break;
}
default: {
break;
}
}
});
$meta_query[] = $condition_arr;
}
});
return $meta_query;
}
/**
* filter query for reference table
*
* @param object $filter_item filter item.
* @param string $key field meta key.
* @param array $args args.
*
* @return array args
*/
private static function cm_reference_table_filter_query($filter_item, $key, $args)
{
global $wpdb;
$sorted_array = self::sort_filters_by_relation($filter_item['items']);
$post_ids_in = [];
$post_ids_not_in = [];
$has_in_condition = false;
$has_not_in_condition = false;
foreach ($sorted_array as $relation_str => $filters_by_relation) {
foreach ($filters_by_relation as $filter_condition_item) {
$condition = $filter_condition_item['condition'];
$value = isset($filter_condition_item['value']) ? (int) $filter_condition_item['value'] : null;
if (!$value)
continue;
$results = $wpdb->get_col($wpdb->prepare(
"SELECT post_id FROM {$wpdb->prefix}kirki_cm_reference WHERE field_meta_key = %s AND ref_post_id = %d",
$key,
$value
));
$results = array_map('intval', $results);
if ($condition === 'in') {
$has_in_condition = true;
if ($relation_str === 'AND') {
$post_ids_in[] = $results;
} else {
$post_ids_in = array_merge($post_ids_in, $results);
}
} elseif ($condition === 'not-in') {
$has_not_in_condition = true;
if ($relation_str === 'AND') {
$post_ids_not_in[] = $results;
} else {
$post_ids_not_in = array_merge($post_ids_not_in, $results);
}
}
}
}
// Handle post__in only if there was an 'in' condition
if ($has_in_condition) {
if (!empty($post_ids_in)) {
$post_ids_in = is_array(reset($post_ids_in))
? array_reduce($post_ids_in, 'array_intersect', array_shift($post_ids_in)) // ids-> [[1,2], [2,3]] -> array_reduce($ids, 'array_intersect', [1,2])
: $post_ids_in;
$args['post__in'] = isset($args['post__in'])
? array_intersect($args['post__in'], $post_ids_in)
: $post_ids_in;
if (empty($args['post__in'])) {
$args['post__in'] = [0];
}
} else {
// 'in' condition was given, but returned nothing
$args['post__in'] = [0];
}
}
// Handle post__not_in normally
if ($has_not_in_condition && !empty($post_ids_not_in)) {
$post_ids_not_in = is_array(reset($post_ids_not_in))
? array_merge(...$post_ids_not_in)
: $post_ids_not_in;
$args['post__not_in'] = isset($args['post__not_in'])
? array_merge($args['post__not_in'], $post_ids_not_in)
: $post_ids_not_in;
}
return $args;
}
/**
* handle legacy filter data
*
* @param object $params filter array.
*
* @return array filter array
*/
public static function handle_legacy_filter_to_new_filter($filters)
{
$new_filters = array();
if (is_array($filters)) {
foreach ($filters as $key => $item) {
if (!isset($item['id']) && isset($item['type']) && $item['type']) {
switch ($item['type']) {
case 'date': {
$new_filters[] = array(
'type' => 'post_date',
'id' => 'post_date',
'title' => 'Post Date',
'items' => [
array(
'start-date' => isset($item['start-date']) ? $item['start-date'] : '',
'end-date' => isset($item['end-date']) ? $item['end-date'] : '',
'relation' => 'OR',
)
],
);
break;
}
case 'author': {
$new_filters[] = array(
'type' => 'post_author',
'id' => 'post_author',
'title' => 'Author',
'items' => [
array(
'condition' => 'in',
'values' => $item['values'],
'relation' => 'OR',
)
],
);
break;
}
case 'category': {
$new_filters[] = array(
'type' => 'post_category',
'id' => 'post_category',
'title' => 'Category',
'items' => [
array(
'condition' => 'in',
'values' => $item['values'],
'relation' => 'OR',
)
],
);
break;
}
default: {
break;
}
}
} else {
$new_filters[] = $item;
}
}
}
return $new_filters;
}
/**
* Static callback for posts_where filter to allow removal with remove_filter.
*
* @param string $where The WHERE clause.
* @return string Modified WHERE clause.
*/
public static function posts_where_filter_callback($where)
{
global $wpdb;
$params = self::$posts_where_filter_params;
if (empty($params)) {
return $where;
}
$query = $params['query'];
$reference_where_sql = $params['reference_where_sql'];
$post_parent = $params['post_parent'];
$search = esc_sql($wpdb->esc_like($query));
$where .= $wpdb->prepare(
" OR (
({$wpdb->posts}.post_title LIKE %s OR {$wpdb->posts}.post_content LIKE %s)
AND {$wpdb->posts}.post_parent = %d
)",
"%{$search}%",
"%{$search}%",
$post_parent
);
if (!empty($reference_where_sql)) {
$where .= " {$reference_where_sql}";
}
return $where;
}
public static function get_kirki_cms_inherit_post_filters( $filters, $related_post_parent, $post_parent ) {
global $wpdb;
if ( empty( $related_post_parent ) ) {
return $filters;
}
$related_post_parent = (int) $related_post_parent;
$related_post_parent_obj = get_post($related_post_parent);
if($related_post_parent_obj && str_contains( $related_post_parent_obj->post_type, 'kirki_cm_' )){
$related_fields = ContentManagerHelper::get_post_type_custom_field_keys( $post_parent );
if ( empty( $related_fields ) || ! is_array( $related_fields ) ) {
return $filters;
}
if ( ! is_array( $filters ) ) {
$filters = [];
}
foreach ( $related_fields as $field ) {
if ( ! isset( $field['type'] ) || ! in_array( $field['type'], [ 'multi-reference', 'reference' ], true ) ) {
continue;
}
$field_id = $field['id'] ?? null;
if ( ! $field_id ) {
continue;
}
$meta_key = ContentManagerHelper::get_child_post_meta_key_using_field_id( $post_parent, $field_id );
$has_references = $wpdb->get_var(
$wpdb->prepare(
"SELECT COUNT(*) FROM {$wpdb->prefix}kirki_cm_reference WHERE field_meta_key = %s AND ref_post_id = %d",
$meta_key,
$related_post_parent
)
);
if ( empty( $has_references ) ) {
continue;
}
$filter_exists = false;
$filter_index = null;
foreach ( $filters as $index => $existing_filter ) {
if ( isset( $existing_filter['id'] ) && $existing_filter['id'] === $field_id ) {
$filter_exists = true;
$filter_index = $index;
break;
}
}
if ( ! $filter_exists ) {
$filters[] = [
'type' => $field['type'],
'id' => $field_id,
'title' => $field['label'] ?? $field_id,
'items' => [],
];
$filter_index = count( $filters ) - 1;
}
if ( ! isset( $filters[ $filter_index ]['items'] ) || ! is_array( $filters[ $filter_index ]['items'] ) ) {
$filters[ $filter_index ]['items'] = [];
}
$new_item = [
'condition' => 'in',
'value' => $related_post_parent,
'relation' => 'OR',
];
$item_exists = false;
foreach ( $filters[ $filter_index ]['items'] as $item ) {
if (
isset( $item['condition'], $item['value'], $item['relation'] ) &&
$item['condition'] === $new_item['condition'] &&
(int) $item['value'] === $new_item['value'] &&
$item['relation'] === $new_item['relation']
) {
$item_exists = true;
break;
}
}
if ( ! $item_exists ) {
$filters[ $filter_index ]['items'][] = $new_item;
}
}
}
return $filters;
}
/**
* Get dynamic collection data
*
* @param object $params query object.
*
* @return array post array
*/
public static function get_posts($params)
{
$name = isset($params['name']) ? $params['name'] : null;
$sorting = isset($params['sorting']) ? $params['sorting'] : null;
$filters = isset($params['filters']) ? $params['filters'] : null;
$inherit = (bool) ($params['inherit'] ?? false);
$related = (bool) ($params['related'] ?? false);
$post_parent = (int) ($params['post_parent'] ?? 0);
$post_status = isset($params['post_status']) ? $params['post_status'] : 'publish';
$query = isset($params['q']) ? $params['q'] : '';
$IDs = isset($params['IDs']) ? $params['IDs'] : [];
$related_post_parent = isset($params['related_post_parent']) ? $params['related_post_parent'] : self::get_post_id_if_possible_from_url();
// add new
$current_page = isset($params['current_page']) ? $params['current_page'] : 1;
$item_per_page = isset($params['item_per_page']) ? $params['item_per_page'] : 3;
$offset = isset($params['offset']) ? $params['offset'] : 0;
$context = isset($params['context']) ? $params['context'] : null;
$tax_query = [
'relation' => 'AND',
];
// Calculate the offset
$offset = ($current_page - 1) * $item_per_page + $offset;
$args = array(
'posts_per_page' => $item_per_page,
'paged' => $current_page,
'offset' => $offset,
'post_type' => $name,
'suppress_filters' => true,
'post_status' => $post_status,
's' => $query,
);
if (!empty($query)) {
self::search_posts_by_query($name, $query, $post_parent, $args);
} else {
remove_filter('posts_where', [HelperFunctions::class, 'posts_where_filter_callback']);
}
$filters = self::handle_legacy_filter_to_new_filter($filters);
if($inherit && $related_post_parent && str_contains( $name, 'kirki_cm_' )){
$filters = self::get_kirki_cms_inherit_post_filters($filters, $related_post_parent, $post_parent);
}
$added_filters = array();
/**
* Combine search and filters with AND logic
*
* When both search query and filters are present, we need to ensure they work together:
* - Search creates meta_query with 'OR' relation (matches any custom field)
* - Filters add additional conditions
* - Final structure: AND(search_conditions, filter_conditions)
*
* This makes filters compulsory when searching, narrowing results further.
*/
$search_meta_query = isset($args['meta_query']) ? $args['meta_query'] : null;
$has_search = !empty($query) && $search_meta_query !== null;
$has_filters = !empty($filters) && is_array($filters);
// Reset meta_query if both search and filters exist to rebuild with AND relation
if ($has_search && $has_filters) {
$args['meta_query'] = [
'relation' => 'AND',
$search_meta_query, // Search conditions (with OR relation internally)
];
}
if (isset($filters) && is_array($filters)) {
foreach ($filters as $filter_item) {
if (isset($filter_item['parent']) && $filter_item['parent']) {
$filter_item['id'] = 'term';
}
$field_name = isset($filter_item['id']) ? $filter_item['id'] : '';
if (!$field_name) {
continue;
}
if (self::attribute_in_post_table($filter_item['id']) && is_array($filter_item['items'])) {
switch ($field_name) {
case 'post_excerpt':
case 'post_content':
case 'post_title': {
$callback = self::post_table_filter_query($filter_item, 'text');
if ($callback) {
$added_filters[] = $callback;
}
break;
}
case 'post_date':
case 'post_date_gmt': {
/**
* $filter_item['items'] max contain one array.
* in array may contain start-date, end-date
* Like: [{"start-date": "2020-01-01","end-date": "2020-01-02"}]
*/
if (isset($filter_item['items'], $filter_item['items'][0])) {
$items = $filter_item['items'];
$item = $items[0]; // Get first item in array.
$date_query = array('column' => $field_name);
$date_query['inclusive'] = true;
if (!empty($item['start-date'])) {
$date_query['after'] = $item['start-date'];
}
if (!empty($item['end-date'])) {
$date_query['before'] = $item['end-date'];
}
$args['date_query'] = $date_query;
}
break;
}
case 'post_author': {
/**
* $filter_item['items'] must not contain more than 2 array of conditions.
* 1 array may contain 'in' conditions and another for 'not-in' conditions
* And values of 'in' and 'not-in' conditions should not collide
* Like: the condition should not be author 'in' [1, 2, 3] and 'not-in' [2, 4, 5]
*/
$items = $filter_item['items'];
foreach ($items as $item) {
if (isset($item['condition'], $item['values']) && is_array($item['values'])) {
if ($item['condition'] === 'in') {
$args['author__in'] = $item['values'];
}
if ($item['condition'] === 'not-in') {
$args['author__not_in'] = $item['values'];
}
}
}
break;
}
case 'term': {
$items = $filter_item['items'];
foreach ($items as $item) {
if (isset($item['condition'], $item['values']) && is_array($item['values'])) {
if ($item['condition'] === 'in' && !empty($item['values'])) {
array_push($tax_query, [
'taxonomy' => $filter_item['type'],
'field' => 'term_id',
'terms' => $item['values'],
'operator' => 'IN',
]);
}
if ($item['condition'] === 'not-in' && !empty($item['values'])) {
array_push($tax_query, [
'taxonomy' => $filter_item['type'],
'field' => 'term_id',
'terms' => $item['values'],
'operator' => 'NOT IN',
]);
}
}
}
break;
}
}
} else {
$key = ContentManagerHelper::get_child_post_meta_key_using_field_id($post_parent, $field_name);
$data_type = $filter_item['type'] ?? 'text';
if (!isset($args['meta_query'])) {
$args['meta_query'] = array();
} elseif (!is_array($args['meta_query'])) {
$args['meta_query'] = array();
}
// Ensure meta_query has proper structure when combining search + filters
if ($has_search && !isset($args['meta_query']['relation'])) {
$args['meta_query']['relation'] = 'AND';
}
switch ($data_type) {
default:
case 'rich_text':
case 'text':
case 'phone':
case 'url':
case 'email': {
$args['meta_query'][] = self::post_meta_table_filter_query($filter_item, $key, 'text');
break;
}
case 'date': {
$args['meta_query'][] = self::post_meta_table_filter_query($filter_item, $key, 'date');
break;
}
case 'number': {
$args['meta_query'][] = self::post_meta_table_filter_query($filter_item, $key, 'number');
break;
}
case 'option': {
$args['meta_query'][] = self::post_meta_table_filter_query($filter_item, $key, 'option');
break;
}
case 'switch': {
$args['meta_query'][] = self::post_meta_table_filter_query($filter_item, $key, 'switch');
break;
}
case 'taxonomy': {
if (empty($args['tax_query'])) {
$tax_query = array(
'relation' => 'AND'
);
}
if (
isset($filter_item['taxonomy'], $filter_item['terms']) &&
is_array($filter_item['terms'])
) {
$operators = array('NOT IN', 'IN');
$operator = 'IN';
if (isset($filter_item['operator']) && in_array($filter_item['operator'], $operators, true)) {
$operator = $filter_item['operator'];
}
array_push($tax_query, [
'taxonomy' => $filter_item['taxonomy'],
'field' => 'term_id', // So far this is fixed
'terms' => $filter_item['terms'],
'operator' => $operator,
]);
}
break;
}
case 'author': {
if (isset($filter_item['condition'], $filter_item['values']) && is_array($filter_item['values'])) {
if ($filter_item['condition'] === 'is-equal') {
$args['author__in'] = $filter_item['values'];
}
if ($filter_item['condition'] === 'is-not-equal') {
$args['author__not_in'] = $filter_item['values'];
}
}
break;
}
case 'multi-reference':
case 'reference': {
$args = self::cm_reference_table_filter_query($filter_item, $key, $args);
break;
}
}
}
}
}
if (count($IDs) > 0) {
$args['post__in'] = $IDs;
unset($args['post_parent']);
$args['post_type'] = 'any';
$inherit = false;
$post_parent = false;
}
if (count($tax_query) > 1) {
$args['tax_query'] = $tax_query;
}
// Set default orderby and order if not explicitly specified
$order = 'DESC';
$orderby = 'date';
if (isset($sorting) && is_array($sorting) && !empty($sorting)) {
if (!empty($sorting['order'])) {
$order = $sorting['order'];
} elseif (!empty($sorting['type'])) {
$order = $sorting['type'];
}
if (!empty($sorting['orderby'])) {
$orderby = $sorting['orderby'];
} elseif (!empty($sorting['value'])) {
$orderby = $sorting['value'];
}
}
$args['order'] = $order;
if ('none' !== $orderby) {
if (isset($name) && str_contains($name, KIRKI_CONTENT_MANAGER_PREFIX) && !in_array($orderby, KIRKI_WORDPRESS_SORT_BY_OPTIONS, true)) {
$args['orderby'] = 'meta_value'; // Use 'meta_value' or 'meta_value_num' as needed
$args['meta_key'] = ContentManagerHelper::get_child_post_meta_key_using_field_id($post_parent, $orderby);
} elseif ('date' === $orderby) {
$args['orderby'] = array('date' => $order, 'ID' => $order);
} else {
$args['orderby'] = $orderby;
}
}
if ($inherit || $post_parent) {
//TODO: if terms page then show terms post only. like tag, category.
$args['post_parent'] = $post_parent;
}
if (!empty($context) && $inherit && isset( $args['post_type']) && !str_contains( $args['post_type'], 'kirki_cm') ) {
if ($context['collectionType'] == 'user') {
$args['author'] = $context['id'];
unset($args['post_parent']);
}
if ($context['collectionType'] == 'term') {
$args['tax_query'] = array(
array(
'taxonomy' => $context['taxonomy'], // Replace 'category' with your taxonomy
'field' => 'term_id', // Use 'slug' if you want to query by slug
'terms' => $context['id'], // Replace 123 with your term ID
)
);
unset($args['post_parent']);
}
}
if ($related) {
$post = get_post($related_post_parent);
if ($post) {
$args['post_type'] = $post->post_type;
if (str_contains($post->post_type, 'kirki_cm_')) {
// filter related posts for content manager post
$referenced_post_ids = self::get_referenced_post_ids($post_parent, $post);
$args['post__in'] = array_map('intval', $referenced_post_ids);
} else {
$args['tax_query'] = self::buildTaxonomyForRelatedPosts($post);
$args['post__not_in'] = [$post->ID];
}
}
}
// Disable suppress_filters when post_table text filters (post_title, post_content, post_excerpt)
// are present, since they rely on posts_where hooks to modify the SQL query.
if (!empty($added_filters)) {
$args['suppress_filters'] = false;
}
// Run the WP_Query
$query = new WP_Query($args);
foreach ($added_filters as $callback) {
remove_filter('posts_where', $callback);
}
$posts = $query->posts;
$custom_logo_id = get_theme_mod('custom_logo');
$image = wp_get_attachment_image_src($custom_logo_id, 'full');
$kirki_content_manager_post_type_fields = array();
if (isset($args['post_type']) && KIRKI_CONTENT_MANAGER_PREFIX === $args['post_type']) {
$post_parent = $args['post_parent'];
$kirki_content_manager_post_type_fields = ContentManagerHelper::get_post_type_custom_field_keys($post_parent);
}
foreach ($posts as $key => &$post) {
if (is_null($post)) {
unset($posts[$key]);
continue;
}
if (
KIRKI_CONTENT_MANAGER_PREFIX === $post->post_type && is_array($kirki_content_manager_post_type_fields)
) {
foreach ($kirki_content_manager_post_type_fields as $field_key) {
$meta_key = ContentManagerHelper::get_child_post_meta_key_using_field_id($post->post_parent, $field_key['id']);
$post->{$field_key['id']} = get_post_meta($post->ID, $meta_key, true);
if (
isset($field_key['type']) &&
$field_key['type'] === 'image' &&
$post->{$field_key['id']}
) {
$post->{$field_key['id']} = array(
'wp_attachment_id' => $post->{$field_key['id']}['id'],
'src' => $post->{$field_key['id']}['url'],
);
}
}
}
$post->post_id = $post->ID;
$post->author_profile_picture = array(
'src' => get_avatar_url($post->post_author)
);
$post->post_author = get_the_author_meta('display_name', $post->post_author);
$post->post_time = get_the_time('', $post->ID);
$post->featured_image = array(
'wp_attachment_id' => get_post_thumbnail_id($post->ID),
'src' => get_the_post_thumbnail_url($post->ID)
);
$post->site_logo = isset($image[0]) ? $image[0] : '';
$post->post_page_link = \get_permalink($post->ID);
$post->author_posts_page_link = \get_author_posts_url($post->post_author);
unset($post->post_excerpt);
}
;
// Get total posts and total pages for pagination
$total_posts = $query->found_posts;
$total_posts_updated = max(0, $total_posts - $offset);
$total_pages = ceil($total_posts_updated / $item_per_page);
// Calculate previous and next page numbers
$prev_page = ($current_page > 1) ? $current_page - 1 : null;
$next_page = ($current_page < $total_pages) ? $current_page + 1 : null;
// Return the query and pagination info
return array(
'data' => $posts,
'pagination' => array(
'per_page' => $item_per_page,
'current_page' => $current_page,
'total_pages' => $total_pages,
'total_count' => $total_posts,
'previous' => $prev_page,
'next' => $next_page,
),
);
}
public static function search_posts_by_query($name, $query, $post_parent, &$args)
{
global $wpdb;
if (!str_contains($name, 'kirki_cm_')) {
return;
}
$all_custom_fields = ContentManagerHelper::get_post_type_custom_field_keys($post_parent);
$meta_query_args = ['relation' => 'OR'];
$reference_where_sql = '';
foreach ($all_custom_fields as $data) {
if (!$data)
continue;
$meta_key = ContentManagerHelper::get_child_post_meta_key_using_field_id($post_parent, $data['id']);
if (in_array($data['type'], ['text'], true)) {
$meta_query_args[] = [
'key' => $meta_key,
'value' => $query,
'compare' => 'LIKE',
];
}
if (in_array($data['type'], ['reference'], true)) {
$matched_post_ids = self::get_matched_post_ids_recursive($data['ref_collection'], $query);
if (!empty($matched_post_ids)) {
$ids = implode(',', array_map('intval', $matched_post_ids));
$reference_where_sql .= $wpdb->prepare(
" OR {$wpdb->posts}.ID IN (
SELECT post_id
FROM {$wpdb->prefix}kirki_cm_reference
WHERE field_meta_key = %s
AND ref_post_id IN ($ids)
)",
$meta_key
);
}
}
}
if (count($meta_query_args) > 1) {
unset($args['s']);
$args['meta_query'] = $meta_query_args;
}
// Store filter parameters for the callback
self::$posts_where_filter_params = [
'query' => $query,
'reference_where_sql' => $reference_where_sql,
'post_parent' => $post_parent,
];
add_filter('posts_where', [__CLASS__, 'posts_where_filter_callback']);
}
public static function get_matched_post_ids_recursive($post_parent, $query, $depth = 0, $max_depth = 5)
{
global $wpdb;
if ($depth > $max_depth) {
return [];
}
$post_type = 'kirki_cm_' . $post_parent;
$matched_post_ids = $wpdb->get_col(
$wpdb->prepare(
"SELECT ID FROM {$wpdb->posts}
WHERE post_title LIKE %s
AND post_status = 'publish'
AND post_type = %s",
'%' . $wpdb->esc_like($query) . '%',
$post_type
)
);
$ref_custom_fields = ContentManagerHelper::get_post_type_custom_field_keys($post_parent);
$meta_conditions = [];
foreach ($ref_custom_fields as $ref_field) {
if (!$ref_field)
continue;
if (in_array($ref_field['type'], ['text'], true)) {
$ref_meta_key = ContentManagerHelper::get_child_post_meta_key_using_field_id($post_parent, $ref_field['id']);
$meta_conditions[] = $wpdb->prepare(
"(meta_key = %s AND meta_value LIKE %s)",
$ref_meta_key,
"%{$search}%"
);
}
}
if (!empty($meta_conditions)) {
$where_meta = implode(' OR ', $meta_conditions);
$meta_post_ids = $wpdb->get_col("SELECT DISTINCT post_id FROM {$wpdb->postmeta} WHERE {$where_meta}"); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$matched_post_ids = array_merge($matched_post_ids, $meta_post_ids);
}
foreach ($ref_custom_fields as $ref_field) {
if (!$ref_field || !in_array($ref_field['type'], ['reference'], true)) {
continue;
}
$ref_post_parent = $ref_field['ref_collection'];
$nested_matched_ids = self::get_matched_post_ids_recursive($ref_post_parent, $query, $depth + 1, $max_depth);
if (!empty($nested_matched_ids)) {
$meta_key = ContentManagerHelper::get_child_post_meta_key_using_field_id($post_parent, $ref_field['id']);
$ids = implode(',', array_map('intval', $nested_matched_ids));
$ref_post_ids = $wpdb->get_col($wpdb->prepare("SELECT post_id FROM {$wpdb->prefix}kirki_cm_reference WHERE field_meta_key = %s AND ref_post_id IN ($ids)", $meta_key)); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared
$matched_post_ids = array_merge($matched_post_ids, $ref_post_ids);
}
}
return array_unique(array_map('intval', $matched_post_ids));
}
public static function get_referenced_post_ids($post_parent, $post)
{
global $wpdb;
$allData = ContentManagerHelper::get_post_type_custom_field_keys($post_parent);
$post_ids = [];
foreach ($allData as $data) {
if ($data && in_array($data['type'], ['reference', 'multi-reference'], true)) {
$meta_key = 'kirki_cm_field_' . $post_parent . '_' . $data['id'];
$results = $wpdb->get_results(
$wpdb->prepare(
"SELECT ref_post_id FROM {$wpdb->prefix}kirki_cm_reference WHERE field_meta_key = %s AND post_id = %d",
$meta_key,
$post->ID
),
ARRAY_A
);
foreach ($results as $id) {
$related_posts = $wpdb->get_results(
$wpdb->prepare(
"SELECT post_id FROM {$wpdb->prefix}kirki_cm_reference WHERE field_meta_key = %s AND ref_post_id = %d",
$meta_key,
(int) $id['ref_post_id']
),
ARRAY_A
);
foreach ($related_posts as $related) {
$related_id = (int) $related['post_id'];
if ($related_id !== (int) $post->ID) {
$post_ids[] = $related_id;
}
}
}
}
}
$post_ids = array_values(array_unique($post_ids));
return !empty($post_ids) ? $post_ids : [0];
}
public static function get_terms($params)
{
$terms_array = [];
$current_page = isset($params['current_page']) ? (int) $params['current_page'] : 1;
$item_per_page = isset($params['item_per_page']) ? (int) $params['item_per_page'] : 3;
$offset = isset($params['offset']) ? (int) $params['offset'] : 0;
if (!empty($params['inherit'])) {
$terms_array = get_the_terms($params['post_parent'], $params['taxonomy']);
if (is_array($terms_array)) {
// Convert WP_Term objects to arrays only if needed
$terms_array = array_map(function ($term) {
return is_object($term) && method_exists($term, 'to_array')
? $term->to_array()
: (array) $term;
}, $terms_array);
$calculated_offset = (($current_page - 1) * $item_per_page) + $offset;
$terms_array = array_slice($terms_array, $calculated_offset, $item_per_page);
} else {
$terms_array = [];
}
} else {
$params['offset'] = (($current_page - 1) * $item_per_page) + $offset;
$params['number'] = $item_per_page;
$terms_array = get_terms($params);
if (is_array($terms_array)) {
foreach ($terms_array as &$item) {
if (is_object($item) && method_exists($item, 'to_array')) {
$item = $item->to_array();
} elseif (is_object($item)) {
$item = (array) $item;
}
}
} else {
$terms_array = [];
}
}
// Count total terms
$total_terms = 0;
if (!empty($params['inherit'])) {
$t = get_the_terms($params['post_parent'], $params['taxonomy']);
if (is_array($t)) {
$total_terms = count($t);
} else {
$total_terms = wp_count_terms(['taxonomy' => $params['taxonomy']]);
}
} else {
$total_terms = wp_count_terms(['taxonomy' => $params['taxonomy']]);
}
$total_terms = is_numeric($total_terms) ? (int) $total_terms : 0;
$total_pages = ($item_per_page > 0) ? ceil($total_terms / $item_per_page) : 1;
$prev_page = ($current_page > 1) ? $current_page - 1 : null;
$next_page = ($current_page < $total_pages) ? $current_page + 1 : null;
return [
'data' => $terms_array,
'pagination' => [
'per_page' => $item_per_page,
'current_page' => $current_page,
'total_pages' => $total_pages,
'total_count' => $total_terms,
'previous' => $prev_page,
'next' => $next_page,
],
];
}
public static function buildTaxonomyForRelatedPosts(\WP_Post $post)
{
$taxonomies = get_object_taxonomies($post->post_type);
$taxQuery = [
'relation' => 'OR',
];
foreach ($taxonomies as $taxonomy) {
$taxQuery[] = [
'taxonomy' => $taxonomy,
'field' => 'slug',
'terms' => array_filter(wp_get_object_terms($post->ID, $taxonomy, ['fields' => 'slugs']), function ($termSlug) {
return strtolower($termSlug) !== 'uncategorized';
}),
];
}
return $taxQuery;
}
/**
* Get dynamic collectiond data
*
* @param object $params query object.
*
* @return array post array
*/
public static function get_comments($params)
{
$parent = (int) ($params['parent'] ?? 0);
$post_id = (int) ($params['post_id'] ?? 0);
$type = ($params['type'] ?? 'comment');
$sorting = isset($params['sorting']) ? $params['sorting'] : null;
$filters = isset($params['filters']) ? $params['filters'] : null;
// add new
$current_page = isset($params['current_page']) ? $params['current_page'] : 1;
$item_per_page = isset($params['item_per_page']) ? $params['item_per_page'] : 3;
$offset = isset($params['offset']) ? $params['offset'] : 0;
// Calculate the offset
$offset_cal = ($current_page - 1) * $item_per_page + $offset;
$args = array(
'parent' => $parent,
'post_id' => $post_id,
'type' => $type,
'status' => 'approve',
'number' => $item_per_page,
'paged' => $current_page,
'offset' => $offset_cal,
'count' => false
);
if (isset($filters) && is_array($filters)) {
foreach ($filters as $filter_item) {
$field_name = isset($filter_item['id']) ? $filter_item['id'] : '';
if (!$field_name) {
continue;
}
switch ($field_name) {
case 'comment_date':
case 'comment_date_gmt': {
/**
* $filter_item['items'] max contain one array.
* in array may contain start-date, end-date
* Like: [{"start-date": "2020-01-01","end-date": "2020-01-02"}]
*/
if (isset($filter_item['items'], $filter_item['items'][0])) {
$items = $filter_item['items'];
$item = $items[0]; // Get first item in array.
$date_query = array('column' => $field_name);
$date_query['inclusive'] = true;
if (!empty($item['start-date'])) {
$date_query['after'] = $item['start-date'];
}
if (!empty($item['end-date'])) {
$date_query['before'] = $item['end-date'];
}
$args['date_query'] = $date_query;
}
break;
}
case 'comment_author': {
$items = $filter_item['items']; // $items['items'] max contain one array.
foreach ($items as $item) {
if (isset($item['condition'], $item['values']) && is_array($item['values'])) {
if ($item['condition'] === 'in') {
$args['author__in'] = $item['values'];
}
if ($item['condition'] === 'not-in') {
$args['author__not_in'] = $item['values'];
}
}
}
break;
}
case 'comment_approved': {
$items = $filter_item['items']; // $items['items'] max contain one array.
foreach ($items as $item) {
if (isset($item['condition'], $item['values']) && is_array($item['values'])) {
if ($item['condition'] === 'in') {
$args['status'] = $item['values'];
}
}
}
}
}
}
}
if (isset($sorting)) {
// Set the sort order (ASC/DESC)
if (isset($sorting['order'])) {
$args['order'] = $sorting['order'];
}
if (isset($sorting['orderby']) && !empty($sorting['orderby'])) {
$args['orderby'] = $sorting['orderby'];
}
}
$comments = get_comments($args);
unset($args['number']);
unset($args['paged']);
if (is_array($comments)) {
foreach ($comments as &$comment) {
$comment = (object) (array) $comment;
$author_posts_page_link = $comment->comment_author_url;
if (!$author_posts_page_link) {
$author_posts_page_link = \get_author_posts_url($comment->user_id);
}
$comment->author_profile_picture = array(
'src' => get_avatar_url($comment->user_id)
);
$comment->author_posts_page_link = $author_posts_page_link;
}
}
// Get total comments count
$total_comments = get_comments(array_merge($args, array('count' => true)));
$total_comments = $total_comments - $offset;
// Calculate total pages
$total_pages = ceil($total_comments / $item_per_page);
// Calculate previous and next pages
$prev_page = ($current_page > 1) ? $current_page - 1 : null;
$next_page = ($current_page < $total_pages) ? $current_page + 1 : null;
// return $comments;
return array(
'data' => $comments, // Raw comments data
'pagination' => array(
'per_page' => $item_per_page,
'current_page' => $current_page,
'total_pages' => $total_pages,
'total_count' => $total_comments,
'previous' => $prev_page,
'next' => $next_page,
),
);
}
/**
* Remove all default assets
*
* @return void
*/
public static function remove_wp_assets()
{
/*
// Remove all WordPress actions
// remove_all_actions('wp_head');
// remove_all_actions('wp_print_styles');
// remove_all_actions('wp_print_head_scripts');
// remove_all_actions('wp_footer');
// // Handle `wp_head`
// add_action('wp_head', 'wp_enqueue_scripts', 1);
// add_action('wp_head', 'wp_print_styles', 8);
// add_action('wp_head', 'wp_print_head_scripts', 9);
// add_action('wp_head', 'wp_site_icon');
// // Handle `wp_footer`
// add_action('wp_footer', 'wp_print_footer_scripts', 20);
// // Handle `wp_enqueue_scripts`
// remove_all_actions('wp_enqueue_scripts');
// // Also remove all scripts hooked into after_wp_tiny_mce.
// remove_all_actions('after_wp_tiny_mce');
*/
// remove admin-bar.
add_filter('show_admin_bar', '__return_false', PHP_INT_MAX);
}
/**
* Get server protocol
* currently not in use
*
* @return string protocol name.
*/
public static function get_protocol()
{
$protocol = isset($_SERVER['HTTPS']) ? 'https' : 'http';
return $protocol;
}
/**
* Check if the current user has specific role ($role)
*
* @param string $role The role to check.
* @return boolean
*/
public static function user_is($role)
{
$user = wp_get_current_user();
$roles = $user->roles;
return is_array($roles) && count($roles) && in_array($role, $roles, true) ? true : false;
}
/**
* Check if the user has access to edit/create specific/all post
*
* @param int $post_id post id.
* @return boolean
*
* @deprecated
* @see Kirki\App\Wordpress\User::has_edit_access()
*/
public static function user_has_post_edit_access()
{
return self::has_access(
array(
KIRKI_ACCESS_LEVELS['FULL_ACCESS'],
KIRKI_ACCESS_LEVELS['EDITOR_ACCESS'],
KIRKI_ACCESS_LEVELS['CONTENT_ACCESS'],
)
);
}
/**
* Check if the user has access to editor
*
* @return boolean
*/
public static function user_has_editor_access()
{
if (isset($_GET['editor-preview-token'])) {
//phpcs:ignore WordPress.Security.NonceVerification.Missing,WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.MissingUnslash,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$editor_preview_token = self::sanitize_text(isset($_GET['editor-preview-token']) ? $_GET['editor-preview-token'] : '');
$is_valid_token = self::is_post_editor_preview_token_valid($editor_preview_token);
// Token rides in the URL for this one entry request (a clicked link
// can't set headers) — stop it leaking onward via the Referer header
// on any request this page makes to third-party resources.
if ($is_valid_token && !headers_sent()) {
header('Referrer-Policy: no-referrer', false);
}
return $is_valid_token;
}
return self::has_access(
array(
KIRKI_ACCESS_LEVELS['FULL_ACCESS'],
KIRKI_ACCESS_LEVELS['EDITOR_ACCESS'],
KIRKI_ACCESS_LEVELS['CONTENT_ACCESS'],
KIRKI_ACCESS_LEVELS['VIEW_ACCESS'],
)
);
}
public static function getallheaders()
{
$headers = [];
foreach ($_SERVER as $name => $value) {
if (strpos($name, 'HTTP_') === 0) {
$key = substr($name, 5);
} elseif (in_array($name, ['CONTENT_TYPE', 'CONTENT_LENGTH', 'CONTENT_MD5'])) {
$key = $name;
} else {
continue;
}
// Convert HEADER_NAME → Header-Name
$key = str_replace('_', ' ', strtolower($key));
$key = ucwords($key);
$key = str_replace(' ', '-', $key);
$headers[$key] = $value;
}
return $headers;
}
/**
* Check if the request is from the editor preview.
*
* @deprecated Use Kirki\App\Supports\EditorPreview::has_valid_token
* @see \Kirki\App\Supports\EditorPreview::has_valid_token()
* @return bool
*/
public static function is_api_call_from_editor_preview()
{
// Check the Editor-Preview-Token header
$headers = self::getallheaders();
$editor_preview_token = isset($headers['Editor-Preview-Token']) ? $headers['Editor-Preview-Token'] : null;
if ($editor_preview_token && HelperFunctions::is_post_editor_preview_token_valid($editor_preview_token)) {
return true;
}
return false;
}
/**
* Check if the Editor-Preview-Token header is valid
*
* @deprecated Use Kirki\App\Supports\EditorPreview::has_valid_token
* @see Kirki\App\Supports\EditorPreview::has_valid_token()
* @return bool
*/
public static function is_api_header_post_editor_preview_token_valid()
{
// Check the Editor-Preview-Token header
$headers = self::getallheaders();
$editor_preview_token = isset($headers['Editor-Preview-Token']) ? $headers['Editor-Preview-Token'] : null;
if (HelperFunctions::is_post_editor_preview_token_valid($editor_preview_token)) {
return true;
}
return false;
}
/**
* Check if the Editor-Preview-Token header is valid
*
* @deprecated Use Kirki\App\Supports\EditorPreview::has_valid_token
* @see Kirki\App\Supports\EditorPreview::has_valid_token()
* @return bool
*/
public static function is_post_editor_preview_token_valid($token)
{
$status = HelperFunctions::get_global_data_using_key('kirki_editor_read_only_access_status');
if ($status) {
$kirki_editor_read_only_access_token = HelperFunctions::get_global_data_using_key('kirki_editor_read_only_access_token');
if ($kirki_editor_read_only_access_token && hash_equals((string) $kirki_editor_read_only_access_token, (string) $token)) {
return true;
}
}
return false;
}
/**
* Check if the current user has specific access
*
* @deprecated Use Kirki\App\Wordpress\User::has_access
* @see Kirki\App\Wordpress\User
* @param string|string[] $access_level The access level to check access.
*
*/
public static function has_access($access_level)
{
if (!function_exists('wp_get_current_user')) {
return false;
}
$user = wp_get_current_user();
if (!$user || !$user->exists()) {
return false;
}
// Resolve via the role map directly — the container-bound User object
// isn't guaranteed to be registered when this runs early (plugins_loaded).
$role_levels = array_values(Role::get_access_levels_by_roles((array) $user->roles));
$required = is_array($access_level) ? $access_level : array($access_level);
return (bool) array_intersect($required, $role_levels);
}
/**
* Safely unserialize imported data.
*
* Imported template meta originates from attacker-controlled JSON inside an
* uploaded ZIP. A JSON string may itself be a serialized PHP object, which
* must never be rehydrated (PHP Object Injection, CWE-502).
*
* @param mixed $value Raw meta value.
* @return mixed Decoded value, or null when the payload carried an object.
*/
public static function safe_unserialize($value)
{
if (!is_string($value) || !is_serialized($value)) {
return $value;
}
$data = @unserialize(trim($value), array('allowed_classes' => false));
return self::contains_object($data) ? null : $data;
}
/**
* Recursively test whether a value contains any object.
* Catches __PHP_Incomplete_Class produced by allowed_classes => false.
*
* @param mixed $data Value to inspect.
* @return boolean
*/
public static function contains_object($data)
{
if (is_object($data)) {
return true;
}
if (is_array($data)) {
foreach ($data as $item) {
if (self::contains_object($item)) {
return true;
}
}
}
return false;
}
/**
* Check if the current user is a WordPress administrator.
* Admin-only features (settings, license, forms, import/export) use this.
*
* @return boolean
*/
public static function user_is_admin()
{
return self::user_is('administrator');
}
/**
* Check if the user has builder power access (full or editor level) —
* page CRUD, symbols, fonts, etc. Everything except site-admin features.
*
* @return boolean
*/
public static function user_has_builder_access()
{
return self::has_access(
array(
KIRKI_ACCESS_LEVELS['FULL_ACCESS'],
KIRKI_ACCESS_LEVELS['EDITOR_ACCESS'],
)
);
}
/**
* This method will collect license info from kirki.com
*
* @param string $license_key user license key.
* @return array license info.
*/
public static function get_my_license_info($license_key)
{
//phpcs:ignore WordPress.Security.NonceVerification.Missing,WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.MissingUnslash,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$info = self::http_get(KIRKI_CORE_PLUGIN_URL . '/?license_key=' . $license_key . '&host=' . rawurlencode(self::sanitize_text(isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : null)));
$info = json_decode($info, true);
if ($info && isset($info['success'])) {
return $info['data'];
} else {
return array('key' => $license_key);
}
}
/**
* HTTP get
*
* Uses wp_safe_remote_get() so that the request is validated against
* allowed_redirect_hosts at the transport layer, providing a second
* defence in depth beyond the is_safe_url() check callers should
* perform before calling this wrapper.
*
* @param string $url api endpoint url.
* @return string|bool response.
*
* @deprecated
* @see \Kirki\Framework\Supports\Facades\Http::get()
*/
public static function http_get($url, $args = array())
{
try {
$response = wp_safe_remote_get($url, $args);
if ((!is_wp_error($response)) && (200 === wp_remote_retrieve_response_code($response))) {
$responseBody = $response['body'];
return $responseBody;
}
return false;
} catch (\Exception $ex) {
return false;
}
}
/**
* HTTP post
*
* Uses wp_safe_remote_post() so that the request is validated against
* allowed_redirect_hosts at the transport layer, providing a second
* defence in depth beyond the is_safe_url() check callers should
* perform before calling this wrapper.
*
* @param string $url api endpoint url.
* @param array $options options.
* @return array|WP_Error response.
*
* @deprecated
* @see \Kirki\Framework\Supports\Facades\Http::post()
*/
public static function http_post($url, $options)
{
$res = wp_safe_remote_post($url, $options);
return $res;
}
/**
* Text domain load hooks
*
* @param string $handle kirki handle.
* @return void
*/
public static function load_script_text_domain($handle)
{
wp_set_script_translations($handle, 'kirki', KIRKI_PLUGIN_PATH . 'languages/');
}
/**
* Delete kirki related meta if a post is deleted.
*
* @param int $post_id post id.
* @return void
*/
public static function delete_post_with_meta_key($post_id)
{
delete_post_meta($post_id, KIRKI_META_NAME_FOR_USED_STYLE_BLOCK_IDS);
delete_post_meta($post_id, KIRKI_META_NAME_FOR_USED_STYLE_BLOCK_IDS . '_random');
delete_post_meta($post_id, 'kirki');
delete_post_meta($post_id, KIRKI_META_NAME_FOR_POST_EDITOR_MODE);
delete_post_meta($post_id, KIRKI_GLOBAL_STYLE_BLOCK_META_KEY);
delete_post_meta($post_id, KIRKI_GLOBAL_STYLE_BLOCK_META_KEY . '_random');
delete_post_meta($post_id, KIRKI_META_NAME_FOR_USED_FONT_LIST);
}
/**
* Get the query string for the media type
*
* @param string $type media type.
* @return string The query string.
* @example HelperFunctions::get_media_type_query_string('image') => 'image/jpeg, image/png, image/gif'
*/
public static function get_media_type_query_string($type)
{
return implode(
', ',
array_map(
function ($v) {
return "'" . $v . "'";
},
KIRKI_SUPPORTED_MEDIA_TYPES[$type]
)
);
}
/**
* This is for component configuration/object javascript variable.
*
* @return string script tag
*/
public static function get_empty_variables()
{
$s = "';
return $s;
}
/**
* Check kirki and kirki pro is active or not
*
* @param string $plugin_main_file plugin main PHP file name.
* @return boolean
*/
public static function is_plugin_activate($plugin_main_file)
{
if (in_array($plugin_main_file, apply_filters('active_plugins', get_option('active_plugins')), true)) {
// plugin is activated.
return true;
}
return false;
}
/**
* This function will verify nonce
* ACT like API calls auth middleware
*
* @param string $action ajax action name.
*
* @return void
*/
public static function verify_nonce($action = -1)
{
//phpcs:ignore WordPress.Security.NonceVerification.Missing,WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.MissingUnslash,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$headers = static::getallheaders();
$header_nonce = isset($headers['X-Wp-Nonce']) ? static::sanitize_text($headers['X-Wp-Nonce']) : '';
$nonce = $header_nonce ? $header_nonce : static::sanitize_text(isset($_GET['_wpnonce']) ? $_GET['_wpnonce'] : '');
if (!wp_verify_nonce($nonce, $action)) {
wp_send_json_error('Not authorized');
exit;
}
}
/**
* Unslash and sanitize text
*
* @param string $v text.
* @return string sanitized text.
*/
public static function sanitize_text($v)
{
return sanitize_text_field(wp_unslash($v));
}
/**
* Get current WordPress session ID.
* This method generates a unique session ID if none exists.
*
* @deprecated
* @see \Kirki\App\Supports\Session::get_session_id()
*
* @return string Session ID.
*/
public static function get_session_id()
{
// First, check if a session ID is already stored in the static variable.
if (self::$global_session_id) {
return self::$global_session_id;
}
// Check if a session ID exists in a cookie.
if (isset($_COOKIE['kirki_session_id'])) {
self::$global_session_id = sanitize_text_field($_COOKIE['kirki_session_id']);
return self::$global_session_id;
}
// Generate a new session ID.
self::$global_session_id = wp_generate_uuid4();
// Set the session ID in a cookie.
setcookie('kirki_session_id', self::$global_session_id, time() + (DAY_IN_SECONDS * 7), COOKIEPATH, COOKIE_DOMAIN, is_ssl(), true);
return self::$global_session_id;
}
/**
* Get session data by key using WordPress transients.
*
* @deprecated
* @see \Kirki\App\Supports\Session::get()
*
* @param string $key The key of the session data to retrieve.
* @return mixed|null The session data if found, null otherwise.
*/
public static function get_session_data($key)
{
// Get the current session ID.
$session_id = self::get_session_id();
// Retrieve the session data.
$session_data = get_transient('kirki_session_' . $session_id);
if (isset($session_data[$key])) {
return $session_data[$key];
}
return null;
}
/**
* Add or update session data using WordPress transients.
*
* @deprecated
* @see \Kirki\App\Supports\Session::put()
*
* @param string $key The key of the session data.
* @param mixed $value The value of the session data.
* @return void
*/
public static function set_session_data($key, $value)
{
// Get the current session ID.
$session_id = self::get_session_id();
// Retrieve existing session data.
$session_data = get_transient('kirki_session_' . $session_id) ?: array();
// Update the session data.
$session_data[$key] = $value;
// Save the updated session data with a 24-hour expiration time.
set_transient('kirki_session_' . $session_id, $session_data, DAY_IN_SECONDS);
}
/**
* Delete session data by key using WordPress transients.
*
* @deprecated
* @see \Kirki\App\Supports\Session::forget()
*
* @param string $key The key of the session data to delete.
* @return void
*/
public static function delete_session_data($key)
{
// Get the current session ID.
$session_id = self::get_session_id();
// Retrieve existing session data.
$session_data = get_transient('kirki_session_' . $session_id);
if (isset($session_data[$key])) {
unset($session_data[$key]);
// Save the updated session data or delete the transient if empty.
if (!empty($session_data)) {
set_transient('kirki_session_' . $session_id, $session_data, DAY_IN_SECONDS);
} else {
delete_transient('kirki_session_' . $session_id);
}
}
}
/**
* Escape a post meta value for safe output.
*
* The front-end content pipeline (TheFrontend::replace_content) applies a
* single html_entity_decode() pass after core has processed shortcodes,
* which would undo a plain esc_html(). Re-encoding the ampersands (with
* double_encode enabled) yields a single-escaped value in the final output
* while still neutralizing markup authored by low-privileged users.
*
* @param mixed $value The raw post meta value.
* @return string Escaped value.
*/
public static function escape_post_meta_value($value)
{
if (!is_scalar($value)) {
return '';
}
return htmlspecialchars(esc_html((string) $value), ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8', true);
}
/**
* Is Pro user checking function.
*
* @return bool
*/
public static function is_pro_user()
{
$common_data = WpAdmin::get_common_data(true);
$bool = isset($common_data['license_key']['valid']) && boolval($common_data['license_key']['valid']) === true;
return $bool;
}
/**
* Get all view port lists
*
* @return string viewports list variable in script markup.
*/
public static function get_view_port_lists()
{
$s = '';
$list = UserData::get_view_port_list();
if ($list) {
$s .= "';
}
return $s;
}
/**
* Get all css variables
*
* @return string variables in script markup.
*/
public static function get_kirki_css_variables_data()
{
$s = '';
$variableData = UserData::get_kirki_variable_data();
if ($variableData) {
$s .= "';
}
return $s;
}
/**
* Get smooth scroll script
*
* @return string script markup.
*/
public static function get_smooth_scroll_script()
{
$common_data = WpAdmin::get_common_data(true);
$smooth_scroll_enabled = isset($common_data['smooth_scroll'], $common_data['smooth_scroll']['enabled']) ? $common_data['smooth_scroll']['enabled'] : false;
$smooth_scroll_value = isset($common_data['smooth_scroll'], $common_data['smooth_scroll']['value']) ? $common_data['smooth_scroll']['value'] : 1;
/**
* User value 1 to 200
*
* Min duration 1s
* Max duration 12s
*
*/
$duration = ceil(($smooth_scroll_value / 200) * 12);
$s = '';
if ($smooth_scroll_enabled) {
$s .= "';
}
return $s;
}
/**
* Format the date with date format
*
* @return string
*/
public static function format_date($date, $format)
{
if ($date && $format) {
$date_formats_arr = [
'DD/MM/YYYY' => 'd/m/Y',
'DD-MM-YYYY' => 'd-m-Y',
'DD.MM.YYYY' => 'd.m.Y',
'MM/DD/YYYY' => 'm/d/Y',
'MM-DD-YYYY' => 'm-d-Y',
'MM.DD.YYYY' => 'm.d.Y',
'MMMM DD, YYYY' => 'F j, Y',
'MMM DD, YYYY' => 'M j, Y',
'YYYY-MM-DD' => 'Y-m-d',
'YYYY/MM/DD' => 'Y/m/d',
'YY.MM.DD' => 'y.m.d',
'YY/MM/DD' => 'y/m/d',
'YY-MM-DD' => 'y-m-d',
];
$timestamp = strtotime($date);
if ($timestamp === false) {
return $date; // fallback (avoid fatal)
}
$datetime = (new \DateTime())->setTimestamp($timestamp);
return $datetime->format($date_formats_arr[$format] ?? $format);
}
return $date;
}
/**
* Format the time with time format
*
* @return string
*/
public static function convert_time_format($timeString, $format = 'h:i a')
{
$dateTime = null;
try {
$dateTime = new \DateTime($timeString);
if ($dateTime && $timeString) {
return $dateTime->format($format);
}
} catch (\Exception $e) {
// if timeString is an invalid time format
$parts = explode(' ', $timeString);
if (count($parts) > 1) {
// Remove the last part (am/pm)
$time_value = $parts[0];
try {
$dateTime = new \DateTime($time_value);
if ($dateTime && $timeString) {
return $dateTime->format($format);
}
} catch (\Exception $e2) {
return $timeString;
}
}
return $timeString;
}
return $timeString;
}
/**
* Get single post if has a kirki type post
*
* @return object|bool
*/
public static function get_last_edited_kirki_editor_type_page()
{
$args = array(
'post_type' => 'page', // Change to 'post' if you want to search for posts
'post_status' => ['publish', 'draft'],
'numberposts' => 1, // Number of results to retrieve (change as needed)
'meta_key' => 'kirki_editor_mode',
'meta_value' => 'kirki',
'orderby' => 'modified', // Order by post date
'order' => 'DESC', // Sort in descending order
);
$pages = get_posts($args);
if (count($pages) > 0) {
return $pages[0];
}
return false;
}
public static function get_kirki_version_from_db()
{
$version = wp_cache_get('kirki_version', 'kirki');
if (false === $version) {
$version = get_option('kirki_version', '');
if (!empty($version)) {
wp_cache_set('kirki_version', $version, 'kirki');
}
}
return $version;
}
public static function set_kirki_version_in_db()
{
$version = self::get_kirki_version_from_db();
if ($version && version_compare($version, KIRKI_VERSION, '==')) {
// No need to update the version if it's already equal to the current version.
return;
}
update_option('kirki_version', KIRKI_VERSION, false);
wp_cache_set('kirki_version', KIRKI_VERSION, 'kirki');
}
public static function accepted_file_types_by_plugin($accepted_media_types = KIRKI_SUPPORTED_MEDIA_TYPES)
{
$result = array();
foreach ($accepted_media_types as $value) {
if (is_array($value)) {
$result = array_merge($result, self::accepted_file_types_by_plugin($value));
} else {
$result[] = $value;
}
}
return $result;
}
public static function content_manager_link_filter($dynamic_content = array(), $href = "#")
{
$current_post = get_post(self::get_post_id_if_possible_from_url());
if ($current_post->post_type === KIRKI_CONTENT_MANAGER_PREFIX) {
$fields = ContentManagerHelper::get_post_type_custom_field_keys($current_post->post_parent);
if (isset($fields[$dynamic_content['value']]) && is_array($fields[$dynamic_content['value']])) {
if ('email' === $fields[$dynamic_content['value']]['type']) {
$href = "mailto:$href";
} else if ('phone' === $fields[$dynamic_content['value']]['type']) {
$href = "tel:$href";
}
}
}
return $href;
}
public static function check_string_has_this_tags($string, $tag)
{
// Check if the string contains either a tag or an
tag
return preg_match("/<" . $tag . "[^>]*>/i", $string) === 1;
}
/**
* @deprecated
* @see Kirki\App\Managers\GlobalDataManager::get_post_id()
*/
private static function get_global_data_post_id()
{
$post_id = get_option('KIRKI_GLOBAL_DATA_POST_TYPE_ID', get_option('DROIP_GLOBAL_DATA_POST_TYPE_ID', false));
if ($post_id) {
return $post_id;
} else {
//this block will run only once
$posts = get_posts(array(
'post_type' => KIRKI_GLOBAL_DATA_POST_TYPE_NAME,
'numberposts' => 1,
));
if ($posts) {
$post_id = $posts[0]->ID;
} else {
//create new post
$post = array(
'post_title' => KIRKI_GLOBAL_DATA_POST_TYPE_NAME,
'post_type' => KIRKI_GLOBAL_DATA_POST_TYPE_NAME,
'post_status' => 'draft'
);
$post_id = wp_insert_post($post);
}
update_option('KIRKI_GLOBAL_DATA_POST_TYPE_ID', $post_id, true);
}
return $post_id;
}
/**
* Get global data using key
*
* @deprecated
* @see Kirki\App\Managers\GlobalDataManager::get()
*/
public static function get_global_data_using_key($key)
{
//first get post using KIRKI_GLOBAL_DATA_POST_TYPE_NAME post_type name. if not found then create new one.
$post_id = self::get_global_data_post_id();
if (metadata_exists('post', $post_id, $key)) {
return get_post_meta($post_id, $key, true);
}
// this block will run only once for a legacy option key.
$value = get_option($key, null);
if (null !== $value) {
update_post_meta($post_id, $key, $value);
delete_option($key);
}
return $value;
}
/**
* Get global data using key
*
* @deprecated
* @see Kirki\App\Managers\GlobalDataManager::update()
*/
public static function update_global_data_using_key($key, $value)
{
$post_id = self::get_global_data_post_id();
update_post_meta($post_id, $key, $value);
}
public static function get_template_data_if_current_page_is_kirki_template()
{
$custom_data = get_query_var('kirki_custom_data');
$data = false;
$builder_div = '';
if ($custom_data && isset($custom_data['kirki_template_content'])) {
$action = HelperFunctions::sanitize_text(isset($_GET['action']) ? $_GET['action'] : null);
$load_for = HelperFunctions::sanitize_text(isset($_GET['load_for']) ? $_GET['load_for'] : '');
if ($action === KIRKI_EDITOR_ACTION && $load_for === 'kirki-iframe' && !str_contains($custom_data['kirki_template_content'], 'kirki-builder')) {
$template_edit_url = HelperFunctions::get_post_url_arr_from_post_id($custom_data['kirki_template_id'], ['editor_url' => true])['editor_url'];
$builder_div = '
';
}
$data = array(
'content' => $custom_data['kirki_template_content'] . $builder_div,
'template_id' => $custom_data['kirki_template_id']
);
}
return $data;
}
public static function get_custom_data_if_current_page_is_kirki_custom_post()
{
$custom_data = get_query_var('kirki_custom_data');
$data = false;
$builder_div = '';
if ($custom_data && isset($custom_data['kirki_custom_post_content'])) {
$action = HelperFunctions::sanitize_text(isset($_GET['action']) ? $_GET['action'] : null);
$load_for = HelperFunctions::sanitize_text(isset($_GET['load_for']) ? $_GET['load_for'] : '');
if ($action === KIRKI_EDITOR_ACTION && $load_for === 'kirki-iframe' && !str_contains($custom_data['kirki_custom_post_content'], 'kirki-builder')) {
$template_edit_url = HelperFunctions::get_post_url_arr_from_post_id($custom_data['kirki_custom_post_id'], ['editor_url' => true])['editor_url'];
$builder_div = '';
}
$data = array(
'content' => $custom_data['kirki_custom_post_content'] . $builder_div,
'post_id' => $custom_data['kirki_custom_post_id']
);
}
return $data;
}
/**
* Validate slug for a post.
*
* @param int|null $post_id
* @param string $post_type
* @param string $post_name
* @return bool
*
* @deprecated Use Kirki\App\Supports\ContentManager::validate_slug() instead.
* @see Kirki\App\Supports\ContentManager
*/
public static function validate_slug($post_id, $post_type, $post_name)
{
global $wpdb;
// Execute the query
$result = $wpdb->get_var($wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_name = %s AND post_type = %s AND ID != %d", $post_name, $post_type, $post_id ? $post_id : 0));
// If a post with the same slug exists, return false
if ($result) {
return false;
}
// If no post with the same slug exists, return true
return true;
}
/**
* Summary of find_utility_page_for_this_context
* @param mixed $type
* @param mixed $get_by id | type.
* @return mixed
*/
public static function find_utility_page_for_this_context($value = '404', $get_by = 'type')
{
$utility_pages = Page::fetch_list('kirki_utility', true, array('publish'));
if (count($utility_pages) > 0) {
foreach ($utility_pages as $key => $page) {
if ($get_by === 'type') {
if ($page['utility_page_type'] === $value) {
return $page;
}
} else if ($get_by === 'id') {
if ($page['id'] === (int) $value) {
return $page;
}
}
}
}
return false;
}
public static function get_current_page_context()
{
$context = array(); // {id, type}
$obj = get_queried_object();
if (is_404()) {
$context['type'] = '404';
} else if ($obj instanceof WP_Post) {
$context['id'] = $obj->ID;
$context['type'] = 'post';
} else if ($obj instanceof WP_User) {
$context['id'] = $obj->ID;
$context['type'] = 'user';
} elseif ($obj instanceof WP_Term) {
$context['id'] = $obj->term_id;
$context['type'] = 'term';
}
// elseif ($obj instanceof WP_Post_Type) {
// echo 'This is a WP_Post_Type object';
// } elseif (is_null($obj)) {
// echo 'No queried object (null)';
// }
else {
$kirki_utility_page_type = get_query_var('kirki_utility_page_type');
$kirki_utility_page_id = get_query_var('kirki_utility_page_id');
if (!empty($kirki_utility_page_type)) {
if (!self::check_utility_page_visibility_condition($kirki_utility_page_type)) {
$context['type'] = '404';
} else {
$context['type'] = 'kirki_utility';
$context['kirki_utility_page_type'] = $kirki_utility_page_type;
$context['kirki_utility_page_id'] = $kirki_utility_page_id;
}
}
}
return $context;
}
/**
* Get utility page slug using type.
* { type: 'login', title: 'Login' },
* { type: 'sign_up', title: 'Registration' },
* { type: 'forgot_password', title: 'Forgot Password' },
* { type: 'reset_password', title: 'Reset Password' },
* { type: 'retrive_username', title: 'Retrive Username' },
* { type: '404', title: '404' },
*
* @param string $type //utility page type.
* @return string||bool //string or false.
*/
public static function get_utility_page_url($type)
{
$utility_pages = Page::fetch_list('kirki_utility', true, array('publish'));
foreach ($utility_pages as $key => $page) {
$utility_page_type = $page['utility_page_type'];
$slug = $page['slug'];
if ($utility_page_type === $type) {
return home_url('/' . $slug);
}
}
return false;
}
public static function check_utility_page_visibility_condition($type)
{
if ($type === 'login' || $type === 'sign_up' || $type === 'forgot_password' || $type === 'reset_password' || $type === 'retrive_username') {
// Check if the user is already logged in
if (is_user_logged_in()) {
return false; // User is logged in, so the page should not be visible
}
// Add other conditions based on the type if needed
if ($type === 'signup') {
// Example: Check if registrations are enabled in WordPress
if (!get_option('users_can_register')) {
return false; // Registration is disabled
}
}
// If the user is not logged in and other conditions pass, allow the page to be visible
return true;
}
// If the type is not 'login' or 'signup', return false by default
return true;
}
/**
* @deprecated
* @see \Kirki\Framework\Supports\Facades\File::delete()
*/
public static function delete_directory($dirname)
{
global $wp_filesystem;
if (empty($wp_filesystem)) {
require_once ABSPATH . 'wp-admin/includes/file.php';
WP_Filesystem();
}
if ($wp_filesystem->exists($dirname)) {
return $wp_filesystem->delete($dirname, true);
}
return false;
}
/**
* @deprecated
* @see \Kirki\App\Supports\FileHandler::get_temp_folder_path()
*/
public static function get_temp_folder_path()
{
$upload_dir = wp_upload_dir();
$temp_folder = 'kirki_temp';
$temp_folder_path = $upload_dir['basedir'] . '/' . $temp_folder;
return $temp_folder_path;
}
/**
* @deprecated
* @see \Kirki\App\Managers\GlobalDataManager::get_initial_viewports()
*/
public static function get_initial_view_ports()
{
return json_decode('{
"active":"md",
"scale":1,
"zoom":1,
"width":1200,
"mdWidth":"",
"defaults":[
"md",
"tablet",
"mobileLandscape",
"mobile"
],
"list":{
"md":{
"value":1200,
"scale":1,
"minWidth":1200,
"maxWidth":1200,
"title":"Desktop",
"icon":"desktop",
"activeIcon":"desktop-hover"
},
"tablet":{
"value":991,
"scale":1,
"minWidth":991,
"maxWidth":991,
"title":"Tablet",
"icon":"tablet-default",
"activeIcon":"tablet-hover"
},
"mobileLandscape":{
"value":767,
"scale":1,
"minWidth":767,
"maxWidth":767,
"title":"Landscape",
"icon":"phone-hr-default",
"activeIcon":"phone-hr-hover"
},
"mobile":{
"value":575,
"scale":1,
"minWidth":575,
"maxWidth":575,
"title":"Mobile",
"icon":"phone-vr-default",
"activeIcon":"phone-vr-hover"
}
}
}', true);
}
/**
* @deprecated
* @see \Kirki\App\Supports\FileHandler::download_zip_from_remote()
*/
public static function download_zip_from_remote($remote_file, $new_name)
{
return FileHandler::download_zip_from_remote($remote_file, $new_name);
// $file_ext = explode('.', $remote_file); // ['file', 'ext']
// $file_ext = strtolower(end($file_ext)); // 'ext'
// $allowed = ['zip'];
// if (!in_array($file_ext, $allowed)) {
// return false;
// }
// try {
// // error_reporting(E_ALL);
// // ini_set('display_errors', 1);
// // Download the file from the remote server.
// // Create a stream context to disable SSL verification
// $options = [
// "http" => [
// "method" => "GET",
// "header" => "User-Agent: WordPress\r\n"
// ],
// "ssl" => [
// "verify_peer" => false, // Disable verification of the peer's certificate
// "verify_peer_name" => false // Disable verification of the peer's name
// ]
// ];
// $context = stream_context_create($options);
// $file_contents = file_get_contents($remote_file, false, $context);
// // Save the file locally.
// if ($file_contents !== false) {
// // Local path to save the downloaded file.
// $local_file = wp_upload_dir()['basedir'] . '/' . $new_name;
// file_put_contents($local_file, $file_contents);
// return $local_file;
// }
// } catch (\Throwable $th) {
// // throw $th;
// }
// return false;
}
public static function filterZipFile($zip, $zip_file_path)
{
// Temporary filtered ZIP path
$filtered_zip_path = sys_get_temp_dir() . '/filtered.zip';
$filtered_zip = new \ZipArchive;
if ($filtered_zip->open($filtered_zip_path, \ZipArchive::CREATE | \ZipArchive::OVERWRITE) === TRUE) {
// Loop through all files in the archive
for ($i = 0; $i < $zip->numFiles; $i++) {
$filename = $zip->getNameIndex($i);
$file_path = 'zip://' . $zip_file_path . '#' . $filename;
// Get MIME type based on file extensioncm_f
$file_mime = self::getMimeTypeByExtension($filename);
// Additional JSON validation
if ($file_mime === 'application/json' && !self::isJsonFile($file_path)) {
$file_mime = 'text/plain'; // Fallback if not valid JSON
}
// Check if the file MIME type matches supported types
$is_supported = false;
foreach (KIRKI_SUPPORTED_MEDIA_TYPES as $types) {
if (in_array($file_mime, $types)) {
$is_supported = true;
break;
}
}
// Add the file to the filtered archive if supported
if ($is_supported) {
$file_contents = $zip->getFromIndex($i);
$filtered_zip->addFromString($filename, $file_contents);
}
}
$filtered_zip->close();
return $filtered_zip_path;
} else {
return false;
}
}
// Helper function to get MIME type by file extension
private static function getMimeTypeByExtension($filename)
{
$extension_to_mime = [
'json' => 'application/json',
'jpg' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'png' => 'image/png',
'gif' => 'image/gif',
'webp' => 'image/webp',
'svg' => 'image/svg+xml',
'pdf' => 'application/pdf',
'mp4' => 'video/mp4',
'ogg' => 'audio/ogg',
'lottie' => 'text/plain',
'mov' => 'video/quicktime',
'mp3' => 'audio/mpeg',
'wav' => 'audio/wav',
// Add more extensions as needed
];
$ext = pathinfo($filename, PATHINFO_EXTENSION);
return $extension_to_mime[strtolower($ext)] ?? 'application/octet-stream';
}
// Helper function to validate JSON file content
private static function isJsonFile($file_path)
{
$file_contents = @file_get_contents($file_path);
$trimmed = trim($file_contents);
return $trimmed[0] === '{' || $trimmed[0] === '[';
}
public static function is_remote_url($url)
{
// Parse the URL to get components
$parsed_url = wp_parse_url($url);
return isset($parsed_url['scheme']);
}
public static function is_element_accessible($access)
{
switch ($access) {
case 'all':
return true; // Accessible to everyone
case 'guest':
return !is_user_logged_in();
case 'logged-in':
return is_user_logged_in(); // Accessible to any logged-in user
case 'admin':
// Administrators and Super Admins
return current_user_can('manage_options');
case 'editor':
// Editors, Admins, and Super Admins can see this
return current_user_can('edit_pages');
case 'author':
// Authors, Editors, Admins, etc.
return current_user_can('publish_posts');
case 'subscriber':
// Subscribers and EVERY logged-in user above them
return current_user_can('read');
default:
return false; // Safely hide if the access rule is unrecognized
}
}
/**
* Find symbol for post id using condition
* it will find and return selected symbols html and css;
*
* @param string $type : symbol type.
* @param string $post : post object.
* @return symbol || bool(false)
*/
public static function find_symbol_for_this_page($type)
{
$all_symbols = Symbol::fetch_list(true, false);
foreach ($all_symbols as $key => $symbol) {
if (isset($symbol['setAs']) && $symbol['setAs'] === $type) {
return $symbol;
}
}
return false;
}
/**
* Get Custom Header
* it will find and return selected symbols html and css;
*
* @param string $type stymbol type header|footer.
* @param string $html if true the function will return html otherwise return symbol object.
* @return string|object custom section html or stymbol object.
*/
public static function get_page_custom_section($type, $html = true)
{
$show = apply_filters('kirki_show_custom_section_' . $type, true);
if (!$show) {
return '';
}
$symbol = self::find_symbol_for_this_page($type);
if (!$html) {
return $symbol;
}
if (isset(self::$custom_sections[$type])) {
return self::$custom_sections[$type];
}
$s = self::isShowWPThemeHeaderFooter() ? '' : ' '; // this is for disableing theme header footer forcefully if is_show_wp_theme_header_footer is false
if ($symbol) {
$action = HelperFunctions::sanitize_text(isset($_GET['action']) ? $_GET['action'] : '');
$symbol_data = $symbol['symbolData'];
$set_as = isset($symbol['setAs']) ? $symbol['setAs'] : '';
$post_id = self::get_post_id_if_possible_from_url();
$template_data = self::get_template_data_if_current_page_is_kirki_template();
if ($template_data)
$post_id = $template_data['template_id'];
$custom_page_data = self::get_custom_data_if_current_page_is_kirki_custom_post();
if ($custom_page_data)
$post_id = $custom_page_data['post_id'];
$is_page_symbol_disabled = get_post_meta($post_id, KIRKI_META_NAME_FOR_PAGE_HF_SYMBOL_DISABLE_STATUS, true);
if (isset($is_page_symbol_disabled) && is_array($is_page_symbol_disabled) && isset($is_page_symbol_disabled[$type])) {
$is_page_symbol_disabled = $is_page_symbol_disabled[$type];
} else {
$is_page_symbol_disabled = false;
}
$params = array(
'blocks' => $symbol_data['data'],
'style_blocks' => $symbol_data['styleBlocks'],
'root' => $symbol_data['root'],
'post_id' => $symbol['id'],
'options' => [],
'get_style' => true,
'get_variable' => false,
'should_take_app_script' => false,
'prefix' => 'kirki-s' . $symbol['id']
);
if ($action === KIRKI_EDITOR_ACTION) {
$extra_attr_for_hf_symbol = '';
if ($is_page_symbol_disabled)
$extra_attr_for_hf_symbol = ' style="display:none;"';
$s = '<' . $type . $extra_attr_for_hf_symbol . ' data-kirki-symbol_set_as="' . $set_as . '" data-kirki-symbol="' . $symbol['id'] . '" data-kirki="' . $type . '">' . self::get_html_using_preview_script($params) . ''; //added data-kirki="$type" => We removed theme header and footer using preg_replace in TheFrontendHooks.php file
} else if (!$is_page_symbol_disabled) {
$params['should_take_app_script'] = true;
$params['get_variable'] = true;
$s = self::get_html_using_preview_script($params);
} else if ($is_page_symbol_disabled) {
$s = '';
}
}
$s = do_shortcode($s);
self::$custom_sections[$type] = $s;
return $s;
}
public static function isShowWPThemeHeaderFooter()
{
$common_data = WpAdmin::get_common_data(true);
return $common_data['is_show_wp_theme_header_footer'];
}
/**
* Check if a value is considered true or false.
*
* @param mixed $value The value to check.
* @return bool Returns true if the value is considered "truthy", otherwise false.
*
* @deprecated
* @see function \Kirki\App\is_truthy()
*/
public static function isTruthy($value): bool
{
return filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) ?? false;
}
/**
* Get the upload directory path has upload or write permission.
*
* @deprecated
* @see Kirki\Framework\Supports\Facades\File::is_writable()
* @see function Kirki\App\get_upload_directory()
*/
public static function get_upload_dir_has_write_permission()
{
if (!function_exists('request_filesystem_credentials')) {
require_once ABSPATH . 'wp-admin/includes/file.php';
}
if (WP_Filesystem()) {
global $wp_filesystem;
$upload_dir = wp_upload_dir();
return $wp_filesystem->is_writable($upload_dir['basedir']);
}
return false;
}
/**
* $name = [] or string
* @deprecated
* @see Kirki\App\Supports\Template::add_prefix_to_class_name()
*/
public static function add_prefix_to_class_name($prefix, $name)
{
if (is_array($name)) {
foreach ($name as $key => $c) {
$c = strtolower($c);
if (in_array($c, KIRKI_PRESERVED_CLASS_LIST)) {
$name[$key] = $c;
} else {
$name[$key] = $prefix ? strtolower($prefix) . '-' . $c : $c;
}
}
} else {
$name = strtolower($name);
if (!in_array($name, KIRKI_PRESERVED_CLASS_LIST)) {
$name = $prefix ? strtolower($prefix) . '-' . $name : $name;
}
}
return $name;
}
public static function checkVisibilityConditions($element, $options)
{
$conditions = $element['properties']['visibilityConditions'] ?? [];
if (!count($conditions))
return true;
foreach ($conditions as $and_group) {
$and_result = true;
foreach ($and_group as $condition) {
$source = (string) ($condition['source'] ?? 'kirki');
$condition_result = apply_filters('kirki_visibility_condition_check_' . $source, false, $condition, $options);
if (!$condition_result) {
$and_result = false;
break; // If any condition fails in AND group
}
}
if ($and_result) {
return true; // If any OR group passes
}
}
return false; // No group passed
}
private static function update_slider_style_blocks($blocks, $styles)
{
$slider_mask_styleIds = [];
$slider_item_styleIds = [];
// slider_item
foreach ($blocks as $id => $block) {
// Check if the block has a 'name' key
if (isset($block['name'])) {
if (isset($block['name']) && $block['name'] === 'slider_mask') {
// Loop through each item in $block['styleIds']
foreach ($block['styleIds'] as $styleId) {
// Check if the styleId is NOT already in the $slider_mask_styleIds array
if (!in_array($styleId, $slider_mask_styleIds)) {
// If not present, push it into the array
$slider_mask_styleIds[] = $styleId;
}
}
}
if (isset($block['name']) && $block['name'] === 'slider_item') {
// Loop through each item in $block['styleIds']
foreach ($block['styleIds'] as $styleId) {
// Check if the styleId is NOT already in the $slider_item_styleIds array
if (!in_array($styleId, $slider_item_styleIds)) {
// If not present, push it into the array
$slider_item_styleIds[] = $styleId;
}
}
}
}
}
if (count($slider_mask_styleIds) > 0) {
foreach ($slider_mask_styleIds as $styleId) {
if ($styles[$styleId]) {
$style = $styles[$styleId];
$style_variants = $style['variant'];
$styleVariants = [];
if ($style_variants && count($style_variants) > 0) {
foreach ($style_variants as $key => $css) {
$css = preg_replace('/overflow\s*:\s*hidden;?/', '', $css);
$css = preg_replace('/pointer-events\s*:\s*none;?/', '', $css);
$css = trim($css);
$styleVariants[$key] = $css;
}
}
$styles[$styleId]['variant'] = $styleVariants;
}
}
}
if (count($slider_item_styleIds) > 0) {
foreach ($slider_item_styleIds as $styleId) {
$style = $styles[$styleId];
$style_variants = $style['variant'];
$styleVariants = [];
if ($style_variants && count($style_variants) > 0) {
foreach ($style_variants as $key => $css) {
$css = preg_replace('/position\s*:\s*absolute;?/', '', $css);
$css = preg_replace('/display\s*:\s*none;?/', '', $css);
$css = trim($css);
$styleVariants[$key] = $css;
}
$styles[$styleId]['variant'] = $styleVariants;
}
}
}
return $styles;
}
public static function handle_legacy_slider_class()
{
$data = Page::get_all_data_by_kirki_meta_key();
foreach ($data as $key => $value) {
$post_id = $value['post_id']; // ID of the post
$meta_key = $value['meta_key']; // Meta key name
$meta_value = $value['meta_value']; // Serialized meta value
$meta_value = unserialize($meta_value, ['allowed_classes' => false]); // Convert serialized data to array
// If the meta value has a 'blocks' key, handle it as a full page data
if (isset($meta_value['blocks'])) {
$blocks = $meta_value['blocks']; // Get the blocks array
$styles = self::get_page_styleblocks($post_id);
$updated_styles = self::update_slider_style_blocks($blocks, $styles); // Update block names
self::update_page_styleblocks($post_id, $updated_styles);
} else {
// If no 'blocks' key, treat entire value as blocks array
$blocks = $meta_value;
$post = get_post($post_id);
if (isset($post->post_type) && $post->post_type === 'kirki_symbol') {
$styles = $blocks['styleBlocks'];
$updated_styles = self::update_slider_style_blocks($blocks['data'], $styles);
$blocks['styleBlocks'] = $updated_styles;
update_post_meta($post_id, $meta_key, $blocks);
}
}
}
}
public static function handle_legacy_slider_default_class()
{
$styles = self::get_global_data_using_key(KIRKI_GLOBAL_STYLE_BLOCK_META_KEY);
if (!$styles) {
$styles = array();
}
if (count($styles) > 0) {
if (isset($styles['kirki_slider_slide'])) {
// Handle kirki_slider_mask
if (isset($styles['kirki_slider_mask'])) {
$variants = $styles['kirki_slider_mask']['variant'];
if (count($variants) > 0) {
$styleVariants = [];
foreach ($variants as $key => $css) {
$css = preg_replace('/overflow\s*:\s*hidden;?/', '', $css);
$css = preg_replace('/pointer-events\s*:\s*none;?/', '', $css);
$css = trim($css);
$styleVariants[$key] = $css;
}
$styles['kirki_slider_mask']['variant'] = $styleVariants;
}
}
// Handle kirki_slider_slide
if (isset($styles['kirki_slider_slide'])) {
$variants = $styles['kirki_slider_slide']['variant'];
if (count($variants) > 0) {
$styleVariants = [];
foreach ($variants as $key => $css) {
$css = preg_replace('/position\s*:\s*absolute;?/', '', $css);
$css = preg_replace('/display\s*:\s*none;?/', '', $css);
$css = trim($css);
$styleVariants[$key] = $css;
}
$styles['kirki_slider_slide']['variant'] = $styleVariants;
}
}
}
}
}
public static function get_current_item_index($index, $options)
{
$pagination = isset($options['pagination']) ? $options['pagination'] : false;
$items_per_page = isset($options['items_per_page']) ? $options['items_per_page'] : 3;
$page_no = isset($options['page_no']) ? $options['page_no'] : 1;
if ($pagination && $items_per_page > 0 && $page_no > 0) {
// Calculate the start index based on the current page and items per page
$index = (($page_no - 1) * $items_per_page) + $index;
}
return $index;
}
public static function convertToBytes($val)
{
$val = trim($val);
$last = strtolower($val[strlen($val) - 1]);
$val = (int) $val;
switch ($last) {
case 'g':
$val *= 1024;
case 'm':
$val *= 1024;
case 'k':
$val *= 1024;
}
return $val;
}
/**
* @deprecated
* @see Kirki\App\Supports\Canvas::get_full_canvas_template_path()
*/
public static function get_kirki_full_canvas_template_path()
{
return self::normalize_kirki_full_canvas_template_path(KIRKI_FULL_CANVAS_TEMPLATE_PATH);
}
/**
* @deprecated
* @see Kirki\App\Supports\Canvas::normalize_full_canvas_template_path()
*/
public static function normalize_kirki_full_canvas_template_path($path)
{
// replace if has kirki-pro => kirki
if (strpos($path, 'kirki-pro') !== false) {
$path = str_replace('kirki-pro', 'kirki', $path);
}
return $path;
}
public static function normalize_variable_mode($mode)
{
if (!$mode) {
return ['color' => 'inherit', 'size' => 'inherit', 'text-style' => 'inherit', 'font-family' => 'inherit'];
}
// if v is string
if (is_string($mode)) {
return ['color' => $mode, 'size' => $mode, 'text-style' => $mode, 'font-family' => $mode];
}
if (is_array($mode)) {
return $mode;
}
return $mode;
}
/**
* Whether a the environment is local or not.
*
* @return bool
*/
public static function is_localenv() {
// Depends on WP_ENVIRONMENT_TYPE const or env value
if ( 'local' !== wp_get_environment_type() ) {
return false;
}
return true;
}
/**
* Whether an IP address falls into a private, loopback or reserved range.
*
* @param string $ip A validated IPv4 or IPv6 address.
* @return bool True when the IP is private, loopback or reserved.
*/
private static function is_private_or_loopback_ip( $ip ) {
$reserved_prefixes = array(
'192.0.2.', // TEST-NET-1, 192.0.2.0/24
'198.51.100.', // TEST-NET-2, 198.51.100.0/24
'203.0.113.', // TEST-NET-3, 203.0.113.0/24
);
foreach ( $reserved_prefixes as $prefix ) {
if ( str_starts_with( $ip, $prefix ) ) {
return true;
}
}
return ! (bool) filter_var(
$ip,
FILTER_VALIDATE_IP,
FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE
);
}
/**
* Whether the target url is a safe, externally reachable http(s) URL.
*
* Rejects loopback, private, link-local and cloud-metadata addresses so a
* planted form config cannot be used to probe the server's own network.
*
* @param string $url The URL.
* @return bool
*/
public static function is_safe_url($url) {
if (!is_string($url) || filter_var($url, FILTER_VALIDATE_URL) === false) {
return false;
}
$scheme = wp_parse_url($url, PHP_URL_SCHEME);
$host = wp_parse_url($url, PHP_URL_HOST);
if (!is_string($scheme) || !in_array(strtolower($scheme), array('http', 'https'), true)) {
return false;
}
if (!is_string($host) || '' === $host) {
return false;
}
if (self::is_localenv()) {
return true;
}
if (filter_var($host, FILTER_VALIDATE_IP)) {
$ip = $host;
} else {
$ip = gethostbyname($host);
if ($ip === $host) {
return false;
}
}
return ! self::is_private_or_loopback_ip($ip);
}
}