PageRenderTime 56ms CodeModel.GetById 18ms RepoModel.GetById 0ms app.codeStats 0ms

/db_wp-includes_ms-deprecated.html

https://github.com/benatkin/wp-docblox-docs
HTML | 517 lines | 504 code | 13 blank | 0 comment | 0 complexity | 8ef2c3f3370a311d07d8ef6fd2ee957d 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. <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. $(document).ready(function() {
  4. $(".filetree").treeview({
  5. collapsed: true,
  6. persist: "cookie"
  7. });
  8. $("#accordion").accordion({
  9. collapsible: true,
  10. autoHeight: false,
  11. fillSpace: true
  12. });
  13. $(".tabs").tabs();
  14. });
  15. </script></head><body><div xmlns="" id="content">
  16. <script type="text/javascript" src="js/menu.js"></script><script>
  17. function filterElements()
  18. {
  19. inherited = !$('a#show-inherited').hasClass('deselected');
  20. public = !$('a#show-public').hasClass('deselected');
  21. protected = !$('a#show-protected').hasClass('deselected');
  22. private = !$('a#show-private').hasClass('deselected');
  23. $('div.public').each(function(index, val) {
  24. $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
  25. });
  26. $('div.protected').each(function(index, val) {
  27. $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
  28. });
  29. $('div.private').each(function(index, val) {
  30. $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
  31. });
  32. }
  33. $(document).ready(function() {
  34. $('a.gripper').click(function() {
  35. $(this).nextAll('div.code-tabs').slideToggle();
  36. $(this).children('img').toggle();
  37. return false;
  38. });
  39. $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');
  40. $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
  41. $(this).parent().nextAll('div.code-tabs').slideToggle();
  42. $(this).parent().prevAll('a.gripper').children('img').toggle();
  43. return false;
  44. });
  45. $('div.code-tabs').hide();
  46. $('a.gripper').show();
  47. $('div.code-tabs:empty').prevAll('a.gripper').html('');
  48. $('div.file-nav').show();
  49. $('a#show-public, a#show-protected, a#show-private, a#show-inherited').click(function(){
  50. $(this).toggleClass('deselected');
  51. if ($(this).hasClass('deselected')) {
  52. $(this).fadeTo('fast', '0.4');
  53. } else {
  54. $(this).fadeTo('fast', '1.0');
  55. }
  56. filterElements();
  57. return false;
  58. });
  59. $('a#show-protected, a#show-private').click();
  60. });
  61. </script><h1 class="file">wp-includes/ms-deprecated.php</h1>
  62. <div class="file-nav">
  63. <ul id="file-nav"><li><a href="#top">Global</a></li></ul>
  64. <div style="float: right;padding-right: 20px;">
  65. Show:
  66. <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>
  67. </div>
  68. </div>
  69. <a name="top" class="anchor"></a><div id="file-description">
  70. <p class="short-description">Deprecated functions from WordPress MU and the multisite feature. You shouldn't
  71. use these functions and look for the alternatives instead. The functions will be
  72. removed in a later version.</p>
  73. <div class="long-description">
  74. </div>
  75. </div>
  76. <dl class="file-info">
  77. <dt>Package</dt>
  78. <dd>WordPress
  79.  
  80. </dd>
  81. <dt>Since</dt>
  82. <dd>3.0.0
  83.  
  84. </dd>
  85. <dt>Subpackage</dt>
  86. <dd>Deprecated
  87.  
  88. </dd>
  89. </dl>
  90. <a name="functions" class="anchor"></a><h2>Functions</h2>
  91. <div>
  92. <a id="::clear_global_post_cache()" class="anchor"></a><div class="function ">
  93. <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">clear_global_post_cache</span><span class="nb-faded-text">(
  94.  $post_id
  95. )
  96. </span>
  97. :
  98. void</code><div class="description"><p class="short_description"></p></div>
  99. <div class="code-tabs">
  100. <div class="long-description">
  101. </div>
  102. <strong>Parameters</strong><table class="argument-info">
  103. <thead><tr>
  104. <th>Name</th>
  105. <th>Type</th>
  106. <th>Description</th>
  107. </tr></thead>
  108. <tr>
  109. <th>$post_id</th>
  110. <td></td>
  111. <td><em></em></td>
  112. </tr>
  113. </table>
  114. <strong>Details</strong><dl class="function-info">
  115. <dt>Deprecated</dt>
  116. <dd>3.0.0
  117.  
  118. </dd>
  119. <dt>Deprecated</dt>
  120. <dd>Use clean_post_cache()
  121.  
  122. </dd>
  123. <dt>See</dt>
  124. <dd>\clean_post_cache()
  125.  
  126. </dd>
  127. <dt>Since</dt>
  128. <dd>MU
  129.  
  130. </dd>
  131. </dl>
  132. </div>
  133. <div class="clear"></div>
  134. </div>
  135. <a id="::generate_random_password()" class="anchor"></a><div class="function ">
  136. <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">generate_random_password</span><span class="nb-faded-text">(
  137.  $len
  138. =
  139. 8
  140. )
  141. </span>
  142. :
  143. void</code><div class="description"><p class="short_description"></p></div>
  144. <div class="code-tabs">
  145. <div class="long-description">
  146. </div>
  147. <strong>Parameters</strong><table class="argument-info">
  148. <thead><tr>
  149. <th>Name</th>
  150. <th>Type</th>
  151. <th>Description</th>
  152. </tr></thead>
  153. <tr>
  154. <th>$len</th>
  155. <td></td>
  156. <td><em></em></td>
  157. </tr>
  158. </table>
  159. <strong>Details</strong><dl class="function-info">
  160. <dt>Deprecated</dt>
  161. <dd>3.0.0
  162.  
  163. </dd>
  164. <dt>Deprecated</dt>
  165. <dd>Use wp_generate_password()
  166.  
  167. </dd>
  168. <dt>See</dt>
  169. <dd>\wp_generate_password()
  170.  
  171. </dd>
  172. <dt>Since</dt>
  173. <dd>MU
  174.  
  175. </dd>
  176. </dl>
  177. </div>
  178. <div class="clear"></div>
  179. </div>
  180. <a id="::get_blog_list()" class="anchor"></a><div class="function ">
  181. <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">get_blog_list</span><span class="nb-faded-text">(
  182.  $start
  183. =
  184. 0,  $num
  185. =
  186. 10,  $deprecated
  187. =
  188. ''
  189. )
  190. </span>
  191. :
  192. void</code><div class="description"><p class="short_description"></p></div>
  193. <div class="code-tabs">
  194. <div class="long-description">
  195. </div>
  196. <strong>Parameters</strong><table class="argument-info">
  197. <thead><tr>
  198. <th>Name</th>
  199. <th>Type</th>
  200. <th>Description</th>
  201. </tr></thead>
  202. <tr>
  203. <th>$start</th>
  204. <td></td>
  205. <td><em></em></td>
  206. </tr>
  207. <tr>
  208. <th>$num</th>
  209. <td></td>
  210. <td><em></em></td>
  211. </tr>
  212. <tr>
  213. <th>$deprecated</th>
  214. <td></td>
  215. <td><em></em></td>
  216. </tr>
  217. </table>
  218. <strong>Details</strong><dl class="function-info">
  219. <dt>Deprecated</dt>
  220. <dd>3.0.0
  221.  
  222. </dd>
  223. <dt>Deprecated</dt>
  224. <dd>No alternative available. For performance reasons this function is not recommended.
  225.  
  226. </dd>
  227. <dt>Since</dt>
  228. <dd>MU
  229.  
  230. </dd>
  231. </dl>
  232. </div>
  233. <div class="clear"></div>
  234. </div>
  235. <a id="::get_most_active_blogs()" class="anchor"></a><div class="function ">
  236. <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">get_most_active_blogs</span><span class="nb-faded-text">(
  237.  $num
  238. =
  239. 10,  $display
  240. =
  241. true
  242. )
  243. </span>
  244. :
  245. void</code><div class="description"><p class="short_description"></p></div>
  246. <div class="code-tabs">
  247. <div class="long-description">
  248. </div>
  249. <strong>Parameters</strong><table class="argument-info">
  250. <thead><tr>
  251. <th>Name</th>
  252. <th>Type</th>
  253. <th>Description</th>
  254. </tr></thead>
  255. <tr>
  256. <th>$num</th>
  257. <td></td>
  258. <td><em></em></td>
  259. </tr>
  260. <tr>
  261. <th>$display</th>
  262. <td></td>
  263. <td><em></em></td>
  264. </tr>
  265. </table>
  266. <strong>Details</strong><dl class="function-info">
  267. <dt>Deprecated</dt>
  268. <dd>3.0.0
  269.  
  270. </dd>
  271. <dt>Deprecated</dt>
  272. <dd>No alternative available. For performance reasons this function is not recommended.
  273.  
  274. </dd>
  275. <dt>Since</dt>
  276. <dd>MU
  277.  
  278. </dd>
  279. </dl>
  280. </div>
  281. <div class="clear"></div>
  282. </div>
  283. <a id="::get_user_details()" class="anchor"></a><div class="function ">
  284. <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">get_user_details</span><span class="nb-faded-text">(
  285.  $username
  286. )
  287. </span>
  288. :
  289. void</code><div class="description"><p class="short_description"></p></div>
  290. <div class="code-tabs">
  291. <div class="long-description">
  292. </div>
  293. <strong>Parameters</strong><table class="argument-info">
  294. <thead><tr>
  295. <th>Name</th>
  296. <th>Type</th>
  297. <th>Description</th>
  298. </tr></thead>
  299. <tr>
  300. <th>$username</th>
  301. <td></td>
  302. <td><em></em></td>
  303. </tr>
  304. </table>
  305. <strong>Details</strong><dl class="function-info">
  306. <dt>Deprecated</dt>
  307. <dd>3.0.0
  308.  
  309. </dd>
  310. <dt>Deprecated</dt>
  311. <dd>Use get_user_by()
  312.  
  313. </dd>
  314. <dt>See</dt>
  315. <dd>\get_user_by()
  316.  
  317. </dd>
  318. <dt>Since</dt>
  319. <dd>MU
  320.  
  321. </dd>
  322. </dl>
  323. </div>
  324. <div class="clear"></div>
  325. </div>
  326. <a id="::graceful_fail()" class="anchor"></a><div class="function ">
  327. <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">graceful_fail</span><span class="nb-faded-text">(
  328.  $message
  329. )
  330. </span>
  331. :
  332. void</code><div class="description"><p class="short_description"></p></div>
  333. <div class="code-tabs">
  334. <div class="long-description">
  335. </div>
  336. <strong>Parameters</strong><table class="argument-info">
  337. <thead><tr>
  338. <th>Name</th>
  339. <th>Type</th>
  340. <th>Description</th>
  341. </tr></thead>
  342. <tr>
  343. <th>$message</th>
  344. <td></td>
  345. <td><em></em></td>
  346. </tr>
  347. </table>
  348. <strong>Details</strong><dl class="function-info">
  349. <dt>Deprecated</dt>
  350. <dd>3.0.0
  351.  
  352. </dd>
  353. <dt>Deprecated</dt>
  354. <dd>Use wp_die()
  355.  
  356. </dd>
  357. <dt>See</dt>
  358. <dd>\wp_die()
  359.  
  360. </dd>
  361. <dt>Since</dt>
  362. <dd>MU
  363.  
  364. </dd>
  365. </dl>
  366. </div>
  367. <div class="clear"></div>
  368. </div>
  369. <a id="::is_main_blog()" class="anchor"></a><div class="function ">
  370. <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">is_main_blog</span><span class="nb-faded-text">(
  371. )
  372. </span>
  373. :
  374. void</code><div class="description"><p class="short_description"></p></div>
  375. <div class="code-tabs">
  376. <div class="long-description">
  377. </div>
  378. <strong>Details</strong><dl class="function-info">
  379. <dt>Deprecated</dt>
  380. <dd>3.0.0
  381.  
  382. </dd>
  383. <dt>Deprecated</dt>
  384. <dd>Use is_main_site()
  385.  
  386. </dd>
  387. <dt>See</dt>
  388. <dd>\is_main_site()
  389.  
  390. </dd>
  391. <dt>Since</dt>
  392. <dd>MU
  393.  
  394. </dd>
  395. </dl>
  396. </div>
  397. <div class="clear"></div>
  398. </div>
  399. <a id="::is_site_admin()" class="anchor"></a><div class="function ">
  400. <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">is_site_admin</span><span class="nb-faded-text">(
  401.  $user_login
  402. =
  403. ''
  404. )
  405. </span>
  406. :
  407. void</code><div class="description"><p class="short_description">Determine if user is a site admin.</p></div>
  408. <div class="code-tabs">
  409. <div class="long-description"><p>Plugins should use is_multisite() instead of checking if this function exists
  410. to determine if multisite is enabled.</p>
  411. <p>This function must reside in a file included only if is_multisite() due to
  412. legacy function_exists() checks to determine if multisite is enabled.</p>
  413. </div>
  414. <strong>Parameters</strong><table class="argument-info">
  415. <thead><tr>
  416. <th>Name</th>
  417. <th>Type</th>
  418. <th>Description</th>
  419. </tr></thead>
  420. <tr>
  421. <th>$user_login</th>
  422. <td></td>
  423. <td><em></em></td>
  424. </tr>
  425. </table>
  426. <strong>Details</strong><dl class="function-info">
  427. <dt>Deprecated</dt>
  428. <dd>3.0.0
  429.  
  430. </dd>
  431. <dt>Deprecated</dt>
  432. <dd>Use is_super_admin()
  433.  
  434. </dd>
  435. <dt>See</dt>
  436. <dd>\is_super_admin()
  437.  
  438. </dd>
  439. <dt>See</dt>
  440. <dd>\is_multisite()
  441.  
  442. </dd>
  443. <dt>Since</dt>
  444. <dd>MU
  445.  
  446. </dd>
  447. </dl>
  448. </div>
  449. <div class="clear"></div>
  450. </div>
  451. <a id="::validate_email()" class="anchor"></a><div class="function ">
  452. <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">validate_email</span><span class="nb-faded-text">(
  453.  $email,  $check_domain
  454. =
  455. true
  456. )
  457. </span>
  458. :
  459. void</code><div class="description"><p class="short_description"></p></div>
  460. <div class="code-tabs">
  461. <div class="long-description">
  462. </div>
  463. <strong>Parameters</strong><table class="argument-info">
  464. <thead><tr>
  465. <th>Name</th>
  466. <th>Type</th>
  467. <th>Description</th>
  468. </tr></thead>
  469. <tr>
  470. <th>$email</th>
  471. <td></td>
  472. <td><em></em></td>
  473. </tr>
  474. <tr>
  475. <th>$check_domain</th>
  476. <td></td>
  477. <td><em></em></td>
  478. </tr>
  479. </table>
  480. <strong>Details</strong><dl class="function-info">
  481. <dt>Deprecated</dt>
  482. <dd>3.0.0
  483.  
  484. </dd>
  485. <dt>Deprecated</dt>
  486. <dd>Use is_email()
  487.  
  488. </dd>
  489. <dt>See</dt>
  490. <dd>\is_email()
  491.  
  492. </dd>
  493. <dt>Since</dt>
  494. <dd>MU
  495.  
  496. </dd>
  497. </dl>
  498. </div>
  499. <div class="clear"></div>
  500. </div>
  501. </div>
  502. </div>
  503. <small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.14.1</a>.
  504. </small></body></html>