<?php

[0] Fix | Delete

[1] Fix | Delete

// phpcs:disable Generic.Commenting.DocComment.MissingShort

[2] Fix | Delete

/** @noinspection PhpUnnecessaryCurlyVarSyntaxInspection */

[3] Fix | Delete

// phpcs:enable Generic.Commenting.DocComment.MissingShort

[4] Fix | Delete

[5] Fix | Delete

namespace WPForms\Forms;

[6] Fix | Delete

[7] Fix | Delete

use WP_Post;

[8] Fix | Delete

use WPForms\Tasks\Actions\FormsLocatorScanTask;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Class Locator.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.7.4

[14] Fix | Delete

*/

[15] Fix | Delete

class Locator {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Column name on Forms Overview admin page.

[19] Fix | Delete

*

[20] Fix | Delete

* @since 1.7.4

[21] Fix | Delete

*/

[22] Fix | Delete

const COLUMN_NAME = 'locations';

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Locations meta key.

[26] Fix | Delete

*

[27] Fix | Delete

* @since 1.7.4

[28] Fix | Delete

*/

[29] Fix | Delete

const LOCATIONS_META = 'wpforms_form_locations';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* WPForms widget name.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 1.7.4

[35] Fix | Delete

*/

[36] Fix | Delete

const WPFORMS_WIDGET_NAME = 'wpforms-widget';

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* WPForms widget prefix.

[40] Fix | Delete

*

[41] Fix | Delete

* @since 1.7.4

[42] Fix | Delete

*/

[43] Fix | Delete

const WPFORMS_WIDGET_PREFIX = self::WPFORMS_WIDGET_NAME . '-';

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* WPForms widgets option name.

[47] Fix | Delete

*

[48] Fix | Delete

* @since 1.7.4

[49] Fix | Delete

*/

[50] Fix | Delete

const WPFORMS_WIDGET_OPTION = 'widget_' . self::WPFORMS_WIDGET_NAME;

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* Text widget name.

[54] Fix | Delete

*

[55] Fix | Delete

* @since 1.7.4

[56] Fix | Delete

*/

[57] Fix | Delete

const TEXT_WIDGET_NAME = 'text';

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Text widget prefix.

[61] Fix | Delete

*

[62] Fix | Delete

* @since 1.7.4

[63] Fix | Delete

*/

[64] Fix | Delete

const TEXT_WIDGET_PREFIX = self::TEXT_WIDGET_NAME . '-';

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Text widgets option name.

[68] Fix | Delete

*

[69] Fix | Delete

* @since 1.7.4

[70] Fix | Delete

*/

[71] Fix | Delete

const TEXT_WIDGET_OPTION = 'widget_' . self::TEXT_WIDGET_NAME;

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Block widget name.

[75] Fix | Delete

*

[76] Fix | Delete

* @since 1.7.4

[77] Fix | Delete

*/

[78] Fix | Delete

const BLOCK_WIDGET_NAME = 'block';

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Block widget prefix.

[82] Fix | Delete

*

[83] Fix | Delete

* @since 1.7.4

[84] Fix | Delete

*/

[85] Fix | Delete

const BLOCK_WIDGET_PREFIX = self::BLOCK_WIDGET_NAME . '-';

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Block widgets' option name.

[89] Fix | Delete

*

[90] Fix | Delete

* @since 1.7.4

[91] Fix | Delete

*/

[92] Fix | Delete

const BLOCK_WIDGET_OPTION = 'widget_' . self::BLOCK_WIDGET_NAME;

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Location type for widget.

[96] Fix | Delete

* For a page/post, the location type is the post type.

[97] Fix | Delete

*

[98] Fix | Delete

* @since 1.7.4

[99] Fix | Delete

*/

[100] Fix | Delete

const WIDGET = 'widget';

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* WP template post type.

[104] Fix | Delete

*

[105] Fix | Delete

* @since 1.7.4

[106] Fix | Delete

*/

[107] Fix | Delete

const WP_TEMPLATE = 'wp_template';

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* WP template post type.

[111] Fix | Delete

*

[112] Fix | Delete

* @since 1.7.4.1

[113] Fix | Delete

*/

[114] Fix | Delete

const WP_TEMPLATE_PART = 'wp_template_part';

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Standalone location types.

[118] Fix | Delete

*

[119] Fix | Delete

* @since 1.8.7

[120] Fix | Delete

*/

[121] Fix | Delete

const STANDALONE_LOCATION_TYPES = [ 'form_pages', 'conversational_forms' ];

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Default title for WPForms widget.

[125] Fix | Delete

* For WPForms widget, we extract title from the widget. If it is empty, we use the default one.

[126] Fix | Delete

*

[127] Fix | Delete

* @since 1.7.4

[128] Fix | Delete

*

[129] Fix | Delete

* @var string

[130] Fix | Delete

*/

[131] Fix | Delete

private $wpforms_widget_title = '';

[132] Fix | Delete

[133] Fix | Delete

/**

[134] Fix | Delete

* Default title for text widget.

[135] Fix | Delete

* For text widget, we extract title from the widget. If it is empty, we use the default one.

[136] Fix | Delete

*

[137] Fix | Delete

* @since 1.7.4

[138] Fix | Delete

*

[139] Fix | Delete

* @var string

[140] Fix | Delete

*/

[141] Fix | Delete

private $text_widget_title = '';

[142] Fix | Delete

[143] Fix | Delete

/**

[144] Fix | Delete

* Fixed title for block widget.

[145] Fix | Delete

*

[146] Fix | Delete

* @since 1.7.4

[147] Fix | Delete

*

[148] Fix | Delete

* @var string

[149] Fix | Delete

*/

[150] Fix | Delete

private $block_widget_title = '';

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Home url.

[154] Fix | Delete

*

[155] Fix | Delete

* @since 1.7.4

[156] Fix | Delete

*

[157] Fix | Delete

* @var string

[158] Fix | Delete

*/

[159] Fix | Delete

private $home_url;

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* Scan status.

[163] Fix | Delete

*

[164] Fix | Delete

* @since 1.7.4

[165] Fix | Delete

*

[166] Fix | Delete

* @var string

[167] Fix | Delete

*/

[168] Fix | Delete

private $scan_status;

[169] Fix | Delete

[170] Fix | Delete

/**

[171] Fix | Delete

* Init class.

[172] Fix | Delete

*

[173] Fix | Delete

* @since 1.7.4

[174] Fix | Delete

*/

[175] Fix | Delete

public function init() {

[176] Fix | Delete

[177] Fix | Delete

$this->home_url = home_url();

[178] Fix | Delete

$this->scan_status = (string) get_option( FormsLocatorScanTask::SCAN_STATUS );

[179] Fix | Delete

[180] Fix | Delete

$this->wpforms_widget_title = __( 'WPForms Widget', 'wpforms-lite' );

[181] Fix | Delete

$this->text_widget_title = __( 'Text Widget', 'wpforms-lite' );

[182] Fix | Delete

$this->block_widget_title = __( 'Block Widget', 'wpforms-lite' );

[183] Fix | Delete

[184] Fix | Delete

$this->hooks();

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Register hooks.

[189] Fix | Delete

*

[190] Fix | Delete

* @since 1.7.4

[191] Fix | Delete

*/

[192] Fix | Delete

private function hooks() {

[193] Fix | Delete

[194] Fix | Delete

// View hooks.

[195] Fix | Delete

add_filter( 'wpforms_admin_forms_table_facades_columns_data', [ $this, 'add_column_data' ] );

[196] Fix | Delete

add_filter( 'wpforms_overview_table_column_value', [ $this, 'column_value' ], 10, 3 );

[197] Fix | Delete

add_filter( 'wpforms_overview_row_actions', [ $this, 'row_actions_all' ], 10, 2 );

[198] Fix | Delete

add_action( 'wpforms_overview_enqueue', [ $this, 'localize_overview_script' ] );

[199] Fix | Delete

[200] Fix | Delete

// Monitoring hooks.

[201] Fix | Delete

add_action( 'save_post', [ $this, 'save_post' ], 10, 3 );

[202] Fix | Delete

add_action( 'post_updated', [ $this, 'post_updated' ], 10, 3 );

[203] Fix | Delete

add_action( 'wp_trash_post', [ $this, 'trash_post' ] );

[204] Fix | Delete

add_action( 'untrash_post', [ $this, 'untrash_post' ] );

[205] Fix | Delete

add_action( 'delete_post', [ $this, 'trash_post' ] );

[206] Fix | Delete

add_action( 'permalink_structure_changed', [ $this, 'permalink_structure_changed' ], 10, 2 );

[207] Fix | Delete

[208] Fix | Delete

$wpforms_widget_option = self::WPFORMS_WIDGET_OPTION;

[209] Fix | Delete

$text_widget_option = self::TEXT_WIDGET_OPTION;

[210] Fix | Delete

$block_widget_option = self::BLOCK_WIDGET_OPTION;

[211] Fix | Delete

[212] Fix | Delete

add_action( "update_option_{$wpforms_widget_option}" , [ $this, 'update_option' ], 10, 3 );

[213] Fix | Delete

add_action( "update_option_{$text_widget_option}" , [ $this, 'update_option' ], 10, 3 );

[214] Fix | Delete

add_action( "update_option_{$block_widget_option}", [ $this, 'update_option' ], 10, 3 );

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

/**

[218] Fix | Delete

* Add locations' column to the table columns data.

[219] Fix | Delete

*

[220] Fix | Delete

* @since 1.8.6

[221] Fix | Delete

*

[222] Fix | Delete

* @param array|mixed $columns Columns data.

[223] Fix | Delete

*

[224] Fix | Delete

* @return array

[225] Fix | Delete

*/

[226] Fix | Delete

public function add_column_data( $columns ): array {

[227] Fix | Delete

[228] Fix | Delete

$columns = (array) $columns;

[229] Fix | Delete

$columns[ self::COLUMN_NAME ] = [

[230] Fix | Delete

'label' => esc_html__( 'Locations', 'wpforms-lite' ),

[231] Fix | Delete

'label_html' => sprintf(

[232] Fix | Delete

'<span class="wpforms-locations-column-title">%1$s</span>' .

[233] Fix | Delete

'<span class="wpforms-locations-column-icon" title="%2$s"></span>',

[234] Fix | Delete

esc_html__( 'Locations', 'wpforms-lite' ),

[235] Fix | Delete

esc_html__( 'Form locations', 'wpforms-lite' )

[236] Fix | Delete

),

[237] Fix | Delete

];

[238] Fix | Delete

[239] Fix | Delete

return $columns;

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

/**

[243] Fix | Delete

* Display column value.

[244] Fix | Delete

*

[245] Fix | Delete

* @since 1.7.4

[246] Fix | Delete

*

[247] Fix | Delete

* @param mixed $value Column value.

[248] Fix | Delete

* @param WP_Post $form Form.

[249] Fix | Delete

* @param string $column_name Column name.

[250] Fix | Delete

*

[251] Fix | Delete

* @return mixed

[252] Fix | Delete

*/

[253] Fix | Delete

public function column_value( $value, $form, $column_name ) {

[254] Fix | Delete

[255] Fix | Delete

if ( $column_name !== self::COLUMN_NAME ) {

[256] Fix | Delete

return $value;

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

$form_locations = get_post_meta( $form->ID, self::LOCATIONS_META, true );

[260] Fix | Delete

[261] Fix | Delete

if ( $form_locations === '' ) {

[262] Fix | Delete

$empty_values = [

[263] Fix | Delete

'' => '—',

[264] Fix | Delete

FormsLocatorScanTask::SCAN_STATUS_IN_PROGRESS => '...',

[265] Fix | Delete

FormsLocatorScanTask::SCAN_STATUS_COMPLETED => '0',

[266] Fix | Delete

];

[267] Fix | Delete

[268] Fix | Delete

return $empty_values[ $this->scan_status ];

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

$values = $this->get_location_rows( $form_locations );

[272] Fix | Delete

[273] Fix | Delete

if ( ! $values ) {

[274] Fix | Delete

return '0';

[275] Fix | Delete

}

[276] Fix | Delete

[277] Fix | Delete

$column_value = sprintf(

[278] Fix | Delete

'<span class="wpforms-locations-count"><a href="#" title="%s">%d</a></span>',

[279] Fix | Delete

esc_attr__( 'View form locations', 'wpforms-lite' ),

[280] Fix | Delete

count( $values )

[281] Fix | Delete

);

[282] Fix | Delete

[283] Fix | Delete

$column_value .= '<p class="locations-list">' . implode( '', $values ) . '</p>';

[284] Fix | Delete

[285] Fix | Delete

return $column_value;

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

/**

[289] Fix | Delete

* Row actions for view "All".

[290] Fix | Delete

*

[291] Fix | Delete

* @since 1.7.4

[292] Fix | Delete

*

[293] Fix | Delete

* @param array $row_actions Row actions.

[294] Fix | Delete

* @param WP_Post $form Form object.

[295] Fix | Delete

*

[296] Fix | Delete

* @return array

[297] Fix | Delete

*/

[298] Fix | Delete

public function row_actions_all( $row_actions, $form ) {

[299] Fix | Delete

[300] Fix | Delete

$form_locations = get_post_meta( $form->ID, self::LOCATIONS_META, true );

[301] Fix | Delete

[302] Fix | Delete

if ( ! $form_locations ) {

[303] Fix | Delete

return $row_actions;

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

$locations = [

[307] Fix | Delete

'locations' => sprintf(

[308] Fix | Delete

'<a href="#" title="%s">%s</a>',

[309] Fix | Delete

esc_attr__( 'View form locations', 'wpforms-lite' ),

[310] Fix | Delete

esc_html__( 'Locations', 'wpforms-lite' )

[311] Fix | Delete

),

[312] Fix | Delete

];

[313] Fix | Delete

[314] Fix | Delete

// Insert Locations action before the first available position in the positions' list or at the end of $row_actions.

[315] Fix | Delete

$positions = [

[316] Fix | Delete

'preview_',

[317] Fix | Delete

'duplicate',

[318] Fix | Delete

'trash',

[319] Fix | Delete

];

[320] Fix | Delete

[321] Fix | Delete

$keys = array_keys( $row_actions );

[322] Fix | Delete

[323] Fix | Delete

foreach ( $positions as $position ) {

[324] Fix | Delete

$pos = array_search( $position, $keys, true );

[325] Fix | Delete

[326] Fix | Delete

if ( $pos !== false ) {

[327] Fix | Delete

break;

[328] Fix | Delete

}

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

$pos = $pos === false ? count( $row_actions ) : $pos;

[332] Fix | Delete

[333] Fix | Delete

return array_slice( $row_actions, 0, $pos ) + $locations + array_slice( $row_actions, $pos );

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

/**

[337] Fix | Delete

* Localize the overview script to pass translation strings.

[338] Fix | Delete

*

[339] Fix | Delete

* @since 1.7.4

[340] Fix | Delete

*/

[341] Fix | Delete

public function localize_overview_script() {

[342] Fix | Delete

[343] Fix | Delete

wp_localize_script(

[344] Fix | Delete

'wpforms-admin-forms-overview',

[345] Fix | Delete

'wpforms_forms_locator',

[346] Fix | Delete

[

[347] Fix | Delete

'paneTitle' => __( 'Form Locations', 'wpforms-lite' ),

[348] Fix | Delete

'close' => __( 'Close', 'wpforms-lite' ),

[349] Fix | Delete

]

[350] Fix | Delete

);

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

/**

[354] Fix | Delete

* Get id of the sidebar where the widget is positioned.

[355] Fix | Delete

*

[356] Fix | Delete

* @since 1.7.4

[357] Fix | Delete

*

[358] Fix | Delete

* @param string $widget_id Widget id.

[359] Fix | Delete

*

[360] Fix | Delete

* @return string

[361] Fix | Delete

*/

[362] Fix | Delete

private function get_widget_sidebar_id( $widget_id ) {

[363] Fix | Delete

[364] Fix | Delete

$sidebars_widgets = wp_get_sidebars_widgets();

[365] Fix | Delete

[366] Fix | Delete

foreach ( $sidebars_widgets as $sidebar_id => $sidebar_widgets ) {

[367] Fix | Delete

foreach ( $sidebar_widgets as $sidebar_widget ) {

[368] Fix | Delete

if ( $widget_id === $sidebar_widget ) {

[369] Fix | Delete

return (string) $sidebar_id;

[370] Fix | Delete

}

[371] Fix | Delete

}

[372] Fix | Delete

}

[373] Fix | Delete

[374] Fix | Delete

return '';

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

/**

[378] Fix | Delete

* Get the name of the sidebar where the widget is positioned.

[379] Fix | Delete

*

[380] Fix | Delete

* @since 1.7.4

[381] Fix | Delete

*

[382] Fix | Delete

* @param string $widget_id Widget id.

[383] Fix | Delete

*

[384] Fix | Delete

* @return string

[385] Fix | Delete

*/

[386] Fix | Delete

private function get_widget_sidebar_name( $widget_id ) {

[387] Fix | Delete

[388] Fix | Delete

$sidebar_id = $this->get_widget_sidebar_id( $widget_id );

[389] Fix | Delete

[390] Fix | Delete

if ( ! $sidebar_id ) {

[391] Fix | Delete

return '';

[392] Fix | Delete

}

[393] Fix | Delete

[394] Fix | Delete

$sidebar = $this->get_sidebar( $sidebar_id );

[395] Fix | Delete

[396] Fix | Delete

return isset( $sidebar['name'] ) ? (string) $sidebar['name'] : '';

[397] Fix | Delete

}

[398] Fix | Delete

[399] Fix | Delete

/**

[400] Fix | Delete

* Retrieves the registered sidebar with the given ID.

[401] Fix | Delete

*

[402] Fix | Delete

* @since 1.7.4

[403] Fix | Delete

*

[404] Fix | Delete

* @global array $wp_registered_sidebars The registered sidebars.

[405] Fix | Delete

*

[406] Fix | Delete

* @param string $id The sidebar ID.

[407] Fix | Delete

*

[408] Fix | Delete

* @return array|null The discovered sidebar, or null if it is not registered.

[409] Fix | Delete

*/

[410] Fix | Delete

private function get_sidebar( $id ) {

[411] Fix | Delete

[412] Fix | Delete

if ( function_exists( 'wp_get_sidebar' ) ) {

[413] Fix | Delete

return wp_get_sidebar( $id );

[414] Fix | Delete

}

[415] Fix | Delete

[416] Fix | Delete

global $wp_registered_sidebars;

[417] Fix | Delete

[418] Fix | Delete

if ( ! $wp_registered_sidebars ) {

[419] Fix | Delete

return null;

[420] Fix | Delete

}

[421] Fix | Delete

[422] Fix | Delete

foreach ( $wp_registered_sidebars as $sidebar ) {

[423] Fix | Delete

if ( $sidebar['id'] === $id ) {

[424] Fix | Delete

return $sidebar;

[425] Fix | Delete

}

[426] Fix | Delete

}

[427] Fix | Delete

[428] Fix | Delete

if ( $id === 'wp_inactive_widgets' ) {

[429] Fix | Delete

return [

[430] Fix | Delete

'id' => 'wp_inactive_widgets',

[431] Fix | Delete

'name' => __( 'Inactive widgets', 'wpforms-lite' ),

[432] Fix | Delete

];

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

return null;

[436] Fix | Delete

}

[437] Fix | Delete

[438] Fix | Delete

/**

[439] Fix | Delete

* Get post location title.

[440] Fix | Delete

*

[441] Fix | Delete

* @since 1.7.4

[442] Fix | Delete

*

[443] Fix | Delete

* @param array $form_location Form location.

[444] Fix | Delete

*

[445] Fix | Delete

* @return string

[446] Fix | Delete

*/

[447] Fix | Delete

private function get_post_location_title( $form_location ) {

[448] Fix | Delete

[449] Fix | Delete

$title = $form_location['title'];

[450] Fix | Delete

[451] Fix | Delete

if ( $this->is_wp_template( $form_location['type'] ) ) {

[452] Fix | Delete

return __( 'Site editor template', 'wpforms-lite' ) . ': ' . $title;

[453] Fix | Delete

}

[454] Fix | Delete

[455] Fix | Delete

return $title;

[456] Fix | Delete

}

[457] Fix | Delete

[458] Fix | Delete

/**

[459] Fix | Delete

* Whether locations' type is WP Template.

[460] Fix | Delete

*

[461] Fix | Delete

* @since 1.7.4.1

[462] Fix | Delete

*

[463] Fix | Delete

* @param string $location_type Location type.

[464] Fix | Delete

*

[465] Fix | Delete

* @return bool

[466] Fix | Delete

*/

[467] Fix | Delete

private function is_wp_template( $location_type ) {

[468] Fix | Delete

[469] Fix | Delete

return in_array( $location_type, [ self::WP_TEMPLATE, self::WP_TEMPLATE_PART ], true );

[470] Fix | Delete

}

[471] Fix | Delete

[472] Fix | Delete

/**

[473] Fix | Delete

* Whether a location type is standalone.

[474] Fix | Delete

*

[475] Fix | Delete

* @since 1.8.7

[476] Fix | Delete

*

[477] Fix | Delete

* @param string $location_type Location type.

[478] Fix | Delete

*

[479] Fix | Delete

* @return bool

[480] Fix | Delete

*/

[481] Fix | Delete

private function is_standalone( string $location_type ): bool {

[482] Fix | Delete

[483] Fix | Delete

return in_array( $location_type, self::STANDALONE_LOCATION_TYPES, true );

[484] Fix | Delete

}

[485] Fix | Delete

[486] Fix | Delete

/**

[487] Fix | Delete

* Get location title.

[488] Fix | Delete

*

[489] Fix | Delete

* @since 1.7.4

[490] Fix | Delete

*

[491] Fix | Delete

* @param array $form_location Form location.

[492] Fix | Delete

*

[493] Fix | Delete

* @return string

[494] Fix | Delete

*/

[495] Fix | Delete

private function get_location_title( $form_location ) {

[496] Fix | Delete

[497] Fix | Delete

if ( $form_location['type'] !== self::WIDGET ) {

[498] Fix | Delete

return $this->get_post_location_title( $form_location );

[499] Fix | Delete