Skip to content
Docs
Get RestroPress

Filter

rpress_reservation_initial_status

Updated
On this page

Filters the status a new reservation is created with.

Runs while a reservation is inserted, after the status is chosen from the insert arguments or the Confirm automatically setting (confirmed or pending). The returned status is used only when it is a registered reservation status. A typical use is a custom awaiting payment status that holds the seats until a deposit is paid.

Available since RestroPress 3.5.

Parameters#

ParameterTypeDescription
$statusstringStatus slug.
$dataarrayValidated core fields.
$inputarrayRaw input, including extension fields.
$argsarrayInsert arguments: validate, status and source.

Return value#

string. The initial status slug. Unregistered slugs are ignored.

Example#

function my_reservation_initial_status( $status, $data, $input, $args ) {
	if ( $data['party'] >= 8 ) {
		return 'pending';
	}
	return $status;
}
add_filter( 'rpress_reservation_initial_status', 'my_reservation_initial_status', 10, 4 );

Notes#

Runs while the date lock is held.

Source#

Applied in:

  • includes/features/reservations/functions.php (line 538), in rpress_reservation_insert_locked()

See also#

Was this page helpful?