/db_wp-admin_includes_schema.html
HTML | 377 lines | 356 code | 21 blank | 0 comment | 0 complexity | c48e39b64e8b9f6e6297f70c88c051bf MD5 | raw file
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title>WordPress Trunk</title><link rel="stylesheet" href="css/black-tie/jquery-ui-1.8.2.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
- $(document).ready(function() {
- $(".filetree").treeview({
- collapsed: true,
- persist: "cookie"
- });
- $("#accordion").accordion({
- collapsible: true,
- autoHeight: false,
- fillSpace: true
- });
- $(".tabs").tabs();
- });
- </script></head><body><div xmlns="" id="content">
- <script type="text/javascript" src="js/menu.js"></script><script>
- function filterElements()
- {
- inherited = !$('a#show-inherited').hasClass('deselected');
- public = !$('a#show-public').hasClass('deselected');
- protected = !$('a#show-protected').hasClass('deselected');
- private = !$('a#show-private').hasClass('deselected');
- $('div.public').each(function(index, val) {
- $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
- });
- $('div.protected').each(function(index, val) {
- $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
- });
- $('div.private').each(function(index, val) {
- $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
- });
- }
- $(document).ready(function() {
- $('a.gripper').click(function() {
- $(this).nextAll('div.code-tabs').slideToggle();
- $(this).children('img').toggle();
- return false;
- });
- $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');
- $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
- $(this).parent().nextAll('div.code-tabs').slideToggle();
- $(this).parent().prevAll('a.gripper').children('img').toggle();
- return false;
- });
- $('div.code-tabs').hide();
- $('a.gripper').show();
- $('div.code-tabs:empty').prevAll('a.gripper').html('');
- $('div.file-nav').show();
- $('a#show-public, a#show-protected, a#show-private, a#show-inherited').click(function(){
- $(this).toggleClass('deselected');
- if ($(this).hasClass('deselected')) {
- $(this).fadeTo('fast', '0.4');
- } else {
- $(this).fadeTo('fast', '1.0');
- }
- filterElements();
- return false;
- });
- $('a#show-protected, a#show-private').click();
- });
-
- </script><h1 class="file">wp-admin/includes/schema.php</h1>
- <div class="file-nav">
- <ul id="file-nav"><li><a href="#top">Global</a></li></ul>
- <div style="float: right;padding-right: 20px;">
- Show:
- <a href="#" id="show-public"><img src="images/icons/visibility_public.png"></a><a href="#" id="show-protected"><img src="images/icons/visibility_protected.png"></a><a href="#" id="show-private"><img src="images/icons/visibility_private.png"></a><a href="#" id="show-inherited"><span class="attribute">inherited</span></a>
- </div>
- </div>
- <a name="top" class="anchor"></a><div id="file-description">
- <p class="short-description">WordPress Administration Scheme API</p>
- <div class="long-description"><p>Here we keep the DB structure and option values.</p>
- </div>
- </div>
- <dl class="file-info">
- <dt>Package</dt>
- <dd>WordPress
-
- </dd>
- <dt>Subpackage</dt>
- <dd>Administration
-
- </dd>
- </dl>
- <a name="functions" class="anchor"></a><h2>Functions</h2>
- <div>
- <a id="::populate_network()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_network</span><span class="nb-faded-text">(
- int $network_id
- =
- 1, $domain
- =
- '', $email
- =
- '', $site_name
- =
- '', $path
- =
- '/', $subdomain_install
- =
- false
- )
- </span>
- :
- bool|<a href="db_wp-includes_class-wp-error.html#%5CWP_Error">\WP_Error</a></code><div class="description"><p class="short_description">populate network settings</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Parameters</strong><table class="argument-info">
- <thead><tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- </tr></thead>
- <tr>
- <th>$network_id</th>
- <td>int</td>
- <td><em><p>id of network to populate</p></em></td>
- </tr>
- <tr>
- <th>$domain</th>
- <td></td>
- <td><em></em></td>
- </tr>
- <tr>
- <th>$email</th>
- <td></td>
- <td><em></em></td>
- </tr>
- <tr>
- <th>$site_name</th>
- <td></td>
- <td><em></em></td>
- </tr>
- <tr>
- <th>$path</th>
- <td></td>
- <td><em></em></td>
- </tr>
- <tr>
- <th>$subdomain_install</th>
- <td></td>
- <td><em></em></td>
- </tr>
- </table>
- <strong>Returns</strong><table class="argument-info">
- <thead><tr>
- <th>Type</th>
- <th>Description</th>
- </tr></thead>
- <tr>
- <td>bool|<a href="db_wp-includes_class-wp-error.html#%5CWP_Error">\WP_Error</a>
- </td>
- <td>True on success, or WP_Error on warning (with the install otherwise successful, so the error code must be checked) or failure.</td>
- </tr>
- </table>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>3.0.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_options()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_options</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Create WordPress options and set the default values.</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>1.5.0
-
- </dd>
- <dt>Uses</dt>
- <dd>\$wpdb
-
- </dd>
- <dt>Uses</dt>
- <dd>\$wp_db_version
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_roles()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_roles</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Execute WordPress role creation for the various WordPress versions.</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>2.0.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_roles_160()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_roles_160</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Create the roles for WordPress 2.0</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>2.0.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_roles_210()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_roles_210</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.1.</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>2.1.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_roles_230()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_roles_230</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.3.</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>2.3.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_roles_250()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_roles_250</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.5.</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>2.5.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_roles_260()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_roles_260</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.6.</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>2.6.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_roles_270()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_roles_270</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.7.</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>2.7.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_roles_280()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_roles_280</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.8.</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>2.8.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- <a id="::populate_roles_300()" class="anchor"></a><div class="function ">
- <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">populate_roles_300</span><span class="nb-faded-text">(
-
- )
- </span>
- :
- void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 3.0.</p></div>
- <div class="code-tabs">
- <div class="long-description">
- </div>
- <strong>Details</strong><dl class="function-info">
- <dt>Since</dt>
- <dd>3.0.0
-
- </dd>
- </dl>
- </div>
- <div class="clear"></div>
- </div>
- </div>
- </div>
- <small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.14.1</a>.
- </small></body></html>