Skip to content

Commit

Permalink
Merge pull request #883 from WordPress/feature/auto-ghpages-update-
Browse files Browse the repository at this point in the history 
📚 Update GHPages website
  • Loading branch information
@jrfnl
jrfnl authored Jul 8, 2024
2 parents 4490270 + 3349359 commit f9adebd
Show file tree
Hide file tree
Showing 159 changed files with 4,860 additions and 3,041 deletions.
65 changes: 44 additions & 21 deletions api-2.x/classes/WpOrg-Requests-Auth-Basic.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Requests 2.0.11 API</title>
<title>Requests 2.0.12 API</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
Expand All @@ -25,7 +25,7 @@
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Requests 2.0.11 API</a></h1>
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Requests 2.0.12 API</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
Expand Down Expand Up @@ -54,7 +54,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Req
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/wporg.html" class="">WpOrg</a>
Expand All @@ -67,7 +67,7 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</ul>

</section>
<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Requests.html" class="">Requests</a>
Expand Down Expand Up @@ -113,14 +113,14 @@ <h4 class="phpdocumentor-sidebar__root-namespace">

</section>

<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -reports">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>

<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
Expand Down Expand Up @@ -167,6 +167,7 @@ <h2 class="phpdocumentor-content__title">

<p class="phpdocumentor-summary">Basic Authentication provider</p>


<section class="phpdocumentor-description"><p>Provides a handler for Basic HTTP authentication via the Authorization
header.</p>
</section>
Expand All @@ -175,6 +176,8 @@ <h2 class="phpdocumentor-content__title">





<h3 id="toc">
Table of Contents
<a href="classes/WpOrg-Requests-Auth-Basic.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
Expand Down Expand Up @@ -203,14 +206,14 @@ <h4 id="toc-properties">
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/WpOrg-Requests-Auth-Basic.html#property_pass">$pass</a>
<a class="" href="classes/WpOrg-Requests-Auth-Basic.html#property_pass">$pass</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Password</dd>

<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/WpOrg-Requests-Auth-Basic.html#property_user">$user</a>
<a class="" href="classes/WpOrg-Requests-Auth-Basic.html#property_user">$user</a>
<span>
&nbsp;: string </span>
</dt>
Expand All @@ -225,35 +228,35 @@ <h4 id="toc-methods">
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/WpOrg-Requests-Auth-Basic.html#method___construct">__construct()</a>
<a class="" href="classes/WpOrg-Requests-Auth-Basic.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Constructor</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/WpOrg-Requests-Auth-Basic.html#method_curl_before_send">curl_before_send()</a>
<a class="" href="classes/WpOrg-Requests-Auth-Basic.html#method_curl_before_send">curl_before_send()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set cURL parameters before the data is sent</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/WpOrg-Requests-Auth-Basic.html#method_fsockopen_header">fsockopen_header()</a>
<a class="" href="classes/WpOrg-Requests-Auth-Basic.html#method_fsockopen_header">fsockopen_header()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Add extra headers to the request before sending</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/WpOrg-Requests-Auth-Basic.html#method_getAuthString">getAuthString()</a>
<a class="" href="classes/WpOrg-Requests-Auth-Basic.html#method_getAuthString">getAuthString()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the authentication string (user:pass)</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/WpOrg-Requests-Auth-Basic.html#method_register">register()</a>
<a class="" href="classes/WpOrg-Requests-Auth-Basic.html#method_register">register()</a>
<span>
&nbsp;: mixed </span>
</dt>
Expand All @@ -263,7 +266,6 @@ <h4 id="toc-methods">







Expand Down Expand Up @@ -296,6 +298,7 @@ <h4 class="phpdocumentor-element__name" id="property_pass">

<p class="phpdocumentor-summary">Password</p>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
Expand All @@ -306,6 +309,8 @@ <h4 class="phpdocumentor-element__name" id="property_pass">





</article>
<article
class="
Expand All @@ -330,6 +335,7 @@ <h4 class="phpdocumentor-element__name" id="property_user">

<p class="phpdocumentor-summary">Username</p>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
Expand All @@ -340,6 +346,8 @@ <h4 class="phpdocumentor-element__name" id="property_user">





</article>
</section>

Expand Down Expand Up @@ -376,6 +384,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<div class="phpdocumentor-label-line">
</div>


<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
Expand Down Expand Up @@ -439,6 +448,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
</dl>




</article>
<article
class="phpdocumentor-element
Expand Down Expand Up @@ -467,6 +478,7 @@ <h4 class="phpdocumentor-element__name" id="method_curl_before_send">
<div class="phpdocumentor-label-line">
</div>


<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
Expand All @@ -483,6 +495,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>





</article>
<article
class="phpdocumentor-element
Expand Down Expand Up @@ -511,6 +525,7 @@ <h4 class="phpdocumentor-element__name" id="method_fsockopen_header">
<div class="phpdocumentor-label-line">
</div>


