# charitable/1.8.13/includes/public/charitable-template-helpers.php Charitable – Donation & Fundraising Platform (Donation Forms, Recurring Donations & Fundraising Campaigns), version 1.8.13. 481 lines. - Page: https://pluginprobe.com/plugins/charitable/1.8.13/code/includes/public/charitable-template-helpers.php - Raw: https://pluginprobe.com/plugins/charitable/1.8.13/raw/includes/public/charitable-template-helpers.php - Modified: 2026-10-01T09:58:52+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/charitable/1.8.13/code/includes/public/charitable-template-helpers.php#L10-L20`. ```php set_view_args( $args ); $template->render(); } return $template; } /** * When a session-reliant template is displayed without a session ID being * set, wrap the output in a wrapper that tells our client-side session * handler to fetch content via AJAX. * * @since 1.5.0 * * @param string|string[] $template_name A single template name or an ordered array of template. * @param mixed[] $args Array of arguments to pass to the view. * @param string $template_key A key representing the template, which will be passed * as one of the arguments in the AJAX request. * @param array $wrapper_args A mixed set of arguments that need to be passed along * in the AJAX request. * @param string $classname Template class name. Allows for extensions to use charitable_template(). * @return void Content is echoed. */ function charitable_template_from_session( $template_name, array $args, $template_key, $wrapper_args = array(), $classname = 'Charitable_Template' ) { ob_start(); charitable_template( $template_name, $args, $classname ); echo charitable_template_from_session_content( $template_key, $wrapper_args, ob_get_clean() ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Returns a piece of content or an empty string, wrapped in the correct markup * for on-demand session content retrieval. * * @since 1.5.0 * * @param string $template_key A key representing the template, which will be passed * as one of the arguments in the AJAX request. * @param array $wrapper_args A mixed set of arguments that need to be passed along * in the AJAX request. * @param string $default The default content to be displayed if no content is * returned from the AJAX request, or the user does not * have Javascript enabled. * @return string */ function charitable_template_from_session_content( $template_key, $wrapper_args = array(), $default = '' ) { /* When we have a session ID, we just print the default. */ if ( charitable_get_session()->has_session_id() ) { return $default; } $content = ''; $content .= ''; return $content; } /** * Return the template path if the template exists. Otherwise, return default. * * @since 1.0.0 * * @param string|string[] $template The template to load. * @param string $default The default to load if the template file doesn't exist. * @return string The template path if the template exists. Otherwise, return default. */ function charitable_get_template_path( $template, $default = '' ) { $t = new Charitable_Template( $template, false ); $path = $t->locate_template(); if ( ! file_exists( $path ) ) { $path = $default; } return $path; } /** * Insert a particular template into an array of templates. * * @since 1.5.0 * * @param string $template The template to be inserted. * @param array $templates The default set of templates. * @param int $index The position at which to insert the template. * @return array */ function charitable_splice_template( $template, $templates, $index = 1 ) { if ( empty( $template ) ) { return $templates; } array_splice( $templates, $index, 0, $template ); return $templates; } /** * Simple CSS compression. * * Removes all comments, removes spaces after colons and strips out all the whitespace. * * Based on http://manas.tungare.name/software/css-compression-in-php/ * * @since 1.2.0 * * @param string $css The block of CSS to be compressed. * @return string The compressed CSS */ function charitable_compress_css( $css ) { /* 1. Remove comments */ $css = preg_replace( '!/\*[^*]*\*+([^/][^*]*\*+)*/!', '', $css ); /* 2. Remove space after colons */ $css = str_replace( ': ', ':', $css ); /* 3. Remove whitespace */ $css = str_replace( array( "\r\n", "\r", "\n", "\t", ' ', ' ', ' ' ), '', $css ); return $css; } /** * Provides arguments passed to campaigns within the loop. * * @since 1.2.3 * * @param mixed[] $view_args Optional. If called by the shortcode, this will contain the arguments passed to the shortcode. * @return mixed[] */ function charitable_campaign_loop_args( $view_args = array() ) { $defaults = array( 'button' => 'donate', ); $args = wp_parse_args( $view_args, $defaults ); return apply_filters( 'charitable_campaign_loop_args', $args ); } /** * Provides arguments passed to campaigns within the loop. * * @since 1.5.7 * * @param mixed[] $view_args Optional. If called by the shortcode, this will contain the arguments passed to the shortcode. * @return mixed[] */ function charitable_campaign_loop_class( $view_args = array() ) { $classes = array( 'campaign-loop' ); if ( $view_args['columns'] > 1 ) { $classes = array_merge( $classes, array( 'campaign-grid campaign-grid-' . $view_args['columns'] ) ); if ( $view_args['masonry'] ) { $classes[] = 'masonry'; } } else { $classes[] = 'campaign-list'; } /** * Filter the classes to be applied to the campaign loop. * * @since 1.5.7 * * @param array $classes Array of classes. * @param array $view_args View args. */ $classes = apply_filters( 'charitable_campaign_loop_classes', $classes, $view_args ); return implode( ' ', $classes ); } /** * Processes arbitrary form attributes into HTML-safe key/value pairs * * @since 1.3.0 * * @param array $field Array defining the form field attributes. * @return string The formatted HTML-safe attributes. */ function charitable_get_arbitrary_attributes( $field ) { if ( ! isset( $field['attrs'] ) ) { $field['attrs'] = array(); } /* Add backwards compatibility support for placeholder, min, max, step, pattern, rows and required. */ foreach ( array( 'placeholder', 'min', 'max', 'step', 'pattern', 'rows', 'required' ) as $attr ) { /* Skip if the attribute is not defined in the field, or is explicitly set in the 'attrs' property. */ if ( ! array_key_exists( $attr, $field ) || array_key_exists( $attr, $field['attrs'] ) ) { continue; } if ( 'required' == $attr ) { /* Skip required attribute if it's not true. */ if ( ! $field['required'] ) { continue; } $field['attrs'][ $attr ] = 'required'; } else { $field['attrs'][ $attr ] = $field[ $attr ]; } } $output = ''; foreach ( $field['attrs'] as $key => $value ) { $escaped_value = esc_attr( $value ); $output .= " $key=\"$escaped_value\" "; } return apply_filters( 'charitable_arbitrary_field_attributes', $output ); } /** * Checks whether we are currently in the main loop on a singular page. * * This should be used in any functions run on the_content hook, to prevent * Charitable's filters touching other the_content instances outside the main * loop. * * @since 1.4.11 * @since 1.8.1 added 'charitable_is_main_loop' filter. * * @return boolean */ function charitable_is_main_loop() { $is_main_loop = is_single() && in_the_loop() && is_main_query(); return apply_filters( 'charitable_is_main_loop', $is_main_loop ); } /** * Re-encodes a raw query string so that every key and value is percent-encoded. * * The query string arrives from the request untrusted and unencoded. Rebuilding it * pair by pair guarantees the result contains no character that could break out of * the HTML attribute, JavaScript string or URL context it is later printed into -- * including HTML entities such as `'` that survive esc_url() and are decoded * back into a quote by the browser's HTML parser. * * Query strings are application/x-www-form-urlencoded, so urldecode()/urlencode() * is the correct pair here: it round-trips `+` as a space the way the request did. * * @since 1.8.13 * * @param string $query_string Raw query string, without the leading '?'. * @return string Re-encoded query string, or an empty string if nothing usable remains. */ function charitable_sanitize_query_string( $query_string ) { $pairs = array(); foreach ( explode( '&', (string) $query_string ) as $pair ) { if ( '' === $pair ) { continue; } $parts = explode( '=', $pair, 2 ); $key = urlencode( urldecode( $parts[0] ) ); if ( '' === $key ) { continue; } $pairs[] = isset( $parts[1] ) ? $key . '=' . urlencode( urldecode( $parts[1] ) ) : $key; } return implode( '&', $pairs ); } /** * Returns the current URL. * * @see https://gist.github.com/leereamsnyder/fac3b9ccb6b99ab14f36 * * @since 1.0.0 * @since 1.8.13 The path and query string are both percent-encoded instead of being * reflected raw, and the trailing slash is applied to the path rather * than to the end of the query string. * * @global WP $wp * @return string */ function charitable_get_current_url() { global $wp; $path = isset( $wp->request ) ? (string) $wp->request : ''; /* * The requested path is reflected here too, and WordPress hands it over exactly as * it arrived: any %XX escapes are already inert, but characters that arrived * literally are not. Encoding '&' closes off every HTML entity form at once * (', ', ', ", ...), which is what a URL escaper cannot do * because those entities are made of characters it considers legal; the quotes and * angle brackets cover the literal cases. Only these five are touched, so existing * %XX escapes and ordinary slugs pass through unchanged and the result is idempotent. */ $path = str_replace( array( '&', "'", '"', '<', '>' ), array( '%26', '%27', '%22', '%3C', '%3E' ), $path ); $url = trailingslashit( home_url( $path ) ); if ( empty( $_SERVER['QUERY_STRING'] ) ) { return $url; } $query_string = charitable_sanitize_query_string( wp_unslash( $_SERVER['QUERY_STRING'] ) ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized if ( '' === $query_string ) { return $url; } return $url . '?' . $query_string; } /** * Returns the URL to which the user should be redirected after signing on or registering an account. * * @since 1.0.0 * * @return string */ function charitable_get_login_redirect_url() { if ( isset( $_REQUEST['redirect_to'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended $redirect = $_REQUEST['redirect_to']; // phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.MissingUnslash,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized } elseif ( charitable_get_permalink( 'profile_page' ) ) { $redirect = charitable_get_permalink( 'profile_page' ); } else { $redirect = home_url(); } return apply_filters( 'charitable_signon_redirect_url', $redirect ); } /** * Displays a table. * * @since 1.5.0 * * @param array $columns The set of table columns. * @param array $data The data to display in the table. * @param array $args Optional set of extra arguments. * @return void */ function charitable_table_template( array $columns, array $data, $args = array() ) { $table = new Charitable_Table_Helper( $columns, $data, $args ); $table->render(); } /** * Return the email verification link. * * @since 1.5.0 * @since 1.6.32 Added $force_send argument. * * @param WP_User $user An instance of `WP_User`. * @param string|false $redirect_url The URL to redirect to after verification. * @param boolean $force_send Whether the link should include an argument to force * resending the email, even if it was sent recently. * @return string */ function charitable_get_email_verification_link( WP_User $user, $redirect_url = false, $force_send = false ) { return add_query_arg( array( 'charitable_action' => 'verify_email', 'user' => $user->ID, 'redirect_url' => $redirect_url, 'force_send' => (int) $force_send, ) ); } /** * Get the button classes for a Charitable button. * * @since 1.6.29 * @version 1.8.3.6 Added $disabled parameter. * * @param string $button Which button we're showing. * @return string */ function charitable_get_button_class( $button, $disabled = false ) { $classes = [ 'button', 'charitable-button' ]; switch ( $button ) { case 'donate': $classes[] = 'donate-button'; $classes[] = 'button-primary'; break; default: $classes[] = $button . '-button'; } if ( $disabled ) { $classes[] = 'charitable-disabled'; } /** * Filter the button classes. * * @since 1.6.29 * * @param array $classes The button classes. * @param string $button The specific button we're showing. */ $classes = apply_filters( 'charitable_button_class', $classes, $button ); return implode( ' ', $classes ); } /** * Get a unique donation form ID. * * @since 1.6.57 * * @return string */ function charitable_get_donation_form_id() { static $form_number; if ( ! isset( $form_number ) ) { $form_id = 'charitable-donation-form'; $form_number = 1; } else { $form_id = 'charitable-donation-form-' . $form_number; $form_number += 1; } // $form_number = ; return $form_id; } ```