Changeset 34284

Timestamp:

09/18/2015 09:40:51 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add documentation to get_query_var() and WP_Query::get() for the optional $default argument, introduced in 3.9 in [27304].

Props swissspidy.
Fixes #33856.

File:

• trunk/src/wp-includes/query.php (modified) (2 diffs)

trunk/src/wp-includes/query.php

@@ -16 +16 @@
  *
  * @since 1.5.0
+ * @since 3.9.0 The `$default` argument was introduced.
  *
  * @global WP_Query $wp_query
  *
  * @param string $var       The variable key to retrieve.
- * @param mixed  $default   Value to return if the query variable is not set. Default ''.
- * @return mixed
+ * @param mixed  $default   Optional. Value to return if the query variable is not set. Default empty.
+ * @return mixed Contents of the query variable.
  */
 function get_query_var( $var, $default = '' ) {
@@ -2359 +2360 @@
      *
      * @since 1.5.0
+     * @since 3.9.0 The `$default` argument was introduced.
+     *
      * @access public
      *
      * @param string $query_var Query variable key.
-     * @param mixed  $default   Value to return if the query variable is not set. Default ''.
-     * @return mixed
+     * @param mixed  $default   Optional. Value to return if the query variable is not set. Default empty.
+     * @return mixed Contents of the query variable.
      */
     public function get( $query_var, $default = '' ) {