<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
Expand All @@ -527,6 +542,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>





</article>
<article
class="phpdocumentor-element
Expand Down Expand Up @@ -557,6 +574,9 @@ <h4 class="phpdocumentor-element__name" id="method_getAuthString">







<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
Expand Down Expand Up @@ -591,6 +611,7 @@ <h4 class="phpdocumentor-element__name" id="method_register">
<div class="phpdocumentor-label-line">
</div>


<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
Expand Down Expand Up @@ -630,6 +651,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
</dl>




</article>
</section>

Expand Down Expand Up @@ -744,19 +767,19 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/WpOrg-Requests-Auth-Basic.html#property_pass">$pass<a href="classes/WpOrg-Requests-Auth-Basic.html"></li>
<li><a href="classes/WpOrg-Requests-Auth-Basic.html#property_user">$user<a href="classes/WpOrg-Requests-Auth-Basic.html"></li>
<li class=""><a href="classes/WpOrg-Requests-Auth-Basic.html#property_pass">$pass</li>
<li class=""><a href="classes/WpOrg-Requests-Auth-Basic.html#property_user">$user</li>
</ul>
</li>

<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/WpOrg-Requests-Auth-Basic.html#method___construct">__construct()</a></li>
<li><a href="classes/WpOrg-Requests-Auth-Basic.html#method_curl_before_send">curl_before_send()</a></li>
<li><a href="classes/WpOrg-Requests-Auth-Basic.html#method_fsockopen_header">fsockopen_header()</a></li>
<li><a href="classes/WpOrg-Requests-Auth-Basic.html#method_getAuthString">getAuthString()</a></li>
<li><a href="classes/WpOrg-Requests-Auth-Basic.html#method_register">register()</a></li>
<li class=""><a href="classes/WpOrg-Requests-Auth-Basic.html#method___construct">__construct()</a></li>
<li class=""><a href="classes/WpOrg-Requests-Auth-Basic.html#method_curl_before_send">curl_before_send()</a></li>
<li class=""><a href="classes/WpOrg-Requests-Auth-Basic.html#method_fsockopen_header">fsockopen_header()</a></li>
<li class=""><a href="classes/WpOrg-Requests-Auth-Basic.html#method_getAuthString">getAuthString()</a></li>
<li class=""><a href="classes/WpOrg-Requests-Auth-Basic.html#method_register">register()</a></li>
</ul>
</li>
</ul>
Expand Down
24 changes: 15 additions & 9 deletions api-2.x/classes/WpOrg-Requests-Auth.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Requests 2.0.11 API</title>
<title>Requests 2.0.12 API</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
Expand All @@ -25,7 +25,7 @@
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Requests 2.0.11 API</a></h1>
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Requests 2.0.12 API</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
Expand Down Expand Up @@ -54,7 +54,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Req
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/wporg.html" class="">WpOrg</a>
Expand All @@ -67,7 +67,7 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
</ul>

</section>
<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Requests.html" class="">Requests</a>
Expand Down Expand Up @@ -113,14 +113,14 @@ <h4 class="phpdocumentor-sidebar__root-namespace">

</section>

<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -reports">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>

<section class="phpdocumentor-sidebar__category">
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
Expand Down Expand Up @@ -154,6 +154,7 @@ <h2 class="phpdocumentor-content__title">

<p class="phpdocumentor-summary">Authentication provider interface</p>


<section class="phpdocumentor-description"><p>Implement this interface to act as an authentication provider.</p>
<p>Parameters should be passed via the constructor where possible, as this
makes it much easier for users to use your provider.</p>
Expand All @@ -174,7 +175,9 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">


</dd>
</dl>
</dl>





Expand All @@ -200,7 +203,7 @@ <h4 id="toc-methods">
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/WpOrg-Requests-Auth.html#method_register">register()</a>
<a class="" href="classes/WpOrg-Requests-Auth.html#method_register">register()</a>
<span>
&nbsp;: mixed </span>
</dt>
Expand Down Expand Up @@ -245,6 +248,7 @@ <h4 class="phpdocumentor-element__name" id="method_register">

<div class="phpdocumentor-label-line">
</div>

<section class="phpdocumentor-description"><p>This method is called in <a href="classes/WpOrg-Requests-Requests.html#method_request"><abbr title="\WpOrg\Requests\Requests::request()">Requests::request()</abbr></a> when the user
has set an instance as the 'auth' option. Use this callback to register all the
hooks you'll need.</p>
Expand Down Expand Up @@ -281,6 +285,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
</dl>




</article>
</section>

Expand Down Expand Up @@ -394,7 +400,7 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/WpOrg-Requests-Auth.html#method_register">register()</a></li>
<li class=""><a href="classes/WpOrg-Requests-Auth.html#method_register">register()</a></li>
</ul>
</li>

Expand Down
Loading

0 comments on commit f9adebd

Please sign in to comment.