backs. * * @since 4.12.12 * * @param array $arguments Set of arguments passed to the widget at hand. * * @return array The validated widget arguments map. */ public function validate_arguments( array $arguments ); /** * Returns the array of callbacks for this widget's arguments. * * @since 4.12.12 * * @return array A map of the widget arguments that have survived validation. */ public function get_validated_arguments_map(); /** * Returns the array of callbacks for this widget's arguments. * * @since 4.12.12 * * @param array $validate_arguments_map Array of callbacks for this widget's arguments. * * @return array A map of the widget arguments that have survived validation. */ public function filter_validated_arguments_map( $validate_arguments_map = [] ); /** * Returns an array of admin fields for the widget. * * @since 4.12.14 * * @return array The array of widget admin fields. */ public function get_admin_fields(); /** * Filter a widget's admin fields. * * @since 4.12.14 * * @param array $admin_fields The array of widget admin fields. * * @return array The array of widget admin fields. */ public function filter_admin_fields( $admin_fields ); /** * Filters a widget's updated instance. * * @since 4.12.14 * * @param array $updated_instance The updated instance of the widget. * @param array $new_instance The new values for the widget instance. * * @return array The updated instance to be saved for the widget. */ public function filter_updated_instance( $updated_instance, $new_instance ); /** * Returns a widget arguments after been parsed. * * @since 4.12.12 * @since 4.13.0 Deprecated the instance method as that is passed only to setup_arguments method. * * @param array $_deprecated Saved values for the widget instance. * * @return array The widget arguments, as set by the user in the widget string. */ public function get_arguments( array $_deprecated = [] ); /** * Filter a widget's arguments after they have been been parsed. * * @since 4.12.12 * * @param array $arguments Current set of arguments. * * @return array The widget arguments, as set by the user in the widget string. */ public function filter_arguments( $arguments ); /** * Get a single widget argument after it has been parsed and filtered. * * @since 4.12.12 * * @param string|int $index Which index we intend to fetch from the arguments. * @param array|mixed $default Default value if it doesn't exist. * * @uses Tribe__Utils__Array::get For index fetching and Default. * * @return mixed Value for the Index passed as the first argument. */ public function get_argument( $index, $default = null ); /** * Filter a widget argument. * * @since 4.12.12 * * @param mixed $argument The argument value. * @param string|int $index Which index we intend to fetch from the arguments. * @param array|mixed $default Default value if it doesn't exist. * * @uses Tribe__Utils__Array::get For index fetching and Default. * * @return mixed Value for the Index passed as the first argument. */ public function filter_argument( $argument, $index, $default = null ); /** * Get default arguments for a widget. * * @since 4.12.12 * * @return array The map of widget default arguments. */ public function get_default_arguments(); /** * Filter a widget's default arguments. * * @since 4.12.12 * * @param array $default_arguments Current set of default arguments. * * @return array The map of widget default arguments. */ public function filter_default_arguments( array $default_arguments = [] ); /** * Filter a widget's arguments before they are passed to the context. * * @since 4.13.0 * * @param array $alterations Current set of alterations for the context. * @param array $arguments Current set of arguments in the widget. * * @return array The map of arguments after filtering. */ public function filter_args_to_context( array $alterations = [], array $arguments = [] ); /** * Returns a widget's HTML. * * @since 4.12.12 * * @return string The rendered widget's HTML code. */ public function get_html(); /** * Sets the sidebar arguments sent by the theme. * * @since 4.13.0 * * @param array $arguments Arguments passed by the theme. */ public function setup_sidebar_arguments( $arguments ); /** * Sets the sidebar arguments sent by the theme. * * @since 4.13.0 * * @return array Arguments sent by the theme and stored in this class. */ public function get_sidebar_arguments(); /** * Sets the sidebar arguments sent by the theme. * * @since 4.13.0 * * @param array $arguments Arguments passed by the theme. * * @return array Arguments sent by the theme and stored in this class. */ public function filter_sidebar_arguments( $arguments ); /********************** * Deprecated Methods * **********************/ /** * Returns the widget slug that allows the widget to be built via the widget class using that slug. * * @since 4.12.12 * * @deprecated 4.13.0 In favor of static::get_widget_slug() * @todo remove after 2021-08-01 * * @return string The widget slug. */ public function get_registration_slug(); }