<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Generic helper functions.

[2] Fix | Delete

*

[3] Fix | Delete

* @since 1.8.0

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

use WPForms\Helpers\Chain;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Get a suffix for assets, `.min` if debug is disabled.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 1.4.1

[12] Fix | Delete

*

[13] Fix | Delete

* @return string

[14] Fix | Delete

*/

[15] Fix | Delete

function wpforms_get_min_suffix() {

[16] Fix | Delete

[17] Fix | Delete

return wpforms_debug() ? '' : '.min';

[18] Fix | Delete

}

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Chain monad, useful for chaining certain array or string related functions.

[22] Fix | Delete

*

[23] Fix | Delete

* @since 1.5.6

[24] Fix | Delete

*

[25] Fix | Delete

* @param mixed $value Any data.

[26] Fix | Delete

*

[27] Fix | Delete

* @return Chain

[28] Fix | Delete

*/

[29] Fix | Delete

function wpforms_chain( $value ) {

[30] Fix | Delete

[31] Fix | Delete

return Chain::of( $value );

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Convert object to an array.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 1.1.7

[38] Fix | Delete

*

[39] Fix | Delete

* @param object $object Object to convert.

[40] Fix | Delete

*

[41] Fix | Delete

* @return mixed

[42] Fix | Delete

*/

[43] Fix | Delete

function wpforms_object_to_array( $object ) {

[44] Fix | Delete

[45] Fix | Delete

if ( ! is_object( $object ) && ! is_array( $object ) ) {

[46] Fix | Delete

return $object;

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

if ( is_object( $object ) ) {

[50] Fix | Delete

$object = get_object_vars( $object );

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

return array_map( 'wpforms_object_to_array', $object );

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Insert an array into another array before/after a certain key.

[58] Fix | Delete

*

[59] Fix | Delete

* @link https://gist.github.com/scribu/588429

[60] Fix | Delete

*

[61] Fix | Delete

* @since 1.3.9

[62] Fix | Delete

*

[63] Fix | Delete

* @param array $array The initial array.

[64] Fix | Delete

* @param array $pairs The array to insert.

[65] Fix | Delete

* @param string $key The certain key.

[66] Fix | Delete

* @param string $position Where to insert the array - before or after the key.

[67] Fix | Delete

*

[68] Fix | Delete

* @return array

[69] Fix | Delete

*/

[70] Fix | Delete

function wpforms_array_insert( $array, $pairs, $key, $position = 'after' ) {

[71] Fix | Delete

[72] Fix | Delete

$key_pos = array_search( $key, array_keys( $array ), true );

[73] Fix | Delete

[74] Fix | Delete

if ( $position === 'after' ) {

[75] Fix | Delete

$key_pos ++;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

if ( $key_pos !== false ) {

[79] Fix | Delete

$result = array_slice( $array, 0, $key_pos );

[80] Fix | Delete

$result = array_merge( $result, $pairs );

[81] Fix | Delete

$result = array_merge( $result, array_slice( $array, $key_pos ) );

[82] Fix | Delete

} else {

[83] Fix | Delete

$result = array_merge( $array, $pairs );

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

return $result;

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Recursively remove empty strings from an array.

[91] Fix | Delete

*

[92] Fix | Delete

* @since 1.3.9.1

[93] Fix | Delete

*

[94] Fix | Delete

* @param array $data Any data.

[95] Fix | Delete

*

[96] Fix | Delete

* @return array

[97] Fix | Delete

*/

[98] Fix | Delete

function wpforms_array_remove_empty_strings( $data ) {

[99] Fix | Delete

[100] Fix | Delete

foreach ( $data as $key => $value ) {

[101] Fix | Delete

if ( is_array( $value ) ) {

[102] Fix | Delete

$data[ $key ] = wpforms_array_remove_empty_strings( $data[ $key ] );

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

if ( $data[ $key ] === '' ) {

[106] Fix | Delete

unset( $data[ $key ] );

[107] Fix | Delete

}

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

return $data;

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Count words in the string.

[115] Fix | Delete

*

[116] Fix | Delete

* @since 1.6.2

[117] Fix | Delete

*

[118] Fix | Delete

* @param string $string String value.

[119] Fix | Delete

*

[120] Fix | Delete

* @return integer Words count.

[121] Fix | Delete

*/

[122] Fix | Delete

function wpforms_count_words( $string ) {

[123] Fix | Delete

[124] Fix | Delete

if ( ! is_string( $string ) ) {

[125] Fix | Delete

return 0;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

$patterns = [

[129] Fix | Delete

'/([A-Z]+),([A-Z]+)/i',

[130] Fix | Delete

'/([0-9]+),([A-Z]+)/i',

[131] Fix | Delete

'/([A-Z]+),([0-9]+)/i',

[132] Fix | Delete

];

[133] Fix | Delete

[134] Fix | Delete

foreach ( $patterns as $pattern ) {

[135] Fix | Delete

$string = preg_replace_callback(

[136] Fix | Delete

$pattern,

[137] Fix | Delete

function( $matches ) {

[138] Fix | Delete

return $matches[1] . ', ' . $matches[2];

[139] Fix | Delete

},

[140] Fix | Delete

$string

[141] Fix | Delete

);

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

$words = preg_split( '/[\s]+/', $string );

[145] Fix | Delete

[146] Fix | Delete

return is_array( $words ) ? count( $words ) : 0;

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* Link a list of words or phrases with commas, but the last one – with a conjunction.

[151] Fix | Delete

*

[152] Fix | Delete

* For example:

[153] Fix | Delete

* [ 'Sullie', 'Pattie', 'me' ] with 'and' conjunction becomes 'Sullie, Pattie and me'.

[154] Fix | Delete

* [ 'Sullie', 'Pattie', 'me' ] with 'or' conjunction becomes 'Sullie, Pattie or me'.

[155] Fix | Delete

*

[156] Fix | Delete

* @since 1.8.0

[157] Fix | Delete

*

[158] Fix | Delete

* @param array $list A list of words or phrases to link together.

[159] Fix | Delete

* @param string $conjunction Coordinating conjunction to use for last word or phrase (usually – and, or).

[160] Fix | Delete

* The string is expected to be translatable.

[161] Fix | Delete

*

[162] Fix | Delete

* @return string Linked words and/or phrases.

[163] Fix | Delete

*/

[164] Fix | Delete

function wpforms_conjunct( $list, $conjunction ) {

[165] Fix | Delete

[166] Fix | Delete

$last_chunk = array_pop( $list );

[167] Fix | Delete

[168] Fix | Delete

return $list ?

[169] Fix | Delete

sprintf( '%s %s %s', implode( ', ', $list ), $conjunction, $last_chunk ) :

[170] Fix | Delete

$last_chunk;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Get the current URL.

[175] Fix | Delete

*

[176] Fix | Delete

* @since 1.0.0

[177] Fix | Delete

* @since 1.7.2 Refactored based on the `home_url` function.

[178] Fix | Delete

*

[179] Fix | Delete

* @return string

[180] Fix | Delete

*/

[181] Fix | Delete

function wpforms_current_url() {

[182] Fix | Delete

[183] Fix | Delete

$parsed_home_url = wp_parse_url( home_url() );

[184] Fix | Delete

[185] Fix | Delete

$url = $parsed_home_url['scheme'] . '://' . $parsed_home_url['host'];

[186] Fix | Delete

[187] Fix | Delete

if ( ! empty( $parsed_home_url['port'] ) ) {

[188] Fix | Delete

$url .= ':' . $parsed_home_url['port'];

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized

[192] Fix | Delete

$url .= wp_unslash( $_SERVER['REQUEST_URI'] );

[193] Fix | Delete

[194] Fix | Delete

return esc_url_raw( $url );

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

/**

[198] Fix | Delete

* Add UTM tags to a link that allows detecting traffic sources for our or partners' websites.

[199] Fix | Delete

*

[200] Fix | Delete

* @since 1.7.5

[201] Fix | Delete

*

[202] Fix | Delete

* @param string $link Link to which you need to add UTM tags.

[203] Fix | Delete

* @param string $medium The page or location description. Check your current page and try to find

[204] Fix | Delete

* and use an already existing medium for links otherwise, use a page name.

[205] Fix | Delete

* @param string $content The feature's name, the button's content, the link's text, or something

[206] Fix | Delete

* else that describes the element that contains the link.

[207] Fix | Delete

* @param string $term Additional information for the content that makes the link more unique.

[208] Fix | Delete

*

[209] Fix | Delete

* @return string

[210] Fix | Delete

*/

[211] Fix | Delete

function wpforms_utm_link( $link, $medium, $content = '', $term = '' ) {

[212] Fix | Delete

[213] Fix | Delete

return add_query_arg(

[214] Fix | Delete

array_filter(

[215] Fix | Delete

[

[216] Fix | Delete

'utm_campaign' => wpforms_is_pro() ? 'plugin' : 'liteplugin',

[217] Fix | Delete

'utm_source' => strpos( $link, 'https://wpforms.com' ) === 0 ? 'WordPress' : 'wpformsplugin',

[218] Fix | Delete

'utm_medium' => rawurlencode( $medium ),

[219] Fix | Delete

'utm_content' => rawurlencode( $content ),

[220] Fix | Delete

'utm_term' => rawurlencode( $term ),

[221] Fix | Delete

'utm_locale' => wpforms_sanitize_key( get_locale() ),

[222] Fix | Delete

]

[223] Fix | Delete

),

[224] Fix | Delete

$link

[225] Fix | Delete

);

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Check if it is a Pro version of the plugin.

[230] Fix | Delete

* This function be used on very early stage of WPForms loading, to check the requirements.

[231] Fix | Delete

* At requirements' check, the wpforms() function is not defined.

[232] Fix | Delete

*

[233] Fix | Delete

* @since 1.9.6

[234] Fix | Delete

*

[235] Fix | Delete

* @return bool

[236] Fix | Delete

*/

[237] Fix | Delete

function wpforms_is_pro(): bool {

[238] Fix | Delete

[239] Fix | Delete

if ( function_exists( 'wpforms' ) ) {

[240] Fix | Delete

return wpforms()->is_pro();

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

// This filter is documented in \WPForms\WPForms::is_pro.

[244] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[245] Fix | Delete

return apply_filters( 'wpforms_allow_pro_version', file_exists( WPFORMS_PLUGIN_DIR . 'pro/wpforms-pro.php' ) );

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

/**

[249] Fix | Delete

* Modify the default USer-Agent generated by wp_remote_*() to include additional information.

[250] Fix | Delete

*

[251] Fix | Delete

* @since 1.7.5.2

[252] Fix | Delete

*

[253] Fix | Delete

* @return string

[254] Fix | Delete

*/

[255] Fix | Delete

function wpforms_get_default_user_agent() {

[256] Fix | Delete

[257] Fix | Delete

$license_type = wpforms()->is_pro() ? ucwords( (string) wpforms_get_license_type() ) : 'Lite';

[258] Fix | Delete

[259] Fix | Delete

return 'WordPress/' . get_bloginfo( 'version' ) . '; ' . get_bloginfo( 'url' ) . '; WPForms/' . $license_type . '-' . WPFORMS_VERSION;

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

/**

[263] Fix | Delete

* Get the ISO 639-2 Language Code from user/site locale.

[264] Fix | Delete

*

[265] Fix | Delete

* @see http://www.loc.gov/standards/iso639-2/php/code_list.php

[266] Fix | Delete

*

[267] Fix | Delete

* @since 1.5.0

[268] Fix | Delete

*

[269] Fix | Delete

* @return string

[270] Fix | Delete

*/

[271] Fix | Delete

function wpforms_get_language_code() {

[272] Fix | Delete

[273] Fix | Delete

$default_lang = 'en';

[274] Fix | Delete

$locale = get_user_locale();

[275] Fix | Delete

[276] Fix | Delete

if ( ! empty( $locale ) ) {

[277] Fix | Delete

$lang = explode( '_', $locale );

[278] Fix | Delete

[279] Fix | Delete

if ( ! empty( $lang ) && is_array( $lang ) ) {

[280] Fix | Delete

$default_lang = strtolower( $lang[0] );

[281] Fix | Delete

}

[282] Fix | Delete

}

[283] Fix | Delete

[284] Fix | Delete

return $default_lang;

[285] Fix | Delete

}

[286] Fix | Delete

[287] Fix | Delete

/**

[288] Fix | Delete

* Changes array of items into string of items, separated by comma and sql-escaped.

[289] Fix | Delete

*

[290] Fix | Delete

* @see https://coderwall.com/p/zepnaw

[291] Fix | Delete

*

[292] Fix | Delete

* @since 1.7.4

[293] Fix | Delete

*

[294] Fix | Delete

* @param mixed|array $items Item(s) to be joined into string.

[295] Fix | Delete

* @param string $format Can be %s or %d.

[296] Fix | Delete

*

[297] Fix | Delete

* @return string Items separated by comma and sql-escaped.

[298] Fix | Delete

*/

[299] Fix | Delete

function wpforms_wpdb_prepare_in( $items, $format = '%s' ) {

[300] Fix | Delete

[301] Fix | Delete

global $wpdb;

[302] Fix | Delete

[303] Fix | Delete

$items = (array) $items;

[304] Fix | Delete

$how_many = count( $items );

[305] Fix | Delete

[306] Fix | Delete

if ( $how_many === 0 ) {

[307] Fix | Delete

return '';

[308] Fix | Delete

}

[309] Fix | Delete

[310] Fix | Delete

$placeholders = array_fill( 0, $how_many, $format );

[311] Fix | Delete

$prepared_format = implode( ',', $placeholders );

[312] Fix | Delete

[313] Fix | Delete

// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

[314] Fix | Delete

return $wpdb->prepare( $prepared_format, $items );

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

/**

[318] Fix | Delete

* Get the render engine slug according to the Modern Markup setting value and corresponding filter.

[319] Fix | Delete

*

[320] Fix | Delete

* @since 1.8.1

[321] Fix | Delete

*

[322] Fix | Delete

* @return string

[323] Fix | Delete

*/

[324] Fix | Delete

function wpforms_get_render_engine() {

[325] Fix | Delete

[326] Fix | Delete

$render_engine = empty( wpforms_setting( 'modern-markup', false ) ) ? 'classic' : 'modern';

[327] Fix | Delete

[328] Fix | Delete

/**

[329] Fix | Delete

* Filter current render engine slug.

[330] Fix | Delete

* Allows addons to use their own frontend rendering engine.

[331] Fix | Delete

*

[332] Fix | Delete

* @since 1.8.1

[333] Fix | Delete

*

[334] Fix | Delete

* @param string $render_engine Render engine slug.

[335] Fix | Delete

*/

[336] Fix | Delete

$render_engine = apply_filters( 'wpforms_get_render_engine', $render_engine );

[337] Fix | Delete

[338] Fix | Delete

return $render_engine;

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

/**

[342] Fix | Delete

* Get comma-separated list string from an array.

[343] Fix | Delete

*

[344] Fix | Delete

* @since 1.9.0

[345] Fix | Delete

*

[346] Fix | Delete

* @param array $arr Array containing a list.

[347] Fix | Delete

* @param bool $sep Separator of the last element.

[348] Fix | Delete

*

[349] Fix | Delete

* @return string

[350] Fix | Delete

*/

[351] Fix | Delete

function wpforms_list_array( array $arr, bool $sep = true ): string {

[352] Fix | Delete

[353] Fix | Delete

$separator = $sep ?

[354] Fix | Delete

__( 'and', 'wpforms-lite' ) :

[355] Fix | Delete

__( 'or', 'wpforms-lite' );

[356] Fix | Delete

[357] Fix | Delete

$last = array_slice( $arr, - 1 );

[358] Fix | Delete

$first = implode( ', ', array_slice( $arr, 0, - 1 ) );

[359] Fix | Delete

$both = array_filter( array_merge( [ $first ], $last ) );

[360] Fix | Delete

[361] Fix | Delete

return implode( ' ' . $separator . ' ', $both );

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete