sites_pre_query
Opis — z kodu źródłowego
Filters the site data before the get_sites query takes place.
Return a non-null value to bypass WordPress' default site queries.
The expected return type from this filter depends on the value passed in the request query vars: - When $this->query_vars['count'] is set, the filter should return the site count as an integer. - When 'ids' === $this->query_vars['fields'], the filter should return an array of site IDs. - Otherwise the filter should return an array of WP_Site objects.
Note that if the filter returns an array of site data, it will be assigned to the sites property of the current WP_Site_Query instance.
Filtering functions that require pagination information are encouraged to set the found_sites and max_num_pages properties of the WP_Site_Query object, passed to the filter by reference. If WP_Site_Query does not perform a database query, it will not have enough information to generate these values itself.
Parametry
| Parametr | Typ | Opis |
|---|---|---|
$site_data | \WP_Site[] | int[] | int | null | Return an array of site data to short-circuit WP's site query, the site count as an integer if <code>$this->query_vars['count']</code> is set, or null to run the normal queries. |
$query | \WP_Site_Query | The WP_Site_Query instance, passed by reference. |
Wywołanie
// rejestracja funkcji zwrotnej
add_filter( 'sites_pre_query', 'twoja_funkcja' );
function twoja_funkcja($param_1) {
// Twój kod
}Popularne w tej kategorii