WordPress.org

Codex

Function Reference/sanitize sql orderby

Contents

Description

Ensures a string is a valid SQL order by clause.

Accepts one or more columns, with or without ASC/DESC, and also accepts RAND().

Usage

<?php sanitize_sql_orderby( $orderby ); ?>

Parameters

$orderby
(string) (required) Order by string to be checked.
Default: None

Return Values

(string | boolean) 
Returns the order by clause if it is a match, false otherwise.

Examples

Notes

Change Log

Since: 2.5.1

Source File

sanitize_sql_orderby() is located in /wp-includes/formatting.php.

Related

Functions

sanitize_sql_orderby() is in a class of functions that help you sanitize potentially unsafe data which allow you to pass an arbitrary variable and receive the clean version based on data type. Others include:

Filters

Retrieved from "http://codex.wordpress.org/Function_Reference/sanitize_sql_orderby"

Codex Resources