.pace { -webkit-pointer-events: none; pointer-events: none; -webkit-user-select: none; -moz-user-select: none; user-select: none; } .pace-inactive { display: none; } .pace .pace-progress { background: #' . esc_attr( $color ) . '; position: fixed; z-index: 2000; top: 0; right: 100%; width: 100%; height: 5px; -webkit-box-shadow: 0 0 3px rgba(255, 255, 255, 0.3); box-shadow: 0 0 2px rgba(255, 255, 255, 0.3); } '; return $style; } } add_filter( 'alm_progress_css', 'alm_progress_css', 10, 3 ); /** * Is ALM CSS disabled. * * @param string $setting The name of the setting field. * @return boolean Is it enabed or disabled. * @since 3.3.1 */ function alm_css_disabled( $setting ) { $options = get_option( 'alm_settings' ); return ! isset( $options[ $setting ] ) || $options[ $setting ] !== '1' ? false : true; } /** * Load ALM CSS inline. * * @param string $setting The name of the setting field. * @return boolean Is it inline or in a file. * @since 3.3.1 */ function alm_do_inline_css( $setting ) { if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) { return; // Exit if this is a REST API request. } $options = get_option( 'alm_settings' ); return ! isset( $options[ $setting ] ) || $options[ $setting ] === '1' ? true : false; } /** * Check if the current request is a block editor request. * * @return boolean */ function alm_is_block_editor() { return defined( 'REST_REQUEST' ) && REST_REQUEST; } /** * This function will return HTML of a looped item. * * @param string $repeater The repeater name. * @param string $theme_repeater Theme repeater name. * @param string $alm_found_posts Total posts found. * @param string $alm_page The page number. * @param string $alm_item Current item in loop. * @param string $alm_current Current item in page. * @param array $args The ALM Args. * @param boolean $ob Should the loop return as an output buffer. * @return string * @since 3.7 */ function alm_loop( $repeater, $theme_repeater, $alm_found_posts = '', $alm_page = '', $alm_item = '', $alm_current = '', $args = [], $ob = true ) { if ( $ob ) { // If Output Buffer is true. ob_start(); } if ( $theme_repeater !== 'null' && has_filter( 'alm_get_theme_repeater' ) ) { // Theme Repeater. do_action( 'alm_get_theme_repeater', $theme_repeater, $alm_found_posts, $alm_page, $alm_item, $alm_current, $args ); } else { // Standard Template. $file = alm_get_current_repeater( $repeater, alm_get_repeater_type( $repeater ) ); include $file; } if ( $ob ) { // If Output Buffer is true. $html = ob_get_contents(); ob_end_clean(); return $html; } } /** * Get the current repeater template file. * * @param string $template The current template name. * @param string $type Type of template. * @return string The template file path. * @since 2.5.0 */ function alm_get_current_repeater( $template, $type ) { $include = ''; if ( $type === 'template_' && class_exists( 'ALMTemplates' ) ) { // Templates add-on. $base_dir = AjaxLoadMore::alm_get_repeater_path(); $include = $base_dir . '/' . $template . '.php'; if ( ! file_exists( $include ) ) { $table_name = defined( 'ALM_TEMPLATES_TABLE_NAME' ) ? ALM_TEMPLATES_TABLE_NAME : 'alm_unlimited'; alm_create_template( $template, $table_name ); // Create the template file if it doesn't exist. } } elseif ( $type === 'template_' && defined( 'ALM_UNLIMITED_VERSION' ) ) { // Custom Repeaters v2 add-on. if ( version_compare( ALM_UNLIMITED_VERSION, '2.5', '>=' ) ) { $base_dir = AjaxLoadMore::alm_get_repeater_path(); $include = $base_dir . '/' . $template . '.php'; if ( ! file_exists( $include ) ) { alm_create_template( $template, 'alm_unlimited' ); // Create the template file if it doesn't exist. } } else { global $wpdb; $blog_id = $wpdb->blogid; $include = ( $blog_id > 1 ) ? ALM_UNLIMITED_PATH . 'repeaters/' . $blog_id . '/' . $template . '.php' : ALM_UNLIMITED_PATH . 'repeaters/' . $template . '.php'; } } elseif ( $type === 'repeater' && has_action( 'alm_repeater_installed' ) ) { // Custom Repeaters v1 add-on. $include = ALM_REPEATER_PATH . 'repeaters/' . $template . '.php'; } else { // Default. $include = alm_get_default_repeater(); } // Confirm file exists and run security check. if ( ! file_exists( $include ) || ! alm_is_valid_path( $include ) ) { $include = alm_get_default_repeater(); } return $include; } /** * Get the default repeater template for current blog. * * @return $include (file path) * @since 2.5.0 */ function alm_get_default_repeater() { $file = ''; $template = ''; $dir = apply_filters( 'alm_template_path', 'alm_templates' ); // Load repeater template from current theme folder. if ( is_child_theme() ) { $template = get_stylesheet_directory() . '/' . $dir . '/default.php'; // If child theme does not have repeater template, then use the parent theme dir. if ( ! file_exists( $template ) ) { $template = get_template_directory() . '/' . $dir . '/default.php'; } } else { $template = get_template_directory() . '/' . $dir . '/default.php'; } // If theme or child theme contains the template, use that file. if ( file_exists( $template ) ) { return $template; } // Fallback to plugin template if not found in theme or child theme. if ( ! $file ) { $file = AjaxLoadMore::alm_get_repeater_path() . '/default.php'; } // Create the default template file if it doesn't exist. if ( ! file_exists( $file ) ) { alm_create_template( 'default', 'alm' ); } return $file; } /** * Create template file. * * @param string $id Repeater template name. * @param string $table_name The database table name. * @param string $col The database column name. * @return void */ function alm_create_template( $id = null, $table_name = null, $col = 'repeaterDefault' ) { if ( ! $id || ! $table_name || ! $col || apply_filters( 'alm_create_templates', false ) ) { return; } $allowed_tables = [ 'alm', 'alm_unlimited' ]; if ( ! in_array( $table_name, $allowed_tables, true ) ) { return; // Exit if table name is not allowed. } global $wpdb; $table = $wpdb->prefix . $table_name; $row = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $table WHERE name = %s", $id ) ); // Get first result only. $content = ! empty( $row ) && $row->$col ? $row->$col : ''; if ( ! $content ) { error_log( __( 'Ajax Load More: Template content not found: ' . $id ) ); // phpcs:ignore return; } $file = AjaxLoadMore::alm_get_repeater_path() . "/{$id}.php"; if ( ! alm_is_valid_path( $file ) ) { return; // Exit if file path is not valid. } // Create the file using WP_Filesystem. require_once ABSPATH . 'wp-admin/includes/file.php'; WP_Filesystem(); global $wp_filesystem; if ( ! $wp_filesystem->put_contents( $file, $content ) ) { error_log( __( 'Error writing file' ) ); // phpcs:ignore } } /** * Confirm directory or file path does not contain relative path. * * @since 7.1.0 * @param string $path The path to check. * @return boolean Return true if path is valid. */ function alm_is_valid_path( $path ) { if ( ! $path ) { return false; } return false !== strpos( $path, './' ) || false !== strpos( $path, '.\\' ) ? false : true; } /** * Construct a date query before/after query. * * @see https://developer.wordpress.org/reference/classes/wp_query/#date-parameters * @param array $args The WP_Query args. * @param string $before The before date. * @param string $after The after date. * @param string $inclusive The inclusive value. * @return array */ function alm_get_date_query_before_after( array $args = [], string $before = '', string $after = '', string $inclusive = '' ) { if ( empty( $before ) && empty( $after ) ) { return $args; // Exit early if no date query. } $array = []; if ( $before ) { $array['before'] = $before; } if ( $after ) { $array['after'] = $after; } if ( $inclusive ) { $array['inclusive'] = $inclusive === 'true'; } $args['date_query'][] = $array; return $args; } /** * Build and parse a date query. * * @see https://developer.wordpress.org/reference/classes/wp_query/#date-parameters * @param string $data The date query data. * @param string $compare The date query compare. * @param string $columm The date query columm. * @param array $args The WP_Query args. * @return array The modified args. */ function alm_get_date_query( $data = '', $compare = '', $columm = '', $args = [] ) { if ( ! $data ) { return $args; } // Explode the date query params. $data = explode( ';', $data ); $compare = explode( ';', $compare ); $columm = explode( ';', $columm ); // Loop each date query. foreach ( $data as $key => $value ) { $params = explode( '-', $value ); $date_compare = isset( $compare[ $key ] ) ? alm_parse_query_compare( $compare[ $key ] ) : ''; $date_columm = isset( $columm[ $key ] ) ? $columm[ $key ] : ''; $array = []; if ( isset( $params[0] ) && $params[0] ) { $array['year'] = $params[0]; } if ( isset( $params[1] ) && $params[1] ) { $array['month'] = $params[1]; } if ( isset( $params[2] ) && $params[2] ) { $array['day'] = $params[2]; } if ( isset( $params[3] ) && $params[3] ) { $array['hour'] = $params[3]; } if ( isset( $params[4] ) && $params[4] ) { $array['minute'] = $params[4]; } if ( isset( $params[5] ) && $params[5] ) { $array['second'] = $params[5]; } if ( isset( $params[6] ) && $params[6] ) { $array['week'] = $params[6]; } if ( $date_compare ) { $array['compare'] = $date_compare; } if ( $date_columm ) { $array['column'] = $date_columm; } $args['date_query'][] = $array; } return $args; } /** * Query by post format. * * @since 2.5.0 * @param string $post_format The current post format. * @return array The WP_Query args. */ function alm_get_post_format( $post_format ) { if ( ! empty( $post_format ) ) { $format = "post-format-$post_format"; // If query is for standard then we need to filter by NOT IN. if ( 'post-format-standard' === $format ) { $post_formats = get_theme_support( 'post-formats' ); if ( $post_formats && is_array( $post_formats[0] ) && count( $post_formats[0] ) ) { $terms = []; foreach ( $post_formats[0] as $format ) { $terms[] = 'post-format-' . $format; } } $return = [ 'taxonomy' => 'post_format', 'terms' => $terms, 'field' => 'slug', 'operator' => 'NOT IN', ]; } else { $return = [ 'taxonomy' => 'post_format', 'field' => 'slug', 'terms' => [ $format ], ]; } return $return; } } /** * Query for custom taxonomy. * * @see https://developer.wordpress.org/reference/classes/wp_query/#taxonomy-parameters * * @param string $taxonomy Taxonomy slug. * @param string $terms Taxonomy terms. * @param string $operator Taxonomy operator. * @param boolean $children Taxonomy include_children. * @return array Taxonomy query array. * @since 2.8.5 */ function alm_get_taxonomy_query( $taxonomy = '', $terms = '', $operator = 'IN', $children = true ) { if ( ! empty( $taxonomy ) && ! empty( $terms ) ) { $values = alm_parse_tax_terms( $terms ); $include_children = $children !== 'false' ? true : false; $query = [ 'taxonomy' => $taxonomy, 'field' => 'slug', 'terms' => $values, 'operator' => $operator, 'include_children' => $include_children, ]; return $query; } } /** * Parse the taxonomy terms for multiple vals. * * @since 2.8.5 * @param string $terms The taxonomy terms. * @return array */ function alm_parse_tax_terms( $terms ) { // Remove all whitespace for $taxonomy_terms because it needs to be an exact match. $terms = preg_replace( '/\s+/', ' ', $terms ); // Remove all spaces by replacing [term, term] with [term,term]. $terms = str_replace( ', ', ',', $terms ); // Create array from string. $terms = explode( ',', $terms ); return $terms; } /** * A do_shortcode fix (shortcode renders as HTML when using < OR <==). * * @param string $compare The compare operator. * @return void */ function alm_parse_query_compare( $compare ) { if ( ! $compare ) { return; } $compare = 'lessthan' === $compare ? '<' : $compare; $compare = 'lessthanequalto' === $compare ? '<=' : $compare; $compare = 'greaterthan' === $compare ? '>' : $compare; $compare = 'greaterthanequalto' === $compare ? '>=' : $compare; return $compare; } /** * Query by custom field values. * * @since 2.5.0 * @param array $params The array of meta query parameters. * @return array The WP_Query args. */ function alm_get_meta_query( $params ) { $meta_key = esc_sql( $params['key'] ); $meta_value = esc_sql( $params['value'] ); $meta_compare = esc_sql( $params['compare'] ); $meta_type = esc_sql( $params['type'] ); if ( ! empty( $meta_key ) ) { $meta_compare = alm_parse_query_compare( $meta_compare ); // Get optimized `meta_value` parameter. $meta_values = alm_parse_meta_value( $meta_value, $meta_compare ); // Clear $meta_values if empty. if ( $meta_values === '' ) { unset( $meta_values ); } if ( isset( $meta_values ) ) { $args = [ 'key' => $meta_key, 'value' => $meta_values, 'compare' => $meta_compare, 'type' => $meta_type, ]; } else { // If $meta_values is empty, don't query for 'value'. $args = [ 'key' => $meta_key, 'compare' => $meta_compare, 'type' => $meta_type, ]; } return $args; } } /** * Create the name for the meta query. * Note: This is required to use custom ordering. * eg. `Country Code` = `country_code_clause` * * @see https://wordpress.stackexchange.com/questions/246355/order-by-multiple-meta-key-and-meta-value/246358#246358 * @param string $key The meta key name. * @return string Formatted meta name. */ function alm_create_meta_clause( $key ) { $key = preg_replace( '/\s+/', '_', $key ); return strtolower( $key . '_clause' ); } /** * Parse the meta value for multiple values. * * @since 2.6.4 * @param string $meta_value The meta value. * @param string $meta_compare The compare operator. * @return array */ function alm_parse_meta_value( $meta_value, $meta_compare ) { // Meta Query Docs (http://codex.wordpress.org/Class_Reference/WP_Meta_Query). $meta_array = [ 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ]; if ( in_array( $meta_compare, $meta_array, true ) ) { // Remove all whitespace for meta_value because it needs to be an exact match. $mv_trimmed = preg_replace( '/\s+/', ' ', $meta_value ); // Trim whitespace. $meta_values = str_replace( ', ', ',', $mv_trimmed ); // Replace [term, term] with [term,term]. $meta_values = '' === $meta_values ? '' : explode( ',', $meta_values ); } else { $meta_values = $meta_value; } return $meta_values; } /** * Get the template type by the name. * Note: The function is used to parse the new `template` and `cta_template` parameters to * determine if the template is a theme repeater or a custom repeater. * * @since 7.2.0 * @param string $template The template name. * @return string The template type. */ function alm_get_template_by_type( $template = '' ) { // If template is a Theme Repeater. if ( strpos( $template, '.php' ) || strpos( $template, '.html' ) ) { return 'theme_repeater'; } return 'repeater'; } /** * Get type of custom repeater template. * Value should be 'default', 'repeater' or 'template_'. * * @since 2.9 * @param string $repeater The Repeater Template name. * @return string The Repeater Template type. */ function alm_get_repeater_type( $repeater ) { $type = preg_split( '/(?=\d)/', $repeater, 2 ); // Split $repeater value at number to determine type. $type = $type[0]; // default | repeater | template_. return $type; } /** * Get current page base URL. * * @since 2.12 * @return string The URL. */ function alm_get_canonical_url() { $canonical_url = ''; $frontpage_slash = apply_filters( 'alm_canonical_frontpage_trailing_slash', true ) ? '/' : ''; // e.g. add_filter('alm_canonical_frontpage_trailing_slash', '__return_false'). if ( is_date() ) { // Date Archive. $archive_year = get_the_date( 'Y' ); $archive_month = get_the_date( 'm' ); $archive_day = get_the_date( 'd' ); if ( is_year() ) { $canonical_url = get_year_link( $archive_year ); } if ( is_month() ) { $canonical_url = get_month_link( $archive_year, $archive_month ); } if ( is_day() ) { $canonical_url = get_month_link( $archive_year, $archive_month, $archive_day ); } } elseif ( is_front_page() ) { // Frontpage. if ( function_exists( 'pll_home_url' ) ) { // Polylang support. $canonical_url = pll_home_url(); } else { $canonical_url = get_home_url() . $frontpage_slash; } } elseif ( is_home() ) { // Home (Blog Default). $canonical_url = get_permalink( get_option( 'page_for_posts' ) ); } elseif ( is_category() ) { // Category. $cat_id = get_query_var( 'cat' ); $canonical_url = get_category_link( $cat_id ); } elseif ( is_tag() ) { // Tag. $tag_id = get_query_var( 'tag_id' ); $canonical_url = get_tag_link( $tag_id ); } elseif ( is_author() ) { // Author. $author_id = get_the_author_meta( 'ID' ); $canonical_url = get_author_posts_url( $author_id ); } elseif ( is_tax() ) { // Taxonomy. $tax_term = get_term_by( 'slug', get_query_var( 'term' ), get_query_var( 'taxonomy' ) ); if ( $tax_term ) { $tax_id = $tax_term->term_id; $canonical_url = get_term_link( $tax_id ); } } elseif ( is_post_type_archive() ) { // Post Type. $post_type_archive = get_post_type(); $canonical_url = get_post_type_archive_link( $post_type_archive ); } elseif ( is_search() ) { // Search. $canonical_url = get_home_url() . $frontpage_slash; } else { // Fallback. $canonical_url = get_permalink(); } return $canonical_url; } /** * Get current page slug. * * @since 2.13.0 * @param object $post The current Post object. * @return string The Post ID. */ function alm_get_page_slug( $post ) { // Exit if admin. if ( is_admin() ) { return false; } if ( ! is_archive() ) { // If not archive, set the post slug. if ( is_front_page() || is_home() || is_404() ) { $slug = 'home'; } elseif ( is_search() ) { // Search. $search_query = get_search_query(); if ( $search_query ) { $slug = "?s=$search_query"; } else { $slug = '?s='; } } else { $slug = $post->post_name; } } elseif ( is_tax() ) { // Tax. $queried_object = get_queried_object(); $slug = $queried_object->slug; } elseif ( is_category() ) { // Category. $cat = get_query_var( 'cat' ); $category = get_category( $cat ); $slug = $category->slug; } elseif ( is_tag() ) { // Tag. $slug = get_query_var( 'tag' ); } elseif ( is_author() ) { // Author. $slug = get_the_author_meta( 'ID' ); } elseif ( is_post_type_archive() ) { // Post Type Archive. $slug = get_post_type(); } elseif ( is_date() ) { // Date Archive. $archive_year = get_the_date( 'Y' ); $archive_month = get_the_date( 'm' ); $archive_day = get_the_date( 'd' ); if ( is_year() ) { $slug = $archive_year; } if ( is_month() ) { $slug = $archive_year . '-' . $archive_month; } if ( is_day() ) { $slug = $archive_year . '-' . $archive_month . '-' . $archive_day; } } else { $slug = ''; } return $slug; } /** * Get current page ID. * * @since 3.0.1 * @param object $post The current Post object. * @return string The Post ID. */ function alm_get_page_id( $post ) { // Exit if admin. if ( is_admin() ) { return false; } $post_id = ''; if ( ! is_archive() ) { // If not an archive page, set the post slug. if ( is_front_page() || is_home() || is_404() ) { $post_id = '0'; } else { // phpcs:ignore Universal.ControlStructures.DisallowLonelyIf.Found // Search. if ( is_search() ) { $search_query = get_search_query(); if ( $search_query ) { $post_id = "$search_query"; } } else { $post_id = $post->ID; } } } elseif ( is_tax() || is_tag() || is_category() ) { // Tax. $queried_object = get_queried_object(); $post_id = $queried_object->term_id; } elseif ( is_author() ) { // Author. $post_id = get_the_author_meta( 'ID' ); } elseif ( is_post_type_archive() ) { // Post Type Archive. $post_id = get_post_type(); } elseif ( is_date() ) { // Date Archive. $archive_year = get_the_date( 'Y' ); $archive_month = get_the_date( 'm' ); $archive_day = get_the_date( 'd' ); if ( is_year() ) { $post_id = $archive_year; } if ( is_month() ) { $post_id = $archive_year . '-' . $archive_month; } if ( is_day() ) { $post_id = $archive_year . '-' . $archive_month . '-' . $archive_day; } } return $post_id; } /** * Get query param of start page (?pg, paged, page). * * @since 2.14.0 * @return int The current page number. */ function alm_get_startpage() { $query_params = filter_input_array( INPUT_GET ); // Get query params from URL. if ( $query_params && isset( $query_params['pg'] ) ) { $page = $query_params['pg']; // Pluck `pg` querystring param. } elseif ( get_query_var( 'paged' ) ) { $page = get_query_var( 'paged' ); } elseif ( get_query_var( 'page' ) ) { $page = get_query_var( 'page' ); } else { $page = 1; } return $page; } /** * Debug helper for printing variables to screen. * * @since 3.7 * @param object $query The current WP_Query. */ function alm_pretty_print( $query ) { if ( $query ) { echo '
'; print_r( $query ); // phpcs:ignore echo ''; } } /** * Shorter debug helper for printing variables to screen. * * @param object $query The current WP_Query. * @param string $title Optional display title. * @since 5.5.1 */ function alm_print( $query = '', $title = '' ) { if ( $title ) { echo esc_html( $title ); } alm_pretty_print( $query ); } /** * Debug helper for printing to error log. * * @param object|array $data The data to log. */ function alm_log( $data ) { if ( is_array( $data ) || is_object( $data ) ) { error_log( print_r( $data, true ) ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions } else { error_log( $data ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log } } /** * Convert dashes to underscores. * * @param string $data The string to convert. * @return string The converted string without dashes. * @since 3.7 */ function alm_convert_dashes_to_underscore( $data = '' ) { return str_replace( '-', '_', $data ); } /** * Remove posts if post__not_in is set in the ALM shortcode. * * @param array $ids Post IDs. * @param array $not_in Array of not in post IDs. * @return array The Post IDs. * @since 3.7 */ function alm_sticky_post__not_in( $ids = '', $not_in = '' ) { if ( ! empty( $not_in ) ) { $new_array = []; foreach ( $ids as $id ) { if ( ! in_array( $id, $not_in, true ) ) { array_push( $new_array, $id ); } } $ids = $new_array; } return $ids; }