wppaste
WordPress

Basic

Source
wp-includes/Requests/src/Auth/Basic.php:23
Basic Authentication provider

Description

Provides a handler for Basic HTTP authentication via the Authorization header.

Compatibility

WordPress
core
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Properties · 2

$userstringpublic
Username
$passstringpublic
Password

Methods · 5

Source code

class Basic implements Auth {	/**	 * Username	 *	 * @var string	 */	public $user; 	/**	 * Password	 *	 * @var string	 */	public $pass; 	/**	 * Constructor	 *	 * @since 2.0 Throws an `InvalidArgument` exception.	 * @since 2.0 Throws an `ArgumentCount` exception instead of the Requests base `Exception.	 *	 * @param array|null $args Array of user and password. Must have exactly two elements	 *	 * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not an array or null.	 * @throws \WpOrg\Requests\Exception\ArgumentCount   On incorrect number of array elements (`authbasicbadargs`).	 */	public function __construct($args = null) {		if (is_array($args)) {			if (count($args) !== 2) {				throw ArgumentCount::create('an array with exactly two elements', count($args), 'authbasicbadargs');			} 			list($this->user, $this->pass) = $args;			return;		} 		if ($args !== null) {			throw InvalidArgument::create(1, '$args', 'array|null', gettype($args));		}	} 	/**	 * Register the necessary callbacks	 *	 * @see \WpOrg\Requests\Auth\Basic::curl_before_send()	 * @see \WpOrg\Requests\Auth\Basic::fsockopen_header()	 * @param \WpOrg\Requests\Hooks $hooks Hook system	 */	public function register(Hooks $hooks) {		$hooks->register('curl.before_send', [$this, 'curl_before_send']);		$hooks->register('fsockopen.after_headers', [$this, 'fsockopen_header']);	} 	/**	 * Set cURL parameters before the data is sent	 *	 * @param resource|\CurlHandle $handle cURL handle	 */	public function curl_before_send(&$handle) {		curl_setopt($handle, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);		curl_setopt($handle, CURLOPT_USERPWD, $this->getAuthString());	} 	/**	 * Add extra headers to the request before sending	 *	 * @param string $out HTTP header string	 */	public function fsockopen_header(&$out) {		$out .= sprintf("Authorization: Basic %s\r\n", base64_encode($this->getAuthString()));	} 	/**	 * Get the authentication string (user:pass)	 *	 * @return string	 */	public function getAuthString() {		return $this->user . ':' . $this->pass;	}

Changelog

Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/Requests/src/Auth/Basic.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.