searchwp\indexer\http_basic_auth_credentials
Since: 4.0.0
Table of Contents
This hook is deprecated
Please use searchwp\background_process\http_basic_auth_credentials
instead.
Teach the Indexer HTTP Basic Authentication credentials.
Note: these credentials are for HTTP Basic Authentication, not your WordPress login credentials.
Parameters
Type | Parameter | Default | Since | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Array |
$credentials
|
4.0.0 |
Examples
All hooks should be added to your custom SearchWP Customizations Plugin.
Provide HTTP Basic Authentication credentials
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
// @deprecated | |
// @see https://searchwp.com/documentation/hooks/searchwp-background_process-http_basic_auth_credentials/ | |
class MySearchWPBasicAuthCreds { | |
private $username = 'username'; // HTTP Basic Auth username. | |
private $password = 'password'; // HTTP Basic Auth password. | |
function __construct() { | |
// Provide HTTP Basic Authentication credentials to SearchWP. | |
add_filter( | |
'searchwp\indexer\http_basic_auth_credentials', | |
function( $credentials ) { | |
return [ | |
'username' => $this->username, | |
'password' => $this->password, | |
]; | |
} | |
); | |
// Also provide HTTP Basic Authentication credentials to WP Cron. | |
// This can be removed if handled elsewhere, otherwise *REQUIRED* | |
add_filter( 'cron_request', function( $cron_request ) { | |
if ( ! isset( $cron_request['args']['headers'] ) ) { | |
$cron_request['args']['headers'] = []; | |
} | |
if ( isset( $cron_request['args']['headers']['Authorization'] ) ) { | |
return $cron_request; | |
} | |
$cron_request['args']['headers']['Authorization'] = sprintf( | |
'Basic %s', | |
base64_encode( $this->username . ':' . $this->password ) | |
); | |
}, 999 ); | |
} | |
} | |
new MySearchWPBasicAuthCreds(); |