bbp_admin_reset_query_feedback( array $args = array() )

Wrapper for determining admin reset query feedback presented to a user.


Description Description


Parameters Parameters

$args

(Optional) Array of query, message, and possible responses

Default value: array()


Top ↑

Return Return

(string)


Top ↑

Source Source

File: includes/admin/tools/reset.php

function bbp_admin_reset_query_feedback( $args = array() ) {
	static $defaults = null;

	// Only set defaults one time to avoid hitting the GetText API repeatedly
	if ( null === $defaults ) {
		$defaults = array(
			'query'     => '',
			'message'   => esc_html__( 'Resetting…', 'bbpress' ),
			'responses' => array(
				'success' => esc_html__( 'Success!', 'bbpress' ),
				'failure' => esc_html__( 'Failed!',  'bbpress' ),
				'skipped' => esc_html__( 'Skipped.', 'bbpress' )
			)
		);
	}

	// Parse arguments
	$r = bbp_parse_args( $args, $defaults, 'admin_reset_query_feedback' );

	// Success/Failure based on query error
	if ( ! empty( $r['query'] ) ) {
		$query  = bbp_db()->query( $r['query'] );
		$result = ! is_wp_error( $query )
			? $r['responses']['success']
			: $r['responses']['failure'];

	// Skip if empty
	} else {
		$result = $r['responses']['skipped'];
	}

	// Return feedback
	return sprintf( $r['message'], $result );
}

Top ↑

Changelog Changelog

Changelog
Version Description
2.6.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.