<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[46690] trunk/src/wp-includes/class-http.php: Docs: Improve documentation for `WP_Http` per the documentation standards.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/46690">46690</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/46690","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-11-10 01:17:00 +0000 (Sun, 10 Nov 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve documentation for `WP_Http` per the documentation standards.
Props hareesh-pillai, adnan.limdi, isabel_brison.
Fixes <a href="https://core.trac.wordpress.org/ticket/41880">#41880</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasshttpphp">trunk/src/wp-includes/class-http.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasshttpphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-http.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-http.php 2019-11-09 13:55:43 UTC (rev 46689)
+++ trunk/src/wp-includes/class-http.php 2019-11-10 01:17:00 UTC (rev 46690)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -286,13 +286,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If we are streaming to a file but no filename was given drop it in the WP temp dir
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // and pick its name using the basename of the $url
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // and pick its name using the basename of the $url.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $parsed_args['stream'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $parsed_args['filename'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $parsed_args['filename'] = get_temp_dir() . basename( $url );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Force some settings if we are streaming to a file and check for existence and perms of destination directory
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Force some settings if we are streaming to a file and check for existence
+ // and perms of destination directory.
</ins><span class="cx" style="display: block; padding: 0 10px"> $parsed_args['blocking'] = true;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_is_writable( dirname( $parsed_args['filename'] ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $response = new WP_Error( 'http_request_failed', __( 'Destination directory for file streaming does not exist or is not writable.' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -312,7 +313,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $parsed_args['headers'] = $processedHeaders['headers'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Setup arguments
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Setup arguments.
</ins><span class="cx" style="display: block; padding: 0 10px"> $headers = $parsed_args['headers'];
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $parsed_args['body'];
</span><span class="cx" style="display: block; padding: 0 10px"> $type = $parsed_args['method'];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -340,7 +341,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $options['redirects'] = $parsed_args['redirection'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Use byte limit, if we can
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Use byte limit, if we can.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $parsed_args['limit_response_size'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $options['max_bytes'] = $parsed_args['limit_response_size'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -350,7 +351,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $options['cookies'] = WP_Http::normalize_cookies( $parsed_args['cookies'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // SSL certificate handling
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // SSL certificate handling.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $parsed_args['sslverify'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $options['verify'] = false;
</span><span class="cx" style="display: block; padding: 0 10px"> $options['verifyname'] = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -386,13 +387,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Avoid issues where mbstring.func_overload is enabled
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Avoid issues where mbstring.func_overload is enabled.
</ins><span class="cx" style="display: block; padding: 0 10px"> mbstring_binary_safe_encoding();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> try {
</span><span class="cx" style="display: block; padding: 0 10px"> $requests_response = Requests::request( $url, $headers, $data, $type, $options );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Convert the response into an array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Convert the response into an array.
</ins><span class="cx" style="display: block; padding: 0 10px"> $http_response = new WP_HTTP_Requests_Response( $requests_response, $parsed_args['filename'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $http_response->to_array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -483,7 +484,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param Requests_Response $original Response object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function browser_redirect_compatibility( $location, $headers, $data, &$options, $original ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Browser compat
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Browser compatibility.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $original->status_code === 302 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $options['type'] = Requests::GET;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -494,7 +495,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.5
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @throws Requests_Exception On unsuccessful URL validation
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @throws Requests_Exception On unsuccessful URL validation.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $location URL to redirect to.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function validate_redirects( $location ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -508,10 +509,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Request arguments
- * @param string $url URL to Request
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Request arguments.
+ * @param string $url URL to Request.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string|false Class name for the first transport that claims to support the request. False if no transport claims to support the request.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string|false Class name for the first transport that claims to support the request.
+ * False if no transport claims to support the request.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function _get_first_available_transport( $args, $url = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $transports = array( 'curl', 'streams' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -558,9 +560,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @deprecated 5.1.0 Use WP_Http::request()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Http::request()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $url URL to Request
- * @param array $args Request arguments
- * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $url URL to Request.
+ * @param array $args Request arguments.
+ * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
+ * A WP_Error instance upon error.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private function _dispatch_request( $url, $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> static $transports = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -597,7 +600,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url The request URL.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $args Optional. Override the defaults.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
+ * A WP_Error instance upon error.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function post( $url, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array( 'method' => 'POST' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -614,7 +618,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url The request URL.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $args Optional. Override the defaults.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
+ * A WP_Error instance upon error.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get( $url, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array( 'method' => 'GET' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -631,7 +636,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url The request URL.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $args Optional. Override the defaults.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
+ * A WP_Error instance upon error.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function head( $url, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array( 'method' => 'HEAD' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -644,7 +650,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $strResponse The full response string
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $strResponse The full response string.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Array with 'headers' and 'body' keys.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function processResponse( $strResponse ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -659,15 +665,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Transform header string into an array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If an array is given then it is assumed to be raw header data with numeric keys with the
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If an array is given, then it is assumed to be raw header data with numeric keys with the
</ins><span class="cx" style="display: block; padding: 0 10px"> * headers as the values. No headers must be passed that were already processed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $headers
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $url The URL that was requested
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $url The URL that was requested.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Processed string headers. If duplicate headers are encountered,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Then a numbered array is returned as the value of that header-key.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * then a numbered array is returned as the value of that header-key.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function processHeaders( $headers, $url = '' ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
</span><span class="cx" style="display: block; padding: 0 10px"> // Split headers, one per array element.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -731,7 +737,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Cast the Response Code to an int
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Cast the Response Code to an int.
</ins><span class="cx" style="display: block; padding: 0 10px"> $response['code'] = intval( $response['code'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -785,7 +791,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $body Body content
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $body Body content.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Chunked decoded body on success or raw body on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function chunkTransferDecode( $body ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -918,8 +924,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $maybe_relative_path The URL which might be relative
- * @param string $url The URL which $maybe_relative_path is relative to
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $maybe_relative_path The URL which might be relative.
+ * @param string $url The URL which $maybe_relative_path is relative to.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string An Absolute URL, in a failure condition where the URL cannot be parsed, the relative URL will be returned.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function make_absolute_url( $maybe_relative_path, $url ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -944,7 +950,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $absolute_path = $url_parts['scheme'] . '://';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Schemeless URL's will make it this far, so we check for a host in the relative url and convert it to a protocol-url
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Schemeless URLs will make it this far, so we check for a host in the relative url
+ // and convert it to a protocol-url
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $relative_url_parts['host'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $absolute_path .= $relative_url_parts['host'];
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $relative_url_parts['port'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -964,7 +971,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $relative_url_parts['path'] ) && '/' == $relative_url_parts['path'][0] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $path = $relative_url_parts['path'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Else it's a relative path.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Else it's a relative path.
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( ! empty( $relative_url_parts['path'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Strip off any file components from the absolute path.
</span><span class="cx" style="display: block; padding: 0 10px"> $path = substr( $path, 0, strrpos( $path, '/' ) + 1 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1052,11 +1059,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * This does not verify if the IP is a valid IP, only that it appears to be
</span><span class="cx" style="display: block; padding: 0 10px"> * an IP address.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @link http://home.deds.nl/~aeron/regex/ for IPv6 regex
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @link http://home.deds.nl/~aeron/regex/ for IPv6 regex.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $maybe_ip A suspected IP address
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $maybe_ip A suspected IP address.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return integer|bool Upon success, '4' or '6' to represent a IPv4 or IPv6 address, false upon failure
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function is_ip_address( $maybe_ip ) {
</span></span></pre>
</div>
</div>
</body>
</html>