WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

General inline documentation improvements in wp-includes/functions.php. 

First run. See #26185.

Built from https://develop.svn.wordpress.org/trunk@28918


git-svn-id: http://core.svn.wordpress.org/trunk@28717 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-06-30 03:56:15 +00:00
parent 36be4e5703
commit c97a364b79
1 changed files with 57 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
wp-includes/functions.php
View File

@ -8,7 +8,7 @@
require( ABSPATH . WPINC . '/option.php' ); require( ABSPATH . WPINC . '/option.php' );
/** /**
* Converts given date string into a different format. * Convert given date string into a different format.
* *
* $format should be either a PHP date format string, e.g. 'U' for a Unix * $format should be either a PHP date format string, e.g. 'U' for a Unix
* timestamp, or 'G' for a Unix timestamp assuming that $date is GMT. * timestamp, or 'G' for a Unix timestamp assuming that $date is GMT.
@ -18,9 +18,9 @@ require( ABSPATH . WPINC . '/option.php' );
* *
* @since 0.71 * @since 0.71
* *
* @param string $format Format of the date to return. * @param string $format Format of the date to return.
* @param string $date Date string to convert. * @param string $date Date string to convert.
* @param bool $translate Whether the return date should be translated. Default is true. * @param bool $translate Whether the return date should be translated. Default true.
* @return string|int Formatted date string, or Unix timestamp. * @return string|int Formatted date string, or Unix timestamp.
*/ */
function mysql2date( $format, $date, $translate = true ) { function mysql2date( $format, $date, $translate = true ) {
@ -53,8 +53,9 @@ function mysql2date( $format, $date, $translate = true ) {
* *
* @since 1.0.0 * @since 1.0.0
* *
* @param string $type 'mysql', 'timestamp', or PHP date format string (e.g. 'Y-m-d'). * @param string $type Type of time to retrieve. Accepts 'mysql', 'timestamp', or PHP date
* @param int|bool $gmt Optional. Whether to use GMT timezone. Default is false. * format string (e.g. 'Y-m-d').
* @param int|bool $gmt Optional. Whether to use GMT timezone. Default false.
* @return int|string Integer if $type is 'timestamp', string otherwise. * @return int|string Integer if $type is 'timestamp', string otherwise.
*/ */
function current_time( $type, $gmt = 0 ) { function current_time( $type, $gmt = 0 ) {
@ -97,8 +98,10 @@ function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
$gmt = true; $gmt = true;
} }
// store original value for language with untypical grammars /*
// see http://core.trac.wordpress.org/ticket/9396 * Store original value for language with untypical grammars.
* See http://core.trac.wordpress.org/ticket/9396
*/
$req_format = $dateformatstring; $req_format = $dateformatstring;
$datefunc = $gmt? 'gmdate' : 'date'; $datefunc = $gmt? 'gmdate' : 'date';
@ -158,8 +161,8 @@ function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
* *
* @since 2.3.0 * @since 2.3.0
* *
* @param int $number The number to convert based on locale. * @param int $number The number to convert based on locale.
* @param int $decimals Precision of the number of decimal places. * @param int $decimals Optional. Precision of the number of decimal places. Default 0.
* @return string Converted number in string format. * @return string Converted number in string format.
*/ */
function number_format_i18n( $number, $decimals = 0 ) { function number_format_i18n( $number, $decimals = 0 ) {
@ -189,12 +192,11 @@ function number_format_i18n( $number, $decimals = 0 ) {
* be converted to a double, which should always have 64 bit length. * be converted to a double, which should always have 64 bit length.
* *
* Technically the correct unit names for powers of 1024 are KiB, MiB etc. * Technically the correct unit names for powers of 1024 are KiB, MiB etc.
* @link http://en.wikipedia.org/wiki/Byte
* *
* @since 2.3.0 * @since 2.3.0
* *
* @param int|string $bytes Number of bytes. Note max integer size for integers. * @param int|string $bytes Number of bytes. Note max integer size for integers.
* @param int $decimals Precision of number of decimal places. Deprecated. * @param int $decimals Optional. Precision of number of decimal places. Default 0.
* @return bool|string False on failure. Number string on success. * @return bool|string False on failure. Number string on success.
*/ */
function size_format( $bytes, $decimals = 0 ) { function size_format( $bytes, $decimals = 0 ) {
@ -223,19 +225,32 @@ function size_format( $bytes, $decimals = 0 ) {
* @return array Keys are 'start' and 'end'. * @return array Keys are 'start' and 'end'.
*/ */
function get_weekstartend( $mysqlstring, $start_of_week = '' ) { function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
$my = substr( $mysqlstring, 0, 4 ); // Mysql string Year // Mysql string year.
$mm = substr( $mysqlstring, 8, 2 ); // Mysql string Month $my = substr( $mysqlstring, 0, 4 );
$md = substr( $mysqlstring, 5, 2 ); // Mysql string day
$day = mktime( 0, 0, 0, $md, $mm, $my ); // The timestamp for mysqlstring day. // Mysql string month.
$weekday = date( 'w', $day ); // The day of the week from the timestamp $mm = substr( $mysqlstring, 8, 2 );
// Mysql string day.
$md = substr( $mysqlstring, 5, 2 );
// The timestamp for mysqlstring day.
$day = mktime( 0, 0, 0, $md, $mm, $my );
// The day of the week from the timestamp.
$weekday = date( 'w', $day );
if ( !is_numeric($start_of_week) ) if ( !is_numeric($start_of_week) )
$start_of_week = get_option( 'start_of_week' ); $start_of_week = get_option( 'start_of_week' );
if ( $weekday < $start_of_week ) if ( $weekday < $start_of_week )
$weekday += 7; $weekday += 7;
$start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week ); // The most recent week start day on or before $day // The most recent week start day on or before $day.
$end = $start + 7 * DAY_IN_SECONDS - 1; // $start + 7 days - 1 second $start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week );
// $start + 7 days - 1 second.
$end = $start + 7 * DAY_IN_SECONDS - 1;
return compact( 'start', 'end' ); return compact( 'start', 'end' );
} }
@ -261,12 +276,12 @@ function maybe_unserialize( $original ) {
* *
* @since 2.0.5 * @since 2.0.5
* *
* @param mixed $data Value to check to see if was serialized. * @param string $data Value to check to see if was serialized.
* @param bool $strict Optional. Whether to be strict about the end of the string. Defaults true. * @param bool $strict Optional. Whether to be strict about the end of the string. Default true.
* @return bool False if not serialized and true if it was. * @return bool False if not serialized and true if it was.
*/ */
function is_serialized( $data, $strict = true ) { function is_serialized( $data, $strict = true ) {
// if it isn't a string, it isn't serialized // if it isn't a string, it isn't serialized.
if ( ! is_string( $data ) ) { if ( ! is_string( $data ) ) {
return false; return false;
} }
@ -325,11 +340,11 @@ function is_serialized( $data, $strict = true ) {
* *
* @since 2.0.5 * @since 2.0.5
* *
* @param mixed $data Serialized data * @param string $data Serialized data.
* @return bool False if not a serialized string, true if it is. * @return bool False if not a serialized string, true if it is.
*/ */
function is_serialized_string( $data ) { function is_serialized_string( $data ) {
// if it isn't a string, it isn't a serialized string // if it isn't a string, it isn't a serialized string.
if ( ! is_string( $data ) ) { if ( ! is_string( $data ) ) {
return false; return false;
} }
@ -354,7 +369,7 @@ function is_serialized_string( $data ) {
* *
* @since 2.0.5 * @since 2.0.5
* *
* @param mixed $data Data that might be serialized. * @param string|array|object $data Data that might be serialized.
* @return mixed A scalar data * @return mixed A scalar data
*/ */
function maybe_serialize( $data ) { function maybe_serialize( $data ) {
@ -377,7 +392,7 @@ function maybe_serialize( $data ) {
* *
* @since 0.71 * @since 0.71
* *
* @global string $post_default_title Default XMLRPC post title. * @global string $post_default_title Default XML-RPC post title.
* *
* @param string $content XMLRPC XML Request content * @param string $content XMLRPC XML Request content
* @return string Post title * @return string Post title
@ -401,7 +416,7 @@ function xmlrpc_getposttitle( $content ) {
* *
* @since 0.71 * @since 0.71
* *
* @global string $post_default_category Default XMLRPC post category. * @global string $post_default_category Default XML-RPC post category.
* *
* @param string $content XMLRPC XML Request content * @param string $content XMLRPC XML Request content
* @return string|array List of categories or category name. * @return string|array List of categories or category name.
@ -422,7 +437,7 @@ function xmlrpc_getpostcategory( $content ) {
* *
* @since 0.71 * @since 0.71
* *
* @param string $content XMLRPC XML Request content * @param string $content XML-RPC XML Request content.
* @return string XMLRPC XML Request content without title and category elements. * @return string XMLRPC XML Request content without title and category elements.
*/ */
function xmlrpc_removepostdata( $content ) { function xmlrpc_removepostdata( $content ) {
@ -433,12 +448,12 @@ function xmlrpc_removepostdata( $content ) {
} }
/** /**
* Use RegEx to extract URLs from arbitrary content * Use RegEx to extract URLs from arbitrary content.
* *
* @since 3.7.0 * @since 3.7.0
* *
* @param string $content * @param string $content Content to extract URLs from.
* @return array URLs found in passed string * @return array URLs found in passed string.
*/ */
function wp_extract_urls( $content ) { function wp_extract_urls( $content ) {
preg_match_all( preg_match_all(
@ -472,10 +487,10 @@ function wp_extract_urls( $content ) {
* *
* @since 1.5.0 * @since 1.5.0
* *
* @uses $wpdb * @see $wpdb
* *
* @param string $content Post Content * @param string $content Post Content.
* @param int $post_ID Post ID * @param int $post_ID Post ID.
*/ */
function do_enclose( $content, $post_ID ) { function do_enclose( $content, $post_ID ) {
global $wpdb; global $wpdb;
@ -548,9 +563,10 @@ function do_enclose( $content, $post_ID ) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param string $url URL to fetch. * @param string $url URL to fetch.
* @param string|bool $file_path Optional. File path to write request to. * @param string|bool $file_path Optional. File path to write request to. Default false.
* @param int $red (private) The number of Redirects followed, Upon 5 being hit, returns false. * @param int $red Optional. The number of Redirects followed, Upon 5 being hit,
* returns false. Default 1.
* @return bool|string False on failure and string of headers if HEAD request. * @return bool|string False on failure and string of headers if HEAD request.
*/ */
function wp_get_http( $url, $file_path = false, $red = 1 ) { function wp_get_http( $url, $file_path = false, $red = 1 ) {
@ -600,8 +616,8 @@ function wp_get_http( $url, $file_path = false, $red = 1 ) {
* *
* @since 1.5.1 * @since 1.5.1
* *
* @param string $url * @param string $url URL to retrieve HTTP headers from.
* @param bool $deprecated Not Used. * @param bool $deprecated Not Used.
* @return bool|string False on failure, headers on success. * @return bool|string False on failure, headers on success.
*/ */
function wp_get_http_headers( $url, $deprecated = false ) { function wp_get_http_headers( $url, $deprecated = false ) {
@ -621,6 +637,7 @@ function wp_get_http_headers( $url, $deprecated = false ) {
* publish date of the previous post in the loop. * publish date of the previous post in the loop.
* *
* @since 0.71 * @since 0.71
*
* @global string $currentday The day of the current post in the loop. * @global string $currentday The day of the current post in the loop.
* @global string $previousday The day of the previous post in the loop. * @global string $previousday The day of the previous post in the loop.
* *