PageRenderTime 58ms CodeModel.GetById 29ms RepoModel.GetById 1ms app.codeStats 0ms

/db_wp-admin_includes_schema.html

https://github.com/benatkin/wp-docblox-docs
HTML | 377 lines | 356 code | 21 blank | 0 comment | 0 complexity | c48e39b64e8b9f6e6297f70c88c051bf MD5 | raw file
    

  1. <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    2. 

  2. <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">
    3. 

  3.             $(document).ready(function() {
    4. 

  4.                 $(".filetree").treeview({
    5. 

  5.                     collapsed: true,
    6. 

  6.                     persist: "cookie"
    7. 

  7.                 });
    8. 

  8. 

  9.                 $("#accordion").accordion({
    10. 

  10.                     collapsible: true,
    11. 

  11.                     autoHeight:  false,
    12. 

  12.                     fillSpace:   true
    13. 

  13.                 });
    14. 

  14. 

  15.                 $(".tabs").tabs();
    16. 

  16.             });
    17. 

  17.         </script></head><body><div xmlns="" id="content">
    18. 

  18. <script type="text/javascript" src="js/menu.js"></script><script>
    19. 

  19. 

  20.       function filterElements()
    21. 

  21.       {
    22. 

  22.         inherited = !$('a#show-inherited').hasClass('deselected');
    23. 

  23.         public    = !$('a#show-public').hasClass('deselected');
    24. 

  24.         protected = !$('a#show-protected').hasClass('deselected');
    25. 

  25.         private   = !$('a#show-private').hasClass('deselected');
    26. 

  26. 

  27.         $('div.public').each(function(index, val) {
    28. 

  28.             $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
    29. 

  29.         });
    30. 

  30.         $('div.protected').each(function(index, val) {
    31. 

  31.             $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
    32. 

  32.         });
    33. 

  33.         $('div.private').each(function(index, val) {
    34. 

  34.             $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
    35. 

  35.         });
    36. 

  36.       }
    37. 

  37. 

  38.       $(document).ready(function() {
    39. 

  39.         $('a.gripper').click(function() {
    40. 

  40.             $(this).nextAll('div.code-tabs').slideToggle();
    41. 

  41.             $(this).children('img').toggle();
    42. 

  42.             return false;
    43. 

  43.         });
    44. 

  44. 

  45.         $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');
    46. 

  46. 

  47.         $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
    48. 

  48.             $(this).parent().nextAll('div.code-tabs').slideToggle();
    49. 

  49.             $(this).parent().prevAll('a.gripper').children('img').toggle();
    50. 

  50.             return false;
    51. 

  51.         });
    52. 

  52. 

  53.         $('div.code-tabs').hide();
    54. 

  54.         $('a.gripper').show();
    55. 

  55.         $('div.code-tabs:empty').prevAll('a.gripper').html('');
    56. 

  56.         $('div.file-nav').show();
    57. 

  57. 

  58.         $('a#show-public, a#show-protected, a#show-private, a#show-inherited').click(function(){
    59. 

  59.             $(this).toggleClass('deselected');
    60. 

  60.             if ($(this).hasClass('deselected')) {
    61. 

  61.               $(this).fadeTo('fast', '0.4');
    62. 

  62.             } else {
    63. 

  63.               $(this).fadeTo('fast', '1.0');
    64. 

  64.             }
    65. 

  65.             filterElements();
    66. 

  66.             return false;
    67. 

  67.         });
    68. 

  68.         $('a#show-protected, a#show-private').click();
    69. 

  69. 

  70.       });
    71. 

  71.       
    72. 

  72.     </script><h1 class="file">wp-admin/includes/schema.php</h1>
    73. 

  73. <div class="file-nav">
    74. 

  74. <ul id="file-nav"><li><a href="#top">Global</a></li></ul>
    75. 

  75. <div style="float: right;padding-right: 20px;">
    76. 

  76.               Show:
    77. 

  77.               <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>
    78. 

  78. </div>
    79. 

  79. </div>
    80. 

  80. <a name="top" class="anchor"></a><div id="file-description">
    81. 

  81. <p class="short-description">WordPress Administration Scheme API</p>
    82. 

  82. <div class="long-description"><p>Here we keep the DB structure and option values.</p>
    83. 

  83. </div>
    84. 

  84. </div>
    85. 

  85. <dl class="file-info">
    86. 

  86. <dt>Package</dt>
    87. 

  87. <dd>WordPress
    88. 

  88.          
    89. 

  89.     </dd>
    90. 

  90. <dt>Subpackage</dt>
    91. 

  91. <dd>Administration
    92. 

  92.          
    93. 

  93.     </dd>
    94. 

  94. </dl>
    95. 

  95. <a name="functions" class="anchor"></a><h2>Functions</h2>
    96. 

  96. <div>
    97. 

  97. <a id="::populate_network()" class="anchor"></a><div class="function ">
    98. 

  98. <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">(
    99. 

  99.           int $network_id
    100. 

  100.               =
    101. 

  101.               1,  $domain
    102. 

  102.               =
    103. 

  103.               '',  $email
    104. 

  104.               =
    105. 

  105.               '',  $site_name
    106. 

  106.               =
    107. 

  107.               '',  $path
    108. 

  108.               =
    109. 

  109.               '/',  $subdomain_install
    110. 

  110.               =
    111. 

  111.               false
    112. 

  112.           )
    113. 

  113.         </span>
    114. 

  114.         :
    115. 

  115.           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>
    116. 

  116. <div class="code-tabs">
    117. 

  117. <div class="long-description">
    118. 

  118. </div>
    119. 

  119. <strong>Parameters</strong><table class="argument-info">
    120. 

  120. <thead><tr>
    121. 

  121. <th>Name</th>
    122. 

  122. <th>Type</th>
    123. 

  123. <th>Description</th>
    124. 

  124. </tr></thead>
    125. 

  125. <tr>
    126. 

  126. <th>$network_id</th>
    127. 

  127. <td>int</td>
    128. 

  128. <td><em><p>id of network to populate</p></em></td>
    129. 

  129. </tr>
    130. 

  130. <tr>
    131. 

  131. <th>$domain</th>
    132. 

  132. <td></td>
    133. 

  133. <td><em></em></td>
    134. 

  134. </tr>
    135. 

  135. <tr>
    136. 

  136. <th>$email</th>
    137. 

  137. <td></td>
    138. 

  138. <td><em></em></td>
    139. 

  139. </tr>
    140. 

  140. <tr>
    141. 

  141. <th>$site_name</th>
    142. 

  142. <td></td>
    143. 

  143. <td><em></em></td>
    144. 

  144. </tr>
    145. 

  145. <tr>
    146. 

  146. <th>$path</th>
    147. 

  147. <td></td>
    148. 

  148. <td><em></em></td>
    149. 

  149. </tr>
    150. 

  150. <tr>
    151. 

  151. <th>$subdomain_install</th>
    152. 

  152. <td></td>
    153. 

  153. <td><em></em></td>
    154. 

  154. </tr>
    155. 

  155. </table>
    156. 

  156. <strong>Returns</strong><table class="argument-info">
    157. 

  157. <thead><tr>
    158. 

  158. <th>Type</th>
    159. 

  159. <th>Description</th>
    160. 

  160. </tr></thead>
    161. 

  161. <tr>
    162. 

  162. <td>bool|<a href="db_wp-includes_class-wp-error.html#%5CWP_Error">\WP_Error</a>
    163. 

  163. </td>
    164. 

  164. <td>True on success, or WP_Error on warning (with the install otherwise successful, so the error code must be checked) or failure.</td>
    165. 

  165. </tr>
    166. 

  166. </table>
    167. 

  167. <strong>Details</strong><dl class="function-info">
    168. 

  168. <dt>Since</dt>
    169. 

  169. <dd>3.0.0
    170. 

  170.          
    171. 

  171.     </dd>
    172. 

  172. </dl>
    173. 

  173. </div>
    174. 

  174. <div class="clear"></div>
    175. 

  175. </div>
    176. 

  176. <a id="::populate_options()" class="anchor"></a><div class="function ">
    177. 

  177. <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">(
    178. 

  178.           
    179. 

  179.           )
    180. 

  180.         </span>
    181. 

  181.         :
    182. 

  182.           void</code><div class="description"><p class="short_description">Create WordPress options and set the default values.</p></div>
    183. 

  183. <div class="code-tabs">
    184. 

  184. <div class="long-description">
    185. 

  185. </div>
    186. 

  186. <strong>Details</strong><dl class="function-info">
    187. 

  187. <dt>Since</dt>
    188. 

  188. <dd>1.5.0
    189. 

  189.          
    190. 

  190.     </dd>
    191. 

  191. <dt>Uses</dt>
    192. 

  192. <dd>\$wpdb
    193. 

  193.          
    194. 

  194.     </dd>
    195. 

  195. <dt>Uses</dt>
    196. 

  196. <dd>\$wp_db_version
    197. 

  197.          
    198. 

  198.     </dd>
    199. 

  199. </dl>
    200. 

  200. </div>
    201. 

  201. <div class="clear"></div>
    202. 

  202. </div>
    203. 

  203. <a id="::populate_roles()" class="anchor"></a><div class="function ">
    204. 

  204. <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">(
    205. 

  205.           
    206. 

  206.           )
    207. 

  207.         </span>
    208. 

  208.         :
    209. 

  209.           void</code><div class="description"><p class="short_description">Execute WordPress role creation for the various WordPress versions.</p></div>
    210. 

  210. <div class="code-tabs">
    211. 

  211. <div class="long-description">
    212. 

  212. </div>
    213. 

  213. <strong>Details</strong><dl class="function-info">
    214. 

  214. <dt>Since</dt>
    215. 

  215. <dd>2.0.0
    216. 

  216.          
    217. 

  217.     </dd>
    218. 

  218. </dl>
    219. 

  219. </div>
    220. 

  220. <div class="clear"></div>
    221. 

  221. </div>
    222. 

  222. <a id="::populate_roles_160()" class="anchor"></a><div class="function ">
    223. 

  223. <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">(
    224. 

  224.           
    225. 

  225.           )
    226. 

  226.         </span>
    227. 

  227.         :
    228. 

  228.           void</code><div class="description"><p class="short_description">Create the roles for WordPress 2.0</p></div>
    229. 

  229. <div class="code-tabs">
    230. 

  230. <div class="long-description">
    231. 

  231. </div>
    232. 

  232. <strong>Details</strong><dl class="function-info">
    233. 

  233. <dt>Since</dt>
    234. 

  234. <dd>2.0.0
    235. 

  235.          
    236. 

  236.     </dd>
    237. 

  237. </dl>
    238. 

  238. </div>
    239. 

  239. <div class="clear"></div>
    240. 

  240. </div>
    241. 

  241. <a id="::populate_roles_210()" class="anchor"></a><div class="function ">
    242. 

  242. <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">(
    243. 

  243.           
    244. 

  244.           )
    245. 

  245.         </span>
    246. 

  246.         :
    247. 

  247.           void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.1.</p></div>
    248. 

  248. <div class="code-tabs">
    249. 

  249. <div class="long-description">
    250. 

  250. </div>
    251. 

  251. <strong>Details</strong><dl class="function-info">
    252. 

  252. <dt>Since</dt>
    253. 

  253. <dd>2.1.0
    254. 

  254.          
    255. 

  255.     </dd>
    256. 

  256. </dl>
    257. 

  257. </div>
    258. 

  258. <div class="clear"></div>
    259. 

  259. </div>
    260. 

  260. <a id="::populate_roles_230()" class="anchor"></a><div class="function ">
    261. 

  261. <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">(
    262. 

  262.           
    263. 

  263.           )
    264. 

  264.         </span>
    265. 

  265.         :
    266. 

  266.           void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.3.</p></div>
    267. 

  267. <div class="code-tabs">
    268. 

  268. <div class="long-description">
    269. 

  269. </div>
    270. 

  270. <strong>Details</strong><dl class="function-info">
    271. 

  271. <dt>Since</dt>
    272. 

  272. <dd>2.3.0
    273. 

  273.          
    274. 

  274.     </dd>
    275. 

  275. </dl>
    276. 

  276. </div>
    277. 

  277. <div class="clear"></div>
    278. 

  278. </div>
    279. 

  279. <a id="::populate_roles_250()" class="anchor"></a><div class="function ">
    280. 

  280. <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">(
    281. 

  281.           
    282. 

  282.           )
    283. 

  283.         </span>
    284. 

  284.         :
    285. 

  285.           void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.5.</p></div>
    286. 

  286. <div class="code-tabs">
    287. 

  287. <div class="long-description">
    288. 

  288. </div>
    289. 

  289. <strong>Details</strong><dl class="function-info">
    290. 

  290. <dt>Since</dt>
    291. 

  291. <dd>2.5.0
    292. 

  292.          
    293. 

  293.     </dd>
    294. 

  294. </dl>
    295. 

  295. </div>
    296. 

  296. <div class="clear"></div>
    297. 

  297. </div>
    298. 

  298. <a id="::populate_roles_260()" class="anchor"></a><div class="function ">
    299. 

  299. <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">(
    300. 

  300.           
    301. 

  301.           )
    302. 

  302.         </span>
    303. 

  303.         :
    304. 

  304.           void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.6.</p></div>
    305. 

  305. <div class="code-tabs">
    306. 

  306. <div class="long-description">
    307. 

  307. </div>
    308. 

  308. <strong>Details</strong><dl class="function-info">
    309. 

  309. <dt>Since</dt>
    310. 

  310. <dd>2.6.0
    311. 

  311.          
    312. 

  312.     </dd>
    313. 

  313. </dl>
    314. 

  314. </div>
    315. 

  315. <div class="clear"></div>
    316. 

  316. </div>
    317. 

  317. <a id="::populate_roles_270()" class="anchor"></a><div class="function ">
    318. 

  318. <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">(
    319. 

  319.           
    320. 

  320.           )
    321. 

  321.         </span>
    322. 

  322.         :
    323. 

  323.           void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.7.</p></div>
    324. 

  324. <div class="code-tabs">
    325. 

  325. <div class="long-description">
    326. 

  326. </div>
    327. 

  327. <strong>Details</strong><dl class="function-info">
    328. 

  328. <dt>Since</dt>
    329. 

  329. <dd>2.7.0
    330. 

  330.          
    331. 

  331.     </dd>
    332. 

  332. </dl>
    333. 

  333. </div>
    334. 

  334. <div class="clear"></div>
    335. 

  335. </div>
    336. 

  336. <a id="::populate_roles_280()" class="anchor"></a><div class="function ">
    337. 

  337. <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">(
    338. 

  338.           
    339. 

  339.           )
    340. 

  340.         </span>
    341. 

  341.         :
    342. 

  342.           void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 2.8.</p></div>
    343. 

  343. <div class="code-tabs">
    344. 

  344. <div class="long-description">
    345. 

  345. </div>
    346. 

  346. <strong>Details</strong><dl class="function-info">
    347. 

  347. <dt>Since</dt>
    348. 

  348. <dd>2.8.0
    349. 

  349.          
    350. 

  350.     </dd>
    351. 

  351. </dl>
    352. 

  352. </div>
    353. 

  353. <div class="clear"></div>
    354. 

  354. </div>
    355. 

  355. <a id="::populate_roles_300()" class="anchor"></a><div class="function ">
    356. 

  356. <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">(
    357. 

  357.           
    358. 

  358.           )
    359. 

  359.         </span>
    360. 

  360.         :
    361. 

  361.           void</code><div class="description"><p class="short_description">Create and modify WordPress roles for WordPress 3.0.</p></div>
    362. 

  362. <div class="code-tabs">
    363. 

  363. <div class="long-description">
    364. 

  364. </div>
    365. 

  365. <strong>Details</strong><dl class="function-info">
    366. 

  366. <dt>Since</dt>
    367. 

  367. <dd>3.0.0
    368. 

  368.          
    369. 

  369.     </dd>
    370. 

  370. </dl>
    371. 

  371. </div>
    372. 

  372. <div class="clear"></div>
    373. 

  373. </div>
    374. 

  374. </div>
    375. 

  375. </div>
    376. 

  376. <small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.14.1</a>.
    377. 

  377.     </small></body></html>
    378. 

  378.