WP_Network_Query::parse_orderby( string $orderby ): string|false

Parses and sanitizes ‘orderby’ keys passed to the network query.


Parameters

$orderby string Required
Alias for the field to order by.

Top ↑

Return

string|false Value to used in the ORDER clause. False otherwise.


Top ↑

Source

File: wp-includes/class-wp-network-query.php. View all references

protected function parse_orderby( $orderby ) {
	global $wpdb;

	$allowed_keys = array(
		'id',
		'domain',
		'path',
	);

	$parsed = false;
	if ( 'network__in' === $orderby ) {
		$network__in = implode( ',', array_map( 'absint', $this->query_vars['network__in'] ) );
		$parsed      = "FIELD( {$wpdb->site}.id, $network__in )";
	} elseif ( 'domain_length' === $orderby || 'path_length' === $orderby ) {
		$field  = substr( $orderby, 0, -7 );
		$parsed = "CHAR_LENGTH($wpdb->site.$field)";
	} elseif ( in_array( $orderby, $allowed_keys, true ) ) {
		$parsed = "$wpdb->site.$orderby";
	}

	return $parsed;
}


Top ↑

Changelog

Changelog
Version Description
4.6.0 Introduced.

Top ↑

User Contributed Notes

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