gutenberg / build / scripts / block-library / form.php

form.php in Gutenberg 22.9.0, at build/scripts/block-library/form.php

196 lines 5.8 KB

Raw Download Zip

1	<?php
2	/**
3	* Server-side rendering of the `core/form` block.
4	*
5	* @package WordPress
6	*/
7
8	/**
9	* Renders the `core/form` block on server.
10	*
11	* @param array $attributes The block attributes.
12	* @param string $content The saved content.
13	*
14	* @return string The content of the block being rendered.
15	*/
16	function gutenberg_render_block_core_form( $attributes, $content ) {
17	wp_enqueue_script_module( '@wordpress/block-library/form/view' );
18
19	$processed_content = new WP_HTML_Tag_Processor( $content );
20	$processed_content->next_tag( 'form' );
21
22	// Get the action for this form.
23	$action = '';
24	if ( isset( $attributes['action'] ) ) {
25	$action = str_replace(
26	array( '{SITE_URL}', '{ADMIN_URL}' ),
27	array( site_url(), admin_url() ),
28	$attributes['action']
29	);
30	}
31	$processed_content->set_attribute( 'action', esc_attr( $action ) );
32
33	// Add the method attribute. If it is not set, default to `post`.
34	$method = empty( $attributes['method'] ) ? 'post' : $attributes['method'];
35	$processed_content->set_attribute( 'method', $method );
36
37	$extra_fields = apply_filters( 'render_block_core_form_extra_fields', '', $attributes );
38
39	return str_replace(
40	'</form>',
41	$extra_fields . '</form>',
42	$processed_content->get_updated_html()
43	);
44	}
45
46	/**
47	* Adds extra fields to the form.
48	*
49	* If the form is a comment form, adds the post ID as a hidden field,
50	* to allow the comment to be associated with the post.
51	*
52	* @param string $extra_fields The extra fields.
53	* @param array $attributes The block attributes.
54	*
55	* @return string The extra fields.
56	*/
57	function gutenberg_block_core_form_extra_fields_comment_form( $extra_fields, $attributes ) {
58	if ( ! empty( $attributes['action'] ) && str_ends_with( $attributes['action'], '/wp-comments-post.php' ) ) {
59	$extra_fields .= '<input type="hidden" name="comment_post_ID" value="' . get_the_ID() . '" id="comment_post_ID">';
60	}
61	return $extra_fields;
62	}
63	add_filter( 'render_block_core_form_extra_fields', 'gutenberg_block_core_form_extra_fields_comment_form', 10, 2 );
64
65	/**
66	* Sends an email if the form is a contact form.
67	*/
68	function gutenberg_block_core_form_send_email() {
69	check_ajax_referer( 'wp-block-form' );
70
71	// Get the POST data.
72	$params = wp_unslash( $_POST );
73	// Start building the email content.
74	$content = sprintf(
75	/* translators: %s: The request URI. */
76	__( 'Form submission from %1$s' ) . '</br>',
77	'<a href="' . esc_url( get_site_url( null, $params['_wp_http_referer'] ) ) . '">' . get_bloginfo( 'name' ) . '</a>'
78	);
79
80	$skip_fields = array( 'formAction', '_ajax_nonce', 'action', '_wp_http_referer' );
81	foreach ( $params as $key => $value ) {
82	if ( in_array( $key, $skip_fields, true ) ) {
83	continue;
84	}
85	$content .= sanitize_key( $key ) . ': ' . wp_kses_post( $value ) . '</br>';
86	}
87
88	// Filter the email content.
89	$content = apply_filters( 'render_block_core_form_email_content', $content, $params );
90
91	// Send the email.
92	$result = wp_mail(
93	str_replace( 'mailto:', '', $params['formAction'] ),
94	__( 'Form submission' ),
95	$content
96	);
97
98	if ( ! $result ) {
99	wp_send_json_error( $result );
100	}
101	wp_send_json_success( $result );
102	}
103	add_action( 'wp_ajax_wp_block_form_email_submit', 'gutenberg_block_core_form_send_email' );
104	add_action( 'wp_ajax_nopriv_wp_block_form_email_submit', 'gutenberg_block_core_form_send_email' );
105
106	/**
107	* Send the data export/remove request if the form is a privacy-request form.
108	*/
109	function gutenberg_block_core_form_privacy_form() {
110	// Get the POST data.
111	$params = wp_unslash( $_POST );
112
113	// Bail early if not a form submission, or if the nonce is not valid.
114	if ( empty( $params['wp-action'] )
115	\|\| 'wp_privacy_send_request' !== $params['wp-action']
116	\|\| empty( $params['wp-privacy-request'] )
117	\|\| '1' !== $params['wp-privacy-request']
118	\|\| empty( $params['email'] )
119	) {
120	return;
121	}
122
123	// Get the request types.
124	$request_types = _wp_privacy_action_request_types();
125	$requests_found = array();
126	foreach ( $request_types as $request_type ) {
127	if ( ! empty( $params[ $request_type ] ) ) {
128	$requests_found[] = $request_type;
129	}
130	}
131
132	// Bail early if no requests were found.
133	if ( empty( $requests_found ) ) {
134	return;
135	}
136
137	// Process the requests.
138	$actions_errored = array();
139	$actions_performed = array();
140	foreach ( $requests_found as $action_name ) {
141	// Get the request ID.
142	$request_id = wp_create_user_request( $params['email'], $action_name );
143
144	// Bail early if the request ID is invalid.
145	if ( is_wp_error( $request_id ) ) {
146	$actions_errored[] = $action_name;
147	continue;
148	}
149
150	// Send the request email.
151	wp_send_user_request( $request_id );
152	$actions_performed[] = $action_name;
153	}
154
155	/**
156	* Determine whether the core/form-submission-notification block should be shown.
157	*
158	* @param bool $show Whether to show the core/form-submission-notification block.
159	* @param array $attributes The block attributes.
160	*
161	* @return bool Whether to show the core/form-submission-notification block.
162	*/
163	$show_notification = static function ( $show, $attributes ) use ( $actions_performed, $actions_errored ) {
164	switch ( $attributes['type'] ) {
165	case 'success':
166	return ! empty( $actions_performed ) && empty( $actions_errored );
167
168	case 'error':
169	return ! empty( $actions_errored );
170
171	default:
172	return $show;
173	}
174	};
175
176	// Add filter to show the core/form-submission-notification block.
177	add_filter( 'show_form_submission_notification_block', $show_notification, 10, 2 );
178	}
179	add_action( 'wp', 'gutenberg_block_core_form_privacy_form' );
180
181	/**
182	* Registers the `core/form` block on server.
183	*/
184	function gutenberg_register_block_core_form() {
185	if ( ! gutenberg_is_experiment_enabled( 'gutenberg-form-blocks' ) ) {
186	return;
187	}
188	register_block_type_from_metadata(
189	__DIR__ . '/form',
190	array(
191	'render_callback' => 'gutenberg_render_block_core_form',
192	)
193	);
194	}
195	add_action( 'init', 'gutenberg_register_block_core_form', 20 );
196