English (United Kingdom)
Knowledge Base  >  VikUpdater  >  Developers  >  Plugins  >  Check URL - Extra Query

apply_filters( 'vikupdater_check_plugin_extra_query', array $args, array $options )

Filter used to apply an extra query to the URL needed to check the latest package of a plugin.


Description

It is possible to use this hook to extend at runtime the query string of the URL needed to download the JSON manifest of the requested plugin.


Parameters

$args

(array)  An associative array holding the extra parameters to add to the query string of the "check" URL.

$options

(array)  A configuration array, taken from the associative array specified during the subscription of the plugin.


Example

The example below explains how to receive (at server level) a parameter indicating the accepted stability (RC, nightly, stable and so on).

function your_plugin_vikupdater_check_extra_query( $args, $options ) {
    // make sure we are observing our plugin
    if ( 'your-plugin' === $options['slug'] ) {
        // include within the URL: `&stability={stability}`
        $args['stability'] = get_option('yourplugin_update_stability', 'stable');
    }

    return $args;
}

add_filter( 'vikupdater_check_plugin_extra_query', 'your_plugin_vikupdater_check_extra_query', 10, 2 );

Changelog

Version Description
2.0 Introduced.
Last Update: 2023-11-21
Helpful?