WordPress.org

Make WordPress Core

Changeset 18448


Ignore:
Timestamp:
07/21/2011 05:48:25 PM (8 years ago)
Author:
ryan
Message:

phpdoc typo fixes for functions.php. Props coffee2code. fixes #17752

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/functions.php

    r18321 r18448  
    455455
    456456/**
    457  * Loads and caches certain often requested site options if is_multisite() and a peristent cache is not being used.
     457 * Loads and caches certain often requested site options if is_multisite() and a persistent cache is not being used.
    458458 *
    459459 * @since 3.0.0
     
    687687
    688688/**
    689  * Delete a transient
     689 * Delete a transient.
    690690 *
    691691 * @since 2.8.0
     
    720720
    721721/**
    722  * Get the value of a transient
     722 * Get the value of a transient.
    723723 *
    724724 * If the transient does not exist or does not have a value, then the return value
     
    769769
    770770/**
    771  * Set/update the value of a transient
     771 * Set/update the value of a transient.
    772772 *
    773773 * You do not need to serialize values. If the value needs to be serialized, then
     
    14181418 *
    14191419 * Adding a single key & value or an associative array. Setting a key value to
    1420  * emptystring removes the key. Omitting oldquery_or_uri uses the $_SERVER
     1420 * an empty string removes the key. Omitting oldquery_or_uri uses the $_SERVER
    14211421 * value.
    14221422 *
     
    17951795
    17961796/**
    1797  * Load the RSS 1.0 Feed Template
     1797 * Load the RSS 1.0 Feed Template.
    17981798 *
    17991799 * @since 2.1.0
     
    27452745 * only, when the execution should not continue any further. It is not
    27462746 * recommended to call this function very often and try to handle as many errors
    2747  * as possible siliently.
     2747 * as possible silently.
    27482748 *
    27492749 * @since 2.0.4
     
    27512751 * @param string $message Error message.
    27522752 * @param string $title Error title.
    2753  * @param string|array $args Optional arguements to control behaviour.
     2753 * @param string|array $args Optional arguments to control behavior.
    27542754 */
    27552755function wp_die( $message, $title = '', $args = array() ) {
     
    27772777 * @param string $message Error message.
    27782778 * @param string $title Error title.
    2779  * @param string|array $args Optional arguements to control behaviour.
     2779 * @param string|array $args Optional arguments to control behavior.
    27802780 */
    27812781function _default_wp_die_handler( $message, $title = '', $args = array() ) {
     
    28682868 * @param string $message Error message.
    28692869 * @param string $title Error title.
    2870  * @param string|array $args Optional arguements to control behaviour.
     2870 * @param string|array $args Optional arguments to control behavior.
    28712871 */
    28722872function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
     
    28972897 * Retrieve the WordPress home page URL.
    28982898 *
    2899  * If the constant named 'WP_HOME' exists, then it willl be used and returned by
     2899 * If the constant named 'WP_HOME' exists, then it will be used and returned by
    29002900 * the function. This can be used to counter the redirection on your local
    29012901 * development environment.
     
    30993099
    31003100/**
    3101  * Clean up an array, comma- or space-separated list of IDs
     3101 * Clean up an array, comma- or space-separated list of IDs.
    31023102 *
    31033103 * @since 3.0.0
     
    31143114
    31153115/**
    3116  * Extract a slice of an array, given a list of keys
     3116 * Extract a slice of an array, given a list of keys.
    31173117 *
    31183118 * @since 3.1.0
     
    31323132
    31333133/**
    3134  * Filters a list of objects, based on a set of key => value arguments
     3134 * Filters a list of objects, based on a set of key => value arguments.
    31353135 *
    31363136 * @since 3.0.0
     
    31563156
    31573157/**
    3158  * Filters a list of objects, based on a set of key => value arguments
     3158 * Filters a list of objects, based on a set of key => value arguments.
    31593159 *
    31603160 * @since 3.1.0
     
    31933193
    31943194/**
    3195  * Pluck a certain field out of each object in a list
     3195 * Pluck a certain field out of each object in a list.
    31963196 *
    31973197 * @since 3.1.0
     
    33063306 * @since 2.5.0
    33073307 *
    3308  * @param mixed $maybeint Data you wish to have convered to an nonnegative integer
     3308 * @param mixed $maybeint Data you wish to have converted to a nonnegative integer
    33093309 * @return int An nonnegative integer
    33103310 */
     
    35043504
    35053505/**
    3506  * Is the server running earlier than 1.5.0 version of lighttpd
     3506 * Is the server running earlier than 1.5.0 version of lighttpd?
    35073507 *
    35083508 * @since 2.5.0
     
    35173517
    35183518/**
    3519  * Does the specified module exist in the apache config?
     3519 * Does the specified module exist in the Apache config?
    35203520 *
    35213521 * @since 2.5.0
     
    35463546
    35473547/**
    3548  * Check if IIS 7 supports pretty permalinks
     3548 * Check if IIS 7 supports pretty permalinks.
    35493549 *
    35503550 * @since 2.8.0
     
    38903890
    38913891/**
    3892  * Delete a site transient
     3892 * Delete a site transient.
    38933893 *
    38943894 * @since 2.9.0
     
    39213921
    39223922/**
    3923  * Get the value of a site transient
     3923 * Get the value of a site transient.
    39243924 *
    39253925 * If the transient does not exist or does not have a value, then the return value
     
    39703970
    39713971/**
    3972  * Set/update the value of a site transient
     3972 * Set/update the value of a site transient.
    39733973 *
    39743974 * You do not need to serialize values, if the value needs to be serialize, then
     
    40174017
    40184018/**
    4019  * is main site
     4019 * Is main site?
    40204020 *
    40214021 *
     
    40634063
    40644064/**
    4065  * gmt_offset modification for smart timezone handling
    4066  *
    4067  * Overrides the gmt_offset option if we have a timezone_string available
     4065 * gmt_offset modification for smart timezone handling.
     4066 *
     4067 * Overrides the gmt_offset option if we have a timezone_string available.
    40684068 *
    40694069 * @since 2.8.0
     
    41324132
    41334133/**
    4134  * Gives a nicely formatted list of timezone strings // temporary! Not in final
     4134 * Gives a nicely formatted list of timezone strings. // temporary! Not in final
    41354135 *
    41364136 * @since 2.9.0
     
    42614261
    42624262/**
    4263  * Strip close comment and close php tags from file headers used by WP
     4263 * Strip close comment and close php tags from file headers used by WP.
    42644264 * See http://core.trac.wordpress.org/ticket/8497
    42654265 *
     
    43224322 *
    43234323 * Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
    4324  * Each piece of metadata must be on its own line. Fields can not span multple
     4324 * Each piece of metadata must be on its own line. Fields can not span multiple
    43254325 * lines, the value will get cut at the end of the first line.
    43264326 *
     
    43714371
    43724372/**
    4373  * Used internally to tidy up the search terms
     4373 * Used internally to tidy up the search terms.
    43744374 *
    43754375 * @access private
     
    43844384
    43854385/**
    4386  * Returns true
    4387  *
    4388  * Useful for returning true to filters easily
     4386 * Returns true.
     4387 *
     4388 * Useful for returning true to filters easily.
    43894389 *
    43904390 * @since 3.0.0
     
    43974397
    43984398/**
    4399  * Returns false
    4400  *
    4401  * Useful for returning false to filters easily
     4399 * Returns false.
     4400 *
     4401 * Useful for returning false to filters easily.
    44024402 *
    44034403 * @since 3.0.0
     
    44104410
    44114411/**
    4412  * Returns 0
    4413  *
    4414  * Useful for returning 0 to filters easily
     4412 * Returns 0.
     4413 *
     4414 * Useful for returning 0 to filters easily.
    44154415 *
    44164416 * @since 3.0.0
     
    44234423
    44244424/**
    4425  * Returns an empty array
    4426  *
    4427  * Useful for returning an empty array to filters easily
     4425 * Returns an empty array.
     4426 *
     4427 * Useful for returning an empty array to filters easily.
    44284428 *
    44294429 * @since 3.0.0
     
    45024502 * @access private
    45034503 *
    4504  * @param callback $callback function that accupts ( ID, callback_arg, ... ) and outputs parent_ID
     4504 * @param callback $callback function that accepts ( ID, callback_arg, ... ) and outputs parent_ID
    45054505 * @param int $start The ID to start the loop check at
    45064506 * @param array $override an array of ( ID => parent_ID, ... ) to use instead of $callback
Note: See TracChangeset for help on using the changeset viewer.