PageRenderTime 55ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

/wp-includes/deprecated.php

https://github.com/younggive/WordPress
PHP | 3254 lines | 1296 code | 319 blank | 1639 comment | 197 complexity | 6a61f1b1345ba26fb7e329a9dace3a51 MD5 | raw file
Possible License(s): GPL-2.0, AGPL-1.0, LGPL-2.1
  1. <?php
  2. /**
  3. * Deprecated functions from past WordPress versions. You shouldn't use these
  4. * functions and look for the alternatives instead. The functions will be
  5. * removed in a later version.
  6. *
  7. * @package WordPress
  8. * @subpackage Deprecated
  9. */
  10. /*
  11. * Deprecated functions come here to die.
  12. */
  13. /**
  14. * Entire Post data.
  15. *
  16. * @since 0.71
  17. * @deprecated 1.5.1
  18. * @deprecated Use get_post()
  19. * @see get_post()
  20. *
  21. * @param int $postid
  22. * @return array
  23. */
  24. function get_postdata($postid) {
  25. _deprecated_function( __FUNCTION__, '1.5.1', 'get_post()' );
  26. $post = get_post($postid);
  27. $postdata = array (
  28. 'ID' => $post->ID,
  29. 'Author_ID' => $post->post_author,
  30. 'Date' => $post->post_date,
  31. 'Content' => $post->post_content,
  32. 'Excerpt' => $post->post_excerpt,
  33. 'Title' => $post->post_title,
  34. 'Category' => $post->post_category,
  35. 'post_status' => $post->post_status,
  36. 'comment_status' => $post->comment_status,
  37. 'ping_status' => $post->ping_status,
  38. 'post_password' => $post->post_password,
  39. 'to_ping' => $post->to_ping,
  40. 'pinged' => $post->pinged,
  41. 'post_type' => $post->post_type,
  42. 'post_name' => $post->post_name
  43. );
  44. return $postdata;
  45. }
  46. /**
  47. * Sets up the WordPress Loop.
  48. *
  49. * @since 1.0.1
  50. * @deprecated 1.5
  51. * @deprecated Use The Loop - {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
  52. */
  53. function start_wp() {
  54. global $wp_query;
  55. _deprecated_function( __FUNCTION__, '1.5', __('new WordPress Loop') );
  56. // Since the old style loop is being used, advance the query iterator here.
  57. $wp_query->next_post();
  58. setup_postdata( get_post() );
  59. }
  60. /**
  61. * Return or Print Category ID.
  62. *
  63. * @since 0.71
  64. * @deprecated 0.71
  65. * @deprecated use get_the_category()
  66. * @see get_the_category()
  67. *
  68. * @param bool $echo
  69. * @return null|int
  70. */
  71. function the_category_ID($echo = true) {
  72. _deprecated_function( __FUNCTION__, '0.71', 'get_the_category()' );
  73. // Grab the first cat in the list.
  74. $categories = get_the_category();
  75. $cat = $categories[0]->term_id;
  76. if ( $echo )
  77. echo $cat;
  78. return $cat;
  79. }
  80. /**
  81. * Print category with optional text before and after.
  82. *
  83. * @since 0.71
  84. * @deprecated 0.71
  85. * @deprecated use get_the_category_by_ID()
  86. * @see get_the_category_by_ID()
  87. *
  88. * @param string $before
  89. * @param string $after
  90. */
  91. function the_category_head($before='', $after='') {
  92. global $currentcat, $previouscat;
  93. _deprecated_function( __FUNCTION__, '0.71', 'get_the_category_by_ID()' );
  94. // Grab the first cat in the list.
  95. $categories = get_the_category();
  96. $currentcat = $categories[0]->category_id;
  97. if ( $currentcat != $previouscat ) {
  98. echo $before;
  99. echo get_the_category_by_ID($currentcat);
  100. echo $after;
  101. $previouscat = $currentcat;
  102. }
  103. }
  104. /**
  105. * Prints link to the previous post.
  106. *
  107. * @since 1.5
  108. * @deprecated 2.0
  109. * @deprecated Use previous_post_link()
  110. * @see previous_post_link()
  111. *
  112. * @param string $format
  113. * @param string $previous
  114. * @param string $title
  115. * @param string $in_same_cat
  116. * @param int $limitprev
  117. * @param string $excluded_categories
  118. */
  119. function previous_post($format='%', $previous='previous post: ', $title='yes', $in_same_cat='no', $limitprev=1, $excluded_categories='') {
  120. _deprecated_function( __FUNCTION__, '2.0', 'previous_post_link()' );
  121. if ( empty($in_same_cat) || 'no' == $in_same_cat )
  122. $in_same_cat = false;
  123. else
  124. $in_same_cat = true;
  125. $post = get_previous_post($in_same_cat, $excluded_categories);
  126. if ( !$post )
  127. return;
  128. $string = '<a href="'.get_permalink($post->ID).'">'.$previous;
  129. if ( 'yes' == $title )
  130. $string .= apply_filters('the_title', $post->post_title, $post->ID);
  131. $string .= '</a>';
  132. $format = str_replace('%', $string, $format);
  133. echo $format;
  134. }
  135. /**
  136. * Prints link to the next post.
  137. *
  138. * @since 0.71
  139. * @deprecated 2.0
  140. * @deprecated Use next_post_link()
  141. * @see next_post_link()
  142. *
  143. * @param string $format
  144. * @param string $next
  145. * @param string $title
  146. * @param string $in_same_cat
  147. * @param int $limitnext
  148. * @param string $excluded_categories
  149. */
  150. function next_post($format='%', $next='next post: ', $title='yes', $in_same_cat='no', $limitnext=1, $excluded_categories='') {
  151. _deprecated_function( __FUNCTION__, '2.0', 'next_post_link()' );
  152. if ( empty($in_same_cat) || 'no' == $in_same_cat )
  153. $in_same_cat = false;
  154. else
  155. $in_same_cat = true;
  156. $post = get_next_post($in_same_cat, $excluded_categories);
  157. if ( !$post )
  158. return;
  159. $string = '<a href="'.get_permalink($post->ID).'">'.$next;
  160. if ( 'yes' == $title )
  161. $string .= apply_filters('the_title', $post->post_title, $post->ID);
  162. $string .= '</a>';
  163. $format = str_replace('%', $string, $format);
  164. echo $format;
  165. }
  166. /**
  167. * Whether user can create a post.
  168. *
  169. * @since 1.5
  170. * @deprecated 2.0
  171. * @deprecated Use current_user_can()
  172. * @see current_user_can()
  173. *
  174. * @param int $user_id
  175. * @param int $blog_id Not Used
  176. * @param int $category_id Not Used
  177. * @return bool
  178. */
  179. function user_can_create_post($user_id, $blog_id = 1, $category_id = 'None') {
  180. _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
  181. $author_data = get_userdata($user_id);
  182. return ($author_data->user_level > 1);
  183. }
  184. /**
  185. * Whether user can create a post.
  186. *
  187. * @since 1.5
  188. * @deprecated 2.0
  189. * @deprecated Use current_user_can()
  190. * @see current_user_can()
  191. *
  192. * @param int $user_id
  193. * @param int $blog_id Not Used
  194. * @param int $category_id Not Used
  195. * @return bool
  196. */
  197. function user_can_create_draft($user_id, $blog_id = 1, $category_id = 'None') {
  198. _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
  199. $author_data = get_userdata($user_id);
  200. return ($author_data->user_level >= 1);
  201. }
  202. /**
  203. * Whether user can edit a post.
  204. *
  205. * @since 1.5
  206. * @deprecated 2.0
  207. * @deprecated Use current_user_can()
  208. * @see current_user_can()
  209. *
  210. * @param int $user_id
  211. * @param int $post_id
  212. * @param int $blog_id Not Used
  213. * @return bool
  214. */
  215. function user_can_edit_post($user_id, $post_id, $blog_id = 1) {
  216. _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
  217. $author_data = get_userdata($user_id);
  218. $post = get_post($post_id);
  219. $post_author_data = get_userdata($post->post_author);
  220. if ( (($user_id == $post_author_data->ID) && !($post->post_status == 'publish' && $author_data->user_level < 2))
  221. || ($author_data->user_level > $post_author_data->user_level)
  222. || ($author_data->user_level >= 10) ) {
  223. return true;
  224. } else {
  225. return false;
  226. }
  227. }
  228. /**
  229. * Whether user can delete a post.
  230. *
  231. * @since 1.5
  232. * @deprecated 2.0
  233. * @deprecated Use current_user_can()
  234. * @see current_user_can()
  235. *
  236. * @param int $user_id
  237. * @param int $post_id
  238. * @param int $blog_id Not Used
  239. * @return bool
  240. */
  241. function user_can_delete_post($user_id, $post_id, $blog_id = 1) {
  242. _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
  243. // right now if one can edit, one can delete
  244. return user_can_edit_post($user_id, $post_id, $blog_id);
  245. }
  246. /**
  247. * Whether user can set new posts' dates.
  248. *
  249. * @since 1.5
  250. * @deprecated 2.0
  251. * @deprecated Use current_user_can()
  252. * @see current_user_can()
  253. *
  254. * @param int $user_id
  255. * @param int $blog_id Not Used
  256. * @param int $category_id Not Used
  257. * @return bool
  258. */
  259. function user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') {
  260. _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
  261. $author_data = get_userdata($user_id);
  262. return (($author_data->user_level > 4) && user_can_create_post($user_id, $blog_id, $category_id));
  263. }
  264. /**
  265. * Whether user can delete a post.
  266. *
  267. * @since 1.5
  268. * @deprecated 2.0
  269. * @deprecated Use current_user_can()
  270. * @see current_user_can()
  271. *
  272. * @param int $user_id
  273. * @param int $post_id
  274. * @param int $blog_id Not Used
  275. * @return bool returns true if $user_id can edit $post_id's date
  276. */
  277. function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) {
  278. _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
  279. $author_data = get_userdata($user_id);
  280. return (($author_data->user_level > 4) && user_can_edit_post($user_id, $post_id, $blog_id));
  281. }
  282. /**
  283. * Whether user can delete a post.
  284. *
  285. * @since 1.5
  286. * @deprecated 2.0
  287. * @deprecated Use current_user_can()
  288. * @see current_user_can()
  289. *
  290. * @param int $user_id
  291. * @param int $post_id
  292. * @param int $blog_id Not Used
  293. * @return bool returns true if $user_id can edit $post_id's comments
  294. */
  295. function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) {
  296. _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
  297. // right now if one can edit a post, one can edit comments made on it
  298. return user_can_edit_post($user_id, $post_id, $blog_id);
  299. }
  300. /**
  301. * Whether user can delete a post.
  302. *
  303. * @since 1.5
  304. * @deprecated 2.0
  305. * @deprecated Use current_user_can()
  306. * @see current_user_can()
  307. *
  308. * @param int $user_id
  309. * @param int $post_id
  310. * @param int $blog_id Not Used
  311. * @return bool returns true if $user_id can delete $post_id's comments
  312. */
  313. function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) {
  314. _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
  315. // right now if one can edit comments, one can delete comments
  316. return user_can_edit_post_comments($user_id, $post_id, $blog_id);
  317. }
  318. /**
  319. * Can user can edit other user.
  320. *
  321. * @since 1.5
  322. * @deprecated 2.0
  323. * @deprecated Use current_user_can()
  324. * @see current_user_can()
  325. *
  326. * @param int $user_id
  327. * @param int $other_user
  328. * @return bool
  329. */
  330. function user_can_edit_user($user_id, $other_user) {
  331. _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
  332. $user = get_userdata($user_id);
  333. $other = get_userdata($other_user);
  334. if ( $user->user_level > $other->user_level || $user->user_level > 8 || $user->ID == $other->ID )
  335. return true;
  336. else
  337. return false;
  338. }
  339. /**
  340. * Gets the links associated with category $cat_name.
  341. *
  342. * @since 0.71
  343. * @deprecated 2.1
  344. * @deprecated Use get_bookmarks()
  345. * @see get_bookmarks()
  346. *
  347. * @param string $cat_name Optional. The category name to use. If no match is found uses all.
  348. * @param string $before Optional. The html to output before the link.
  349. * @param string $after Optional. The html to output after the link.
  350. * @param string $between Optional. The html to output between the link/image and it's description. Not used if no image or $show_images is true.
  351. * @param bool $show_images Optional. Whether to show images (if defined).
  352. * @param string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner.
  353. * If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a
  354. * random order.
  355. * @param bool $show_description Optional. Whether to show the description if show_images=false/not defined.
  356. * @param bool $show_rating Optional. Show rating stars/chars.
  357. * @param int $limit Optional. Limit to X entries. If not specified, all entries are shown.
  358. * @param int $show_updated Optional. Whether to show last updated timestamp
  359. */
  360. function get_linksbyname($cat_name = "noname", $before = '', $after = '<br />', $between = " ", $show_images = true, $orderby = 'id',
  361. $show_description = true, $show_rating = false,
  362. $limit = -1, $show_updated = 0) {
  363. _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
  364. $cat_id = -1;
  365. $cat = get_term_by('name', $cat_name, 'link_category');
  366. if ( $cat )
  367. $cat_id = $cat->term_id;
  368. get_links($cat_id, $before, $after, $between, $show_images, $orderby, $show_description, $show_rating, $limit, $show_updated);
  369. }
  370. /**
  371. * Gets the links associated with the named category.
  372. *
  373. * @since 1.0.1
  374. * @deprecated 2.1
  375. * @deprecated Use wp_list_bookmarks()
  376. * @see wp_list_bookmarks()
  377. *
  378. * @param string $category The category to use.
  379. * @param string $args
  380. * @return bool|null
  381. */
  382. function wp_get_linksbyname($category, $args = '') {
  383. _deprecated_function(__FUNCTION__, '2.1', 'wp_list_bookmarks()');
  384. $defaults = array(
  385. 'after' => '<br />',
  386. 'before' => '',
  387. 'categorize' => 0,
  388. 'category_after' => '',
  389. 'category_before' => '',
  390. 'category_name' => $category,
  391. 'show_description' => 1,
  392. 'title_li' => '',
  393. );
  394. $r = wp_parse_args( $args, $defaults );
  395. return wp_list_bookmarks($r);
  396. }
  397. /**
  398. * Gets an array of link objects associated with category $cat_name.
  399. *
  400. * <code>
  401. * $links = get_linkobjectsbyname('fred');
  402. * foreach ($links as $link) {
  403. * echo '<li>'.$link->link_name.'</li>';
  404. * }
  405. * </code>
  406. *
  407. * @since 1.0.1
  408. * @deprecated 2.1
  409. * @deprecated Use get_bookmarks()
  410. * @see get_bookmarks()
  411. *
  412. * @param string $cat_name The category name to use. If no match is found uses all.
  413. * @param string $orderby The order to output the links. E.g. 'id', 'name', 'url', 'description', or 'rating'.
  414. * Or maybe owner. If you start the name with an underscore the order will be reversed. You can also
  415. * specify 'rand' as the order which will return links in a random order.
  416. * @param int $limit Limit to X entries. If not specified, all entries are shown.
  417. * @return unknown
  418. */
  419. function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) {
  420. _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
  421. $cat_id = -1;
  422. $cat = get_term_by('name', $cat_name, 'link_category');
  423. if ( $cat )
  424. $cat_id = $cat->term_id;
  425. return get_linkobjects($cat_id, $orderby, $limit);
  426. }
  427. /**
  428. * Gets an array of link objects associated with category n.
  429. *
  430. * Usage:
  431. * <code>
  432. * $links = get_linkobjects(1);
  433. * if ($links) {
  434. * foreach ($links as $link) {
  435. * echo '<li>'.$link->link_name.'<br />'.$link->link_description.'</li>';
  436. * }
  437. * }
  438. * </code>
  439. *
  440. * Fields are:
  441. * <ol>
  442. * <li>link_id</li>
  443. * <li>link_url</li>
  444. * <li>link_name</li>
  445. * <li>link_image</li>
  446. * <li>link_target</li>
  447. * <li>link_category</li>
  448. * <li>link_description</li>
  449. * <li>link_visible</li>
  450. * <li>link_owner</li>
  451. * <li>link_rating</li>
  452. * <li>link_updated</li>
  453. * <li>link_rel</li>
  454. * <li>link_notes</li>
  455. * </ol>
  456. *
  457. * @since 1.0.1
  458. * @deprecated 2.1
  459. * @deprecated Use get_bookmarks()
  460. * @see get_bookmarks()
  461. *
  462. * @param int $category The category to use. If no category supplied uses all
  463. * @param string $orderby the order to output the links. E.g. 'id', 'name', 'url',
  464. * 'description', or 'rating'. Or maybe owner. If you start the name with an
  465. * underscore the order will be reversed. You can also specify 'rand' as the
  466. * order which will return links in a random order.
  467. * @param int $limit Limit to X entries. If not specified, all entries are shown.
  468. * @return unknown
  469. */
  470. function get_linkobjects($category = 0, $orderby = 'name', $limit = 0) {
  471. _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
  472. $links = get_bookmarks( array( 'category' => $category, 'orderby' => $orderby, 'limit' => $limit ) ) ;
  473. $links_array = array();
  474. foreach ($links as $link)
  475. $links_array[] = $link;
  476. return $links_array;
  477. }
  478. /**
  479. * Gets the links associated with category 'cat_name' and display rating stars/chars.
  480. *
  481. * @since 0.71
  482. * @deprecated 2.1
  483. * @deprecated Use get_bookmarks()
  484. * @see get_bookmarks()
  485. *
  486. * @param string $cat_name The category name to use. If no match is found uses all
  487. * @param string $before The html to output before the link
  488. * @param string $after The html to output after the link
  489. * @param string $between The html to output between the link/image and it's description. Not used if no image or show_images is true
  490. * @param bool $show_images Whether to show images (if defined).
  491. * @param string $orderby the order to output the links. E.g. 'id', 'name', 'url',
  492. * 'description', or 'rating'. Or maybe owner. If you start the name with an
  493. * underscore the order will be reversed. You can also specify 'rand' as the
  494. * order which will return links in a random order.
  495. * @param bool $show_description Whether to show the description if show_images=false/not defined
  496. * @param int $limit Limit to X entries. If not specified, all entries are shown.
  497. * @param int $show_updated Whether to show last updated timestamp
  498. */
  499. function get_linksbyname_withrating($cat_name = "noname", $before = '', $after = '<br />', $between = " ",
  500. $show_images = true, $orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) {
  501. _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
  502. get_linksbyname($cat_name, $before, $after, $between, $show_images, $orderby, $show_description, true, $limit, $show_updated);
  503. }
  504. /**
  505. * Gets the links associated with category n and display rating stars/chars.
  506. *
  507. * @since 0.71
  508. * @deprecated 2.1
  509. * @deprecated Use get_bookmarks()
  510. * @see get_bookmarks()
  511. *
  512. * @param int $category The category to use. If no category supplied uses all
  513. * @param string $before The html to output before the link
  514. * @param string $after The html to output after the link
  515. * @param string $between The html to output between the link/image and it's description. Not used if no image or show_images == true
  516. * @param bool $show_images Whether to show images (if defined).
  517. * @param string $orderby The order to output the links. E.g. 'id', 'name', 'url',
  518. * 'description', or 'rating'. Or maybe owner. If you start the name with an
  519. * underscore the order will be reversed. You can also specify 'rand' as the
  520. * order which will return links in a random order.
  521. * @param bool $show_description Whether to show the description if show_images=false/not defined.
  522. * @param string $limit Limit to X entries. If not specified, all entries are shown.
  523. * @param int $show_updated Whether to show last updated timestamp
  524. */
  525. function get_links_withrating($category = -1, $before = '', $after = '<br />', $between = " ", $show_images = true,
  526. $orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) {
  527. _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
  528. get_links($category, $before, $after, $between, $show_images, $orderby, $show_description, true, $limit, $show_updated);
  529. }
  530. /**
  531. * Gets the auto_toggle setting.
  532. *
  533. * @since 0.71
  534. * @deprecated 2.1
  535. * @deprecated No alternative function available
  536. *
  537. * @param int $id The category to get. If no category supplied uses 0
  538. * @return int Only returns 0.
  539. */
  540. function get_autotoggle($id = 0) {
  541. _deprecated_function( __FUNCTION__, '2.1' );
  542. return 0;
  543. }
  544. /**
  545. * @since 0.71
  546. * @deprecated 2.1
  547. * @deprecated Use wp_list_categories()
  548. * @see wp_list_categories()
  549. *
  550. * @param int $optionall
  551. * @param string $all
  552. * @param string $sort_column
  553. * @param string $sort_order
  554. * @param string $file
  555. * @param bool $list
  556. * @param int $optiondates
  557. * @param int $optioncount
  558. * @param int $hide_empty
  559. * @param int $use_desc_for_title
  560. * @param bool $children
  561. * @param int $child_of
  562. * @param int $categories
  563. * @param int $recurse
  564. * @param string $feed
  565. * @param string $feed_image
  566. * @param string $exclude
  567. * @param bool $hierarchical
  568. * @return unknown
  569. */
  570. function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_order = 'asc', $file = '', $list = true, $optiondates = 0,
  571. $optioncount = 0, $hide_empty = 1, $use_desc_for_title = 1, $children=false, $child_of=0, $categories=0,
  572. $recurse=0, $feed = '', $feed_image = '', $exclude = '', $hierarchical=false) {
  573. _deprecated_function( __FUNCTION__, '2.1', 'wp_list_categories()' );
  574. $query = compact('optionall', 'all', 'sort_column', 'sort_order', 'file', 'list', 'optiondates', 'optioncount', 'hide_empty', 'use_desc_for_title', 'children',
  575. 'child_of', 'categories', 'recurse', 'feed', 'feed_image', 'exclude', 'hierarchical');
  576. return wp_list_cats($query);
  577. }
  578. /**
  579. * @since 1.2
  580. * @deprecated 2.1
  581. * @deprecated Use wp_list_categories()
  582. * @see wp_list_categories()
  583. *
  584. * @param string|array $args
  585. * @return unknown
  586. */
  587. function wp_list_cats($args = '') {
  588. _deprecated_function( __FUNCTION__, '2.1', 'wp_list_categories()' );
  589. $r = wp_parse_args( $args );
  590. // Map to new names.
  591. if ( isset($r['optionall']) && isset($r['all']))
  592. $r['show_option_all'] = $r['all'];
  593. if ( isset($r['sort_column']) )
  594. $r['orderby'] = $r['sort_column'];
  595. if ( isset($r['sort_order']) )
  596. $r['order'] = $r['sort_order'];
  597. if ( isset($r['optiondates']) )
  598. $r['show_last_update'] = $r['optiondates'];
  599. if ( isset($r['optioncount']) )
  600. $r['show_count'] = $r['optioncount'];
  601. if ( isset($r['list']) )
  602. $r['style'] = $r['list'] ? 'list' : 'break';
  603. $r['title_li'] = '';
  604. return wp_list_categories($r);
  605. }
  606. /**
  607. * @since 0.71
  608. * @deprecated 2.1
  609. * @deprecated Use wp_dropdown_categories()
  610. * @see wp_dropdown_categories()
  611. *
  612. * @param int $optionall
  613. * @param string $all
  614. * @param string $orderby
  615. * @param string $order
  616. * @param int $show_last_update
  617. * @param int $show_count
  618. * @param int $hide_empty
  619. * @param bool $optionnone
  620. * @param int $selected
  621. * @param int $exclude
  622. * @return unknown
  623. */
  624. function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = 'asc',
  625. $show_last_update = 0, $show_count = 0, $hide_empty = 1, $optionnone = false,
  626. $selected = 0, $exclude = 0) {
  627. _deprecated_function( __FUNCTION__, '2.1', 'wp_dropdown_categories()' );
  628. $show_option_all = '';
  629. if ( $optionall )
  630. $show_option_all = $all;
  631. $show_option_none = '';
  632. if ( $optionnone )
  633. $show_option_none = __('None');
  634. $vars = compact('show_option_all', 'show_option_none', 'orderby', 'order',
  635. 'show_last_update', 'show_count', 'hide_empty', 'selected', 'exclude');
  636. $query = add_query_arg($vars, '');
  637. return wp_dropdown_categories($query);
  638. }
  639. /**
  640. * @since 1.2
  641. * @deprecated 2.1
  642. * @deprecated Use wp_list_authors()
  643. * @see wp_list_authors()
  644. *
  645. * @param bool $optioncount
  646. * @param bool $exclude_admin
  647. * @param bool $show_fullname
  648. * @param bool $hide_empty
  649. * @param string $feed
  650. * @param string $feed_image
  651. * @return unknown
  652. */
  653. function list_authors($optioncount = false, $exclude_admin = true, $show_fullname = false, $hide_empty = true, $feed = '', $feed_image = '') {
  654. _deprecated_function( __FUNCTION__, '2.1', 'wp_list_authors()' );
  655. $args = compact('optioncount', 'exclude_admin', 'show_fullname', 'hide_empty', 'feed', 'feed_image');
  656. return wp_list_authors($args);
  657. }
  658. /**
  659. * @since 1.0.1
  660. * @deprecated 2.1
  661. * @deprecated Use wp_get_post_categories()
  662. * @see wp_get_post_categories()
  663. *
  664. * @param int $blogid Not Used
  665. * @param int $post_ID
  666. * @return unknown
  667. */
  668. function wp_get_post_cats($blogid = '1', $post_ID = 0) {
  669. _deprecated_function( __FUNCTION__, '2.1', 'wp_get_post_categories()' );
  670. return wp_get_post_categories($post_ID);
  671. }
  672. /**
  673. * Sets the categories that the post id belongs to.
  674. *
  675. * @since 1.0.1
  676. * @deprecated 2.1
  677. * @deprecated Use wp_set_post_categories()
  678. * @see wp_set_post_categories()
  679. *
  680. * @param int $blogid Not used
  681. * @param int $post_ID
  682. * @param array $post_categories
  683. * @return unknown
  684. */
  685. function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array()) {
  686. _deprecated_function( __FUNCTION__, '2.1', 'wp_set_post_categories()' );
  687. return wp_set_post_categories($post_ID, $post_categories);
  688. }
  689. /**
  690. * @since 0.71
  691. * @deprecated 2.1
  692. * @deprecated Use wp_get_archives()
  693. * @see wp_get_archives()
  694. *
  695. * @param string $type
  696. * @param string $limit
  697. * @param string $format
  698. * @param string $before
  699. * @param string $after
  700. * @param bool $show_post_count
  701. * @return unknown
  702. */
  703. function get_archives($type='', $limit='', $format='html', $before = '', $after = '', $show_post_count = false) {
  704. _deprecated_function( __FUNCTION__, '2.1', 'wp_get_archives()' );
  705. $args = compact('type', 'limit', 'format', 'before', 'after', 'show_post_count');
  706. return wp_get_archives($args);
  707. }
  708. /**
  709. * Returns or Prints link to the author's posts.
  710. *
  711. * @since 1.2
  712. * @deprecated 2.1
  713. * @deprecated Use get_author_posts_url()
  714. * @see get_author_posts_url()
  715. *
  716. * @param bool $echo Optional.
  717. * @param int $author_id Required.
  718. * @param string $author_nicename Optional.
  719. * @return string|null
  720. */
  721. function get_author_link($echo = false, $author_id, $author_nicename = '') {
  722. _deprecated_function( __FUNCTION__, '2.1', 'get_author_posts_url()' );
  723. $link = get_author_posts_url($author_id, $author_nicename);
  724. if ( $echo )
  725. echo $link;
  726. return $link;
  727. }
  728. /**
  729. * Print list of pages based on arguments.
  730. *
  731. * @since 0.71
  732. * @deprecated 2.1
  733. * @deprecated Use wp_link_pages()
  734. * @see wp_link_pages()
  735. *
  736. * @param string $before
  737. * @param string $after
  738. * @param string $next_or_number
  739. * @param string $nextpagelink
  740. * @param string $previouspagelink
  741. * @param string $pagelink
  742. * @param string $more_file
  743. * @return string
  744. */
  745. function link_pages($before='<br />', $after='<br />', $next_or_number='number', $nextpagelink='next page', $previouspagelink='previous page',
  746. $pagelink='%', $more_file='') {
  747. _deprecated_function( __FUNCTION__, '2.1', 'wp_link_pages()' );
  748. $args = compact('before', 'after', 'next_or_number', 'nextpagelink', 'previouspagelink', 'pagelink', 'more_file');
  749. return wp_link_pages($args);
  750. }
  751. /**
  752. * Get value based on option.
  753. *
  754. * @since 0.71
  755. * @deprecated 2.1
  756. * @deprecated Use get_option()
  757. * @see get_option()
  758. *
  759. * @param string $option
  760. * @return string
  761. */
  762. function get_settings($option) {
  763. _deprecated_function( __FUNCTION__, '2.1', 'get_option()' );
  764. return get_option($option);
  765. }
  766. /**
  767. * Print the permalink of the current post in the loop.
  768. *
  769. * @since 0.71
  770. * @deprecated 1.2
  771. * @deprecated Use the_permalink()
  772. * @see the_permalink()
  773. */
  774. function permalink_link() {
  775. _deprecated_function( __FUNCTION__, '1.2', 'the_permalink()' );
  776. the_permalink();
  777. }
  778. /**
  779. * Print the permalink to the RSS feed.
  780. *
  781. * @since 0.71
  782. * @deprecated 2.3
  783. * @deprecated Use the_permalink_rss()
  784. * @see the_permalink_rss()
  785. *
  786. * @param string $deprecated
  787. */
  788. function permalink_single_rss($deprecated = '') {
  789. _deprecated_function( __FUNCTION__, '2.3', 'the_permalink_rss()' );
  790. the_permalink_rss();
  791. }
  792. /**
  793. * Gets the links associated with category.
  794. *
  795. * @see get_links() for argument information that can be used in $args
  796. * @since 1.0.1
  797. * @deprecated 2.1
  798. * @deprecated Use wp_list_bookmarks()
  799. * @see wp_list_bookmarks()
  800. *
  801. * @param string $args a query string
  802. * @return null|string
  803. */
  804. function wp_get_links($args = '') {
  805. _deprecated_function( __FUNCTION__, '2.1', 'wp_list_bookmarks()' );
  806. if ( strpos( $args, '=' ) === false ) {
  807. $cat_id = $args;
  808. $args = add_query_arg( 'category', $cat_id, $args );
  809. }
  810. $defaults = array(
  811. 'after' => '<br />',
  812. 'before' => '',
  813. 'between' => ' ',
  814. 'categorize' => 0,
  815. 'category' => '',
  816. 'echo' => true,
  817. 'limit' => -1,
  818. 'orderby' => 'name',
  819. 'show_description' => true,
  820. 'show_images' => true,
  821. 'show_rating' => false,
  822. 'show_updated' => true,
  823. 'title_li' => '',
  824. );
  825. $r = wp_parse_args( $args, $defaults );
  826. return wp_list_bookmarks($r);
  827. }
  828. /**
  829. * Gets the links associated with category by id.
  830. *
  831. * @since 0.71
  832. * @deprecated 2.1
  833. * @deprecated Use get_bookmarks()
  834. * @see get_bookmarks()
  835. *
  836. * @param int $category The category to use. If no category supplied uses all
  837. * @param string $before the html to output before the link
  838. * @param string $after the html to output after the link
  839. * @param string $between the html to output between the link/image and its description.
  840. * Not used if no image or show_images == true
  841. * @param bool $show_images whether to show images (if defined).
  842. * @param string $orderby the order to output the links. E.g. 'id', 'name', 'url',
  843. * 'description', or 'rating'. Or maybe owner. If you start the name with an
  844. * underscore the order will be reversed. You can also specify 'rand' as the order
  845. * which will return links in a random order.
  846. * @param bool $show_description whether to show the description if show_images=false/not defined.
  847. * @param bool $show_rating show rating stars/chars
  848. * @param int $limit Limit to X entries. If not specified, all entries are shown.
  849. * @param int $show_updated whether to show last updated timestamp
  850. * @param bool $echo whether to echo the results, or return them instead
  851. * @return null|string
  852. */
  853. function get_links($category = -1, $before = '', $after = '<br />', $between = ' ', $show_images = true, $orderby = 'name',
  854. $show_description = true, $show_rating = false, $limit = -1, $show_updated = 1, $echo = true) {
  855. _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
  856. $order = 'ASC';
  857. if ( substr($orderby, 0, 1) == '_' ) {
  858. $order = 'DESC';
  859. $orderby = substr($orderby, 1);
  860. }
  861. if ( $category == -1 ) //get_bookmarks uses '' to signify all categories
  862. $category = '';
  863. $results = get_bookmarks(array('category' => $category, 'orderby' => $orderby, 'order' => $order, 'show_updated' => $show_updated, 'limit' => $limit));
  864. if ( !$results )
  865. return;
  866. $output = '';
  867. foreach ( (array) $results as $row ) {
  868. if ( !isset($row->recently_updated) )
  869. $row->recently_updated = false;
  870. $output .= $before;
  871. if ( $show_updated && $row->recently_updated )
  872. $output .= get_option('links_recently_updated_prepend');
  873. $the_link = '#';
  874. if ( !empty($row->link_url) )
  875. $the_link = esc_url($row->link_url);
  876. $rel = $row->link_rel;
  877. if ( '' != $rel )
  878. $rel = ' rel="' . $rel . '"';
  879. $desc = esc_attr(sanitize_bookmark_field('link_description', $row->link_description, $row->link_id, 'display'));
  880. $name = esc_attr(sanitize_bookmark_field('link_name', $row->link_name, $row->link_id, 'display'));
  881. $title = $desc;
  882. if ( $show_updated )
  883. if (substr($row->link_updated_f, 0, 2) != '00')
  884. $title .= ' ('.__('Last updated') . ' ' . date(get_option('links_updated_date_format'), $row->link_updated_f + (get_option('gmt_offset') * HOUR_IN_SECONDS)) . ')';
  885. if ( '' != $title )
  886. $title = ' title="' . $title . '"';
  887. $alt = ' alt="' . $name . '"';
  888. $target = $row->link_target;
  889. if ( '' != $target )
  890. $target = ' target="' . $target . '"';
  891. $output .= '<a href="' . $the_link . '"' . $rel . $title . $target. '>';
  892. if ( $row->link_image != null && $show_images ) {
  893. if ( strpos($row->link_image, 'http') !== false )
  894. $output .= "<img src=\"$row->link_image\" $alt $title />";
  895. else // If it's a relative path
  896. $output .= "<img src=\"" . get_option('siteurl') . "$row->link_image\" $alt $title />";
  897. } else {
  898. $output .= $name;
  899. }
  900. $output .= '</a>';
  901. if ( $show_updated && $row->recently_updated )
  902. $output .= get_option('links_recently_updated_append');
  903. if ( $show_description && '' != $desc )
  904. $output .= $between . $desc;
  905. if ($show_rating) {
  906. $output .= $between . get_linkrating($row);
  907. }
  908. $output .= "$after\n";
  909. } // end while
  910. if ( !$echo )
  911. return $output;
  912. echo $output;
  913. }
  914. /**
  915. * Output entire list of links by category.
  916. *
  917. * Output a list of all links, listed by category, using the settings in
  918. * $wpdb->linkcategories and output it as a nested HTML unordered list.
  919. *
  920. * @since 1.0.1
  921. * @deprecated 2.1
  922. * @deprecated Use wp_list_bookmarks()
  923. * @see wp_list_bookmarks()
  924. *
  925. * @param string $order Sort link categories by 'name' or 'id'
  926. */
  927. function get_links_list($order = 'name') {
  928. _deprecated_function( __FUNCTION__, '2.1', 'wp_list_bookmarks()' );
  929. $order = strtolower($order);
  930. // Handle link category sorting
  931. $direction = 'ASC';
  932. if ( '_' == substr($order,0,1) ) {
  933. $direction = 'DESC';
  934. $order = substr($order,1);
  935. }
  936. if ( !isset($direction) )
  937. $direction = '';
  938. $cats = get_categories(array('type' => 'link', 'orderby' => $order, 'order' => $direction, 'hierarchical' => 0));
  939. // Display each category
  940. if ( $cats ) {
  941. foreach ( (array) $cats as $cat ) {
  942. // Handle each category.
  943. // Display the category name
  944. echo ' <li id="linkcat-' . $cat->term_id . '" class="linkcat"><h2>' . apply_filters('link_category', $cat->name ) . "</h2>\n\t<ul>\n";
  945. // Call get_links() with all the appropriate params
  946. get_links($cat->term_id, '<li>', "</li>", "\n", true, 'name', false);
  947. // Close the last category
  948. echo "\n\t</ul>\n</li>\n";
  949. }
  950. }
  951. }
  952. /**
  953. * Show the link to the links popup and the number of links.
  954. *
  955. * @since 0.71
  956. * @deprecated 2.1
  957. * @deprecated {@internal Use function instead is unknown}}
  958. *
  959. * @param string $text the text of the link
  960. * @param int $width the width of the popup window
  961. * @param int $height the height of the popup window
  962. * @param string $file the page to open in the popup window
  963. * @param bool $count the number of links in the db
  964. */
  965. function links_popup_script($text = 'Links', $width=400, $height=400, $file='links.all.php', $count = true) {
  966. _deprecated_function( __FUNCTION__, '2.1' );
  967. if ( $count )
  968. $counts = $wpdb->get_var("SELECT COUNT(*) FROM $wpdb->links");
  969. $javascript = "<a href=\"#\" onclick=\"javascript:window.open('$file?popup=1', '_blank', 'width=$width,height=$height,scrollbars=yes,status=no'); return false\">";
  970. $javascript .= $text;
  971. if ( $count )
  972. $javascript .= " ($counts)";
  973. $javascript .= "</a>\n\n";
  974. echo $javascript;
  975. }
  976. /**
  977. * @since 1.0.1
  978. * @deprecated 2.1
  979. * @deprecated Use sanitize_bookmark_field()
  980. * @see sanitize_bookmark_field()
  981. *
  982. * @param object $link
  983. * @return unknown
  984. */
  985. function get_linkrating($link) {
  986. _deprecated_function( __FUNCTION__, '2.1', 'sanitize_bookmark_field()' );
  987. return sanitize_bookmark_field('link_rating', $link->link_rating, $link->link_id, 'display');
  988. }
  989. /**
  990. * Gets the name of category by id.
  991. *
  992. * @since 0.71
  993. * @deprecated 2.1
  994. * @deprecated Use get_category()
  995. * @see get_category()
  996. *
  997. * @param int $id The category to get. If no category supplied uses 0
  998. * @return string
  999. */
  1000. function get_linkcatname($id = 0) {
  1001. _deprecated_function( __FUNCTION__, '2.1', 'get_category()' );
  1002. $id = (int) $id;
  1003. if ( empty($id) )
  1004. return '';
  1005. $cats = wp_get_link_cats($id);
  1006. if ( empty($cats) || ! is_array($cats) )
  1007. return '';
  1008. $cat_id = (int) $cats[0]; // Take the first cat.
  1009. $cat = get_category($cat_id);
  1010. return $cat->name;
  1011. }
  1012. /**
  1013. * Print RSS comment feed link.
  1014. *
  1015. * @since 1.0.1
  1016. * @deprecated 2.5
  1017. * @deprecated Use post_comments_feed_link()
  1018. * @see post_comments_feed_link()
  1019. *
  1020. * @param string $link_text
  1021. */
  1022. function comments_rss_link($link_text = 'Comments RSS') {
  1023. _deprecated_function( __FUNCTION__, '2.5', 'post_comments_feed_link()' );
  1024. post_comments_feed_link($link_text);
  1025. }
  1026. /**
  1027. * Print/Return link to category RSS2 feed.
  1028. *
  1029. * @since 1.2
  1030. * @deprecated 2.5
  1031. * @deprecated Use get_category_feed_link()
  1032. * @see get_category_feed_link()
  1033. *
  1034. * @param bool $echo
  1035. * @param int $cat_ID
  1036. * @return string|null
  1037. */
  1038. function get_category_rss_link($echo = false, $cat_ID = 1) {
  1039. _deprecated_function( __FUNCTION__, '2.5', 'get_category_feed_link()' );
  1040. $link = get_category_feed_link($cat_ID, 'rss2');
  1041. if ( $echo )
  1042. echo $link;
  1043. return $link;
  1044. }
  1045. /**
  1046. * Print/Return link to author RSS feed.
  1047. *
  1048. * @since 1.2
  1049. * @deprecated 2.5
  1050. * @deprecated Use get_author_feed_link()
  1051. * @see get_author_feed_link()
  1052. *
  1053. * @param bool $echo
  1054. * @param int $author_id
  1055. * @return string|null
  1056. */
  1057. function get_author_rss_link($echo = false, $author_id = 1) {
  1058. _deprecated_function( __FUNCTION__, '2.5', 'get_author_feed_link()' );
  1059. $link = get_author_feed_link($author_id);
  1060. if ( $echo )
  1061. echo $link;
  1062. return $link;
  1063. }
  1064. /**
  1065. * Return link to the post RSS feed.
  1066. *
  1067. * @since 1.5
  1068. * @deprecated 2.2
  1069. * @deprecated Use get_post_comments_feed_link()
  1070. * @see get_post_comments_feed_link()
  1071. *
  1072. * @return string
  1073. */
  1074. function comments_rss() {
  1075. _deprecated_function( __FUNCTION__, '2.2', 'get_post_comments_feed_link()' );
  1076. return get_post_comments_feed_link();
  1077. }
  1078. /**
  1079. * An alias of wp_create_user().
  1080. *
  1081. * @since 2.0
  1082. * @deprecated 2.0
  1083. * @deprecated Use wp_create_user()
  1084. * @see wp_create_user()
  1085. *
  1086. * @param string $username The user's username.
  1087. * @param string $password The user's password.
  1088. * @param string $email The user's email (optional).
  1089. * @return int The new user's ID.
  1090. */
  1091. function create_user($username, $password, $email) {
  1092. _deprecated_function( __FUNCTION__, '2.0', 'wp_create_user()' );
  1093. return wp_create_user($username, $password, $email);
  1094. }
  1095. /**
  1096. * Unused function.
  1097. *
  1098. * @deprecated 2.5
  1099. */
  1100. function gzip_compression() {
  1101. _deprecated_function( __FUNCTION__, '2.5' );
  1102. return false;
  1103. }
  1104. /**
  1105. * Retrieve an array of comment data about comment $comment_ID.
  1106. *
  1107. * @since 0.71
  1108. * @deprecated 2.7
  1109. * @deprecated Use get_comment()
  1110. * @see get_comment()
  1111. *
  1112. * @param int $comment_ID The ID of the comment
  1113. * @param int $no_cache Whether to use the cache (cast to bool)
  1114. * @param bool $include_unapproved Whether to include unapproved comments
  1115. * @return array The comment data
  1116. */
  1117. function get_commentdata( $comment_ID, $no_cache = 0, $include_unapproved = false ) {
  1118. _deprecated_function( __FUNCTION__, '2.7', 'get_comment()' );
  1119. return get_comment($comment_ID, ARRAY_A);
  1120. }
  1121. /**
  1122. * Retrieve the category name by the category ID.
  1123. *
  1124. * @since 0.71
  1125. * @deprecated 2.8
  1126. * @deprecated Use get_cat_name()
  1127. * @see get_cat_name()
  1128. *
  1129. * @param int $cat_ID Category ID
  1130. * @return string category name
  1131. */
  1132. function get_catname( $cat_ID ) {
  1133. _deprecated_function( __FUNCTION__, '2.8', 'get_cat_name()' );
  1134. return get_cat_name( $cat_ID );
  1135. }
  1136. /**
  1137. * Retrieve category children list separated before and after the term IDs.
  1138. *
  1139. * @since 1.2.0
  1140. * @deprecated 2.8
  1141. * @deprecated Use get_term_children()
  1142. * @see get_term_children()
  1143. *
  1144. * @param int $id Category ID to retrieve children.
  1145. * @param string $before Optional. Prepend before category term ID.
  1146. * @param string $after Optional, default is empty string. Append after category term ID.
  1147. * @param array $visited Optional. Category Term IDs that have already been added.
  1148. * @return string
  1149. */
  1150. function get_category_children( $id, $before = '/', $after = '', $visited = array() ) {
  1151. _deprecated_function( __FUNCTION__, '2.8', 'get_term_children()' );
  1152. if ( 0 == $id )
  1153. return '';
  1154. $chain = '';
  1155. /** TODO: consult hierarchy */
  1156. $cat_ids = get_all_category_ids();
  1157. foreach ( (array) $cat_ids as $cat_id ) {
  1158. if ( $cat_id == $id )
  1159. continue;
  1160. $category = get_category( $cat_id );
  1161. if ( is_wp_error( $category ) )
  1162. return $category;
  1163. if ( $category->parent == $id && !in_array( $category->term_id, $visited ) ) {
  1164. $visited[] = $category->term_id;
  1165. $chain .= $before.$category->term_id.$after;
  1166. $chain .= get_category_children( $category->term_id, $before, $after );
  1167. }
  1168. }
  1169. return $chain;
  1170. }
  1171. /**
  1172. * Retrieve the description of the author of the current post.
  1173. *
  1174. * @since 1.5
  1175. * @deprecated 2.8
  1176. * @deprecated Use get_the_author_meta('description')
  1177. * @see get_the_author_meta()
  1178. *
  1179. * @return string The author's description.
  1180. */
  1181. function get_the_author_description() {
  1182. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'description\')' );
  1183. return get_the_author_meta('description');
  1184. }
  1185. /**
  1186. * Display the description of the author of the current post.
  1187. *
  1188. * @since 1.0.0
  1189. * @deprecated 2.8
  1190. * @deprecated Use the_author_meta('description')
  1191. * @see the_author_meta()
  1192. */
  1193. function the_author_description() {
  1194. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'description\')' );
  1195. the_author_meta('description');
  1196. }
  1197. /**
  1198. * Retrieve the login name of the author of the current post.
  1199. *
  1200. * @since 1.5
  1201. * @deprecated 2.8
  1202. * @deprecated Use get_the_author_meta('login')
  1203. * @see get_the_author_meta()
  1204. *
  1205. * @return string The author's login name (username).
  1206. */
  1207. function get_the_author_login() {
  1208. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'login\')' );
  1209. return get_the_author_meta('login');
  1210. }
  1211. /**
  1212. * Display the login name of the author of the current post.
  1213. *
  1214. * @since 0.71
  1215. * @deprecated 2.8
  1216. * @deprecated Use the_author_meta('login')
  1217. * @see the_author_meta()
  1218. */
  1219. function the_author_login() {
  1220. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'login\')' );
  1221. the_author_meta('login');
  1222. }
  1223. /**
  1224. * Retrieve the first name of the author of the current post.
  1225. *
  1226. * @since 1.5
  1227. * @deprecated 2.8
  1228. * @deprecated Use get_the_author_meta('first_name')
  1229. * @see get_the_author_meta()
  1230. *
  1231. * @return string The author's first name.
  1232. */
  1233. function get_the_author_firstname() {
  1234. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'first_name\')' );
  1235. return get_the_author_meta('first_name');
  1236. }
  1237. /**
  1238. * Display the first name of the author of the current post.
  1239. *
  1240. * @since 0.71
  1241. * @deprecated 2.8
  1242. * @deprecated Use the_author_meta('first_name')
  1243. * @see the_author_meta()
  1244. */
  1245. function the_author_firstname() {
  1246. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'first_name\')' );
  1247. the_author_meta('first_name');
  1248. }
  1249. /**
  1250. * Retrieve the last name of the author of the current post.
  1251. *
  1252. * @since 1.5
  1253. * @deprecated 2.8
  1254. * @deprecated Use get_the_author_meta('last_name')
  1255. * @see get_the_author_meta()
  1256. *
  1257. * @return string The author's last name.
  1258. */
  1259. function get_the_author_lastname() {
  1260. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'last_name\')' );
  1261. return get_the_author_meta('last_name');
  1262. }
  1263. /**
  1264. * Display the last name of the author of the current post.
  1265. *
  1266. * @since 0.71
  1267. * @deprecated 2.8
  1268. * @deprecated Use the_author_meta('last_name')
  1269. * @see the_author_meta()
  1270. */
  1271. function the_author_lastname() {
  1272. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'last_name\')' );
  1273. the_author_meta('last_name');
  1274. }
  1275. /**
  1276. * Retrieve the nickname of the author of the current post.
  1277. *
  1278. * @since 1.5
  1279. * @deprecated 2.8
  1280. * @deprecated Use get_the_author_meta('nickname')
  1281. * @see get_the_author_meta()
  1282. *
  1283. * @return string The author's nickname.
  1284. */
  1285. function get_the_author_nickname() {
  1286. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'nickname\')' );
  1287. return get_the_author_meta('nickname');
  1288. }
  1289. /**
  1290. * Display the nickname of the author of the current post.
  1291. *
  1292. * @since 0.71
  1293. * @deprecated 2.8
  1294. * @deprecated Use the_author_meta('nickname')
  1295. * @see the_author_meta()
  1296. */
  1297. function the_author_nickname() {
  1298. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'nickname\')' );
  1299. the_author_meta('nickname');
  1300. }
  1301. /**
  1302. * Retrieve the email of the author of the current post.
  1303. *
  1304. * @since 1.5
  1305. * @deprecated 2.8
  1306. * @deprecated Use get_the_author_meta('email')
  1307. * @see get_the_author_meta()
  1308. *
  1309. * @return string The author's username.
  1310. */
  1311. function get_the_author_email() {
  1312. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'email\')' );
  1313. return get_the_author_meta('email');
  1314. }
  1315. /**
  1316. * Display the email of the author of the current post.
  1317. *
  1318. * @since 0.71
  1319. * @deprecated 2.8
  1320. * @deprecated Use the_author_meta('email')
  1321. * @see the_author_meta()
  1322. */
  1323. function the_author_email() {
  1324. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'email\')' );
  1325. the_author_meta('email');
  1326. }
  1327. /**
  1328. * Retrieve the ICQ number of the author of the current post.
  1329. *
  1330. * @since 1.5
  1331. * @deprecated 2.8
  1332. * @deprecated Use get_the_author_meta('icq')
  1333. * @see get_the_author_meta()
  1334. *
  1335. * @return string The author's ICQ number.
  1336. */
  1337. function get_the_author_icq() {
  1338. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'icq\')' );
  1339. return get_the_author_meta('icq');
  1340. }
  1341. /**
  1342. * Display the ICQ number of the author of the current post.
  1343. *
  1344. * @since 0.71
  1345. * @deprecated 2.8
  1346. * @deprecated Use the_author_meta('icq')
  1347. * @see the_author_meta()
  1348. */
  1349. function the_author_icq() {
  1350. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'icq\')' );
  1351. the_author_meta('icq');
  1352. }
  1353. /**
  1354. * Retrieve the Yahoo! IM name of the author of the current post.
  1355. *
  1356. * @since 1.5
  1357. * @deprecated 2.8
  1358. * @deprecated Use get_the_author_meta('yim')
  1359. * @see get_the_author_meta()
  1360. *
  1361. * @return string The author's Yahoo! IM name.
  1362. */
  1363. function get_the_author_yim() {
  1364. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'yim\')' );
  1365. return get_the_author_meta('yim');
  1366. }
  1367. /**
  1368. * Display the Yahoo! IM name of the author of the current post.
  1369. *
  1370. * @since 0.71
  1371. * @deprecated 2.8
  1372. * @deprecated Use the_author_meta('yim')
  1373. * @see the_author_meta()
  1374. */
  1375. function the_author_yim() {
  1376. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'yim\')' );
  1377. the_author_meta('yim');
  1378. }
  1379. /**
  1380. * Retrieve the MSN address of the author of the current post.
  1381. *
  1382. * @since 1.5
  1383. * @deprecated 2.8
  1384. * @deprecated Use get_the_author_meta('msn')
  1385. * @see get_the_author_meta()
  1386. *
  1387. * @return string The author's MSN address.
  1388. */
  1389. function get_the_author_msn() {
  1390. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'msn\')' );
  1391. return get_the_author_meta('msn');
  1392. }
  1393. /**
  1394. * Display the MSN address of the author of the current post.
  1395. *
  1396. * @since 0.71
  1397. * @deprecated 2.8
  1398. * @deprecated Use the_author_meta('msn')
  1399. * @see the_author_meta()
  1400. */
  1401. function the_author_msn() {
  1402. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'msn\')' );
  1403. the_author_meta('msn');
  1404. }
  1405. /**
  1406. * Retrieve the AIM address of the author of the current post.
  1407. *
  1408. * @since 1.5
  1409. * @deprecated 2.8
  1410. * @deprecated Use get_the_author_meta('aim')
  1411. * @see get_the_author_meta()
  1412. *
  1413. * @return string The author's AIM address.
  1414. */
  1415. function get_the_author_aim() {
  1416. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'aim\')' );
  1417. return get_the_author_meta('aim');
  1418. }
  1419. /**
  1420. * Display the AIM address of the author of the current post.
  1421. *
  1422. * @since 0.71
  1423. * @see the_author_meta()
  1424. * @deprecated 2.8
  1425. * @deprecated Use the_author_meta('aim')
  1426. */
  1427. function the_author_aim() {
  1428. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'aim\')' );
  1429. the_author_meta('aim');
  1430. }
  1431. /**
  1432. * Retrieve the specified author's preferred display name.
  1433. *
  1434. * @since 1.0.0
  1435. * @deprecated 2.8
  1436. * @deprecated Use get_the_author_meta('display_name')
  1437. * @see get_the_author_meta()
  1438. *
  1439. * @param int $auth_id The ID of the author.
  1440. * @return string The author's display name.
  1441. */
  1442. function get_author_name( $auth_id = false ) {
  1443. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'display_name\')' );
  1444. return get_the_author_meta('display_name', $auth_id);
  1445. }
  1446. /**
  1447. * Retrieve the URL to the home page of the author of the current post.
  1448. *
  1449. * @since 1.5
  1450. * @deprecated 2.8
  1451. * @deprecated Use get_the_author_meta('url')
  1452. * @see get_the_author_meta()
  1453. *
  1454. * @return string The URL to the author's page.
  1455. */
  1456. function get_the_author_url() {
  1457. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'url\')' );
  1458. return get_the_author_meta('url');
  1459. }
  1460. /**
  1461. * Display the URL to the home page of the author of the current post.
  1462. *
  1463. * @since 0.71
  1464. * @deprecated 2.8
  1465. * @deprecated Use the_author_meta('url')
  1466. * @see the_author_meta()
  1467. */
  1468. function the_author_url() {
  1469. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'url\')' );
  1470. the_author_meta('url');
  1471. }
  1472. /**
  1473. * Retrieve the ID of the author of the current post.
  1474. *
  1475. * @since 1.5
  1476. * @deprecated 2.8
  1477. * @deprecated Use get_the_author_meta('ID')
  1478. * @see get_the_author_meta()
  1479. *
  1480. * @return int The author's ID.
  1481. */
  1482. function get_the_author_ID() {
  1483. _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'ID\')' );
  1484. return get_the_author_meta('ID');
  1485. }
  1486. /**
  1487. * Display the ID of the author of the current post.
  1488. *
  1489. * @since 0.71
  1490. * @deprecated 2.8
  1491. * @deprecated Use the_author_meta('ID')
  1492. * @see the_author_meta()
  1493. */
  1494. function the_author_ID() {
  1495. _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'ID\')' );
  1496. the_author_meta('ID');
  1497. }
  1498. /**
  1499. * Display the post content for the feed.
  1500. *
  1501. * For encoding the html or the $encode_html parameter, there are three possible
  1502. * values. '0' will make urls footnotes and use make_url_footnote(). '1' will
  1503. * encode special characters and automatically display all of the content. The
  1504. * value of '2' will strip all HTML tags from the content.
  1505. *
  1506. * Also note that you cannot set the amount of words and not set the html
  1507. * encoding. If that is the case, then the html encoding will default to 2,
  1508. * which will strip all HTML tags.
  1509. *
  1510. * To restrict the amount of words of the content, you can use the cut
  1511. * parameter. If the content is less than the amount, then there won't be any
  1512. * dots added to the end. If there is content left over, then dots will be added
  1513. * and the rest of the content will be removed.
  1514. *
  1515. * @package WordPress
  1516. * @subpackage Feed
  1517. * @since 0.71
  1518. * @uses apply_filters() Calls 'the_content_rss' on the content before processing.
  1519. * @see get_the_content() For the $more_link_text, $stripteaser, and $more_file
  1520. * parameters.
  1521. *
  1522. * @deprecated 2.9.0
  1523. * @deprecated Use the_content_feed()
  1524. * @see the_content_feed()
  1525. *
  1526. * @param string $more_link_text Optional. Text to display when more content is available but not displayed.
  1527. * @param int|bool $stripteaser Optional. Default is 0.
  1528. * @param string $more_file Optional.
  1529. * @param int $cut Optional. Amount of words to keep for the content.
  1530. * @param int $encode_html Optional. How to encode the content.
  1531. */
  1532. function the_content_rss($more_link_text='(more...)', $stripteaser=0, $more_file='', $cut = 0, $encode_html = 0) {
  1533. _deprecated_function( __FUNCTION__, '2.9', 'the_content_feed' );
  1534. $content = get_the_content($more_link_text, $stripteaser, $more_file);
  1535. $content = apply_filters('the_content_rss', $content);
  1536. if ( $cut && !$encode_html )
  1537. $encode_html = 2;
  1538. if ( 1== $encode_html ) {
  1539. $content = esc_html($content);
  1540. $cut = 0;
  1541. } elseif ( 0 == $encode_html ) {
  1542. $content = make_url_footnote($content);
  1543. } elseif ( 2 == $encode_html ) {
  1544. $content = strip_tags($content);
  1545. }
  1546. if ( $cut ) {
  1547. $blah = explode(' ', $content);
  1548. if ( count($blah) > $cut ) {
  1549. $k = $cut;
  1550. $use_dotdotdot = 1;
  1551. } else {
  1552. $k = count($blah);
  1553. $use_dotdotdot = 0;
  1554. }
  1555. /** @todo Check performance, might be faster to use array slice instead. */
  1556. for ( $i=0; $i<$k; $i++ )
  1557. $excerpt .= $blah[$i].' ';
  1558. $excerpt .= ($use_dotdotdot) ? '...' : '';
  1559. $content = $excerpt;
  1560. }
  1561. $content = str_replace(']]>', ']]&gt;', $content);
  1562. echo $content;
  1563. }
  1564. /**
  1565. * Strip HTML and put links at the bottom of stripped content.
  1566. *
  1567. * Searches for all of the links, strips them out of the content, and places
  1568. * them at the bottom of the content with numbers.
  1569. *
  1570. * @since 0.71
  1571. * @deprecated 2.9.0
  1572. *
  1573. * @param string $content Content to get links
  1574. * @return string HTML stripped out of content with links at the bottom.
  1575. */
  1576. function make_url_footnote( $content ) {
  1577. _deprecated_function( __FUNCTION__, '2.9', '' );
  1578. preg_match_all( '/<a(.+?)href=\"(.+?)\"(.*?)>(.+?)<\/a>/', $content, $matches );
  1579. $links_summary = "\n";
  1580. for ( $i=0; $i<count($matches[0]); $i++ ) {
  1581. $link_match = $matches[0][$i];
  1582. $link_number = '['.($i+1).']';
  1583. $link_url = $matches[2][$i];
  1584. $link_text = $matches[4][$i];
  1585. $content = str_replace( $link_match, $link_text . ' ' . $link_number, $content );
  1586. $link_url = ( ( strtolower( substr( $link_url, 0, 7 ) ) != 'http://' ) && ( strtolower( substr( $link_url, 0, 8 ) ) != 'https://' ) ) ? get_option( 'home' ) . $link_url : $link_url;
  1587. $links_summary .= "\n" . $link_number . ' ' . $link_url;
  1588. }
  1589. $content = strip_tags( $content );
  1590. $content .= $links_summary;
  1591. return $content;
  1592. }
  1593. /**
  1594. * Retrieve translated string with vertical bar context
  1595. *
  1596. * Quite a few times, there will be collisions with similar translatable text
  1597. * found in more than two places but with different translated context.
  1598. *
  1599. * In order to use the separate contexts, the _c() function is used and the
  1600. * translatable string uses a pipe ('|') which has the context the string is in.
  1601. *
  1602. * When the translated string is returned, it is everything before the pipe, not
  1603. * including the pipe character. If there is no pipe in the translated text then
  1604. * everything is returned.
  1605. *
  1606. * @since 2.2.0
  1607. * @deprecated 2.9.0
  1608. * @deprecated Use _x()
  1609. * @see _x()
  1610. *
  1611. * @param string $text Text to translate
  1612. * @param string $domain Optional. Domain to retrieve the translated text
  1613. * @return string Translated context string without pipe
  1614. */
  1615. function _c( $text, $domain = 'default' ) {
  1616. _deprecated_function( __FUNCTION__, '2.9', '_x()' );
  1617. return before_last_bar( translate( $text, $domain ) );
  1618. }
  1619. /**
  1620. * Translates $text like translate(), but assumes that the text
  1621. * contains a context after its last vertical bar.
  1622. *
  1623. * @since 2.5
  1624. * @uses translate()
  1625. * @deprecated 3.0.0
  1626. * @deprecated Use _x()
  1627. * @see _x()
  1628. *
  1629. * @param string $text Text to translate
  1630. * @param string $domain Domain to retrieve the translated text
  1631. * @return string Translated text
  1632. */
  1633. function translate_with_context( $text, $domain = 'default' ) {
  1634. _deprecated_function( __FUNCTION__, '2.9', '_x()' );
  1635. return before_last_bar( translate( $text, $domain ) );
  1636. }
  1637. /**
  1638. * A version of _n(), which supports contexts.
  1639. * Strips everything from the translation after the last bar.
  1640. *
  1641. * @since 2.7.0
  1642. * @deprecated 3.0.0
  1643. * @deprecated Use _nx()
  1644. * @see _nx()
  1645. * @see _n() For parameters.
  1646. * @see _c() For parameters. _c() is deprecated.
  1647. *
  1648. */
  1649. function _nc( $single, $plural, $number, $domain = 'default' ) {
  1650. _deprecated_function( __FUNCTION__, '2.9', '_nx()' );
  1651. return before_last_bar( _n( $single, $plural, $number, $domain ) );
  1652. }
  1653. /**
  1654. * Retrieve the plural or single form based on the amount.
  1655. *
  1656. * @since 1.2.0
  1657. * @deprecated 2.8.0
  1658. * @deprecated Use _n()
  1659. * @see _n()
  1660. */
  1661. function __ngettext() {
  1662. _deprecated_function( __FUNCTION__, '2.8', '_n()' );
  1663. $args = func_get_args();
  1664. return call_user_func_array('_n', $args);
  1665. }
  1666. /**
  1667. * Register plural strings in POT file, but don't translate them.
  1668. *
  1669. * @since 2.5
  1670. * @deprecated 2.8.0
  1671. * @deprecated Use _n_noop()
  1672. * @see _n_noop()
  1673. */
  1674. function __ngettext_noop() {
  1675. _deprecated_function( __FUNCTION__, '2.8', '_n_noop()' );
  1676. $args = func_get_args();
  1677. return call_user_func_array('_n_noop', $args);
  1678. }
  1679. /**
  1680. * Retrieve all autoload options, or all options if no autoloaded ones exist.
  1681. *
  1682. * @since 1.0.0
  1683. * @deprecated 3.0.0
  1684. * @deprecated Use wp_load_alloptions())
  1685. * @see wp_load_alloptions()
  1686. *
  1687. * @return array List of all options.
  1688. */
  1689. function get_alloptions() {
  1690. _deprecated_function( __FUNCTION__, '3.0', 'wp_load_alloptions()' );
  1691. return wp_load_alloptions();
  1692. }
  1693. /**
  1694. * Retrieve HTML content of attachment image with link.
  1695. *
  1696. * @since 2.0.0
  1697. * @deprecated 2.5.0
  1698. * @deprecated Use wp_get_attachment_link()
  1699. * @see wp_get_attachment_link()
  1700. *
  1701. * @param int $id Optional. Post ID.
  1702. * @param bool $fullsize Optional, default is false. Whether to use full size image.
  1703. * @param array $max_dims Optional. Max image dimensions.
  1704. * @param bool $permalink Optional, default is false. Whether to include permalink to image.
  1705. * @return string
  1706. */
  1707. function get_the_attachment_link($id = 0, $fullsize = false, $max_dims = false, $permalink = false) {
  1708. _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_link()' );
  1709. $id = (int) $id;
  1710. $_post = get_post($id);
  1711. if ( ('attachment' != $_post->post_type) || !$url = wp_get_attachment_url($_post->ID) )
  1712. return __('Missing Attachment');
  1713. if ( $permalink )
  1714. $url = get_attachment_link($_post->ID);
  1715. $post_title = esc_attr($_post->post_title);
  1716. $innerHTML = get_attachment_innerHTML($_post->ID, $fullsize, $max_dims);
  1717. return "<a href='$url' title='$post_title'>$innerHTML</a>";
  1718. }
  1719. /**
  1720. * Retrieve icon URL and Path.
  1721. *
  1722. * @since 2.1.0
  1723. * @deprecated 2.5.0
  1724. * @deprecated Use wp_get_attachment_image_src()
  1725. * @see wp_get_attachment_image_src()
  1726. *
  1727. * @param int $id Optional. Post ID.
  1728. * @param bool $fullsize Optional, default to false. Whether to have full image.
  1729. * @return array Icon URL and full path to file, respectively.
  1730. */
  1731. function get_attachment_icon_src( $id = 0, $fullsize = false ) {
  1732. _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image_src()' );
  1733. $id = (int) $id;
  1734. if ( !$post = get_post($id) )
  1735. return false;
  1736. $file = get_attached_file( $post->ID );
  1737. if ( !$fullsize && $src = wp_get_attachment_thumb_url( $post->ID ) ) {
  1738. // We have a thumbnail desired, specified and existing
  1739. $src_file = basename($src);
  1740. $class = 'attachmentthumb';
  1741. } elseif ( wp_attachment_is_image( $post->ID ) ) {
  1742. // We have an image without a thumbnail
  1743. $src = wp_get_attachment_url( $post->ID );
  1744. $src_file = & $file;
  1745. $class = 'attachmentimage';
  1746. } elseif ( $src = wp_mime_type_icon( $post->ID ) ) {
  1747. // No thumb, no image. We'll look for a mime-related icon instead.
  1748. $icon_dir = apply_filters( 'icon_dir', get_template_directory() . '/images' );
  1749. $src_file = $icon_dir . '/' . basename($src);
  1750. }
  1751. if ( !isset($src) || !$src )
  1752. return false;
  1753. return array($src, $src_file);
  1754. }
  1755. /**
  1756. * Retrieve HTML content of icon attachment image element.
  1757. *
  1758. * @since 2.0.0
  1759. * @deprecated 2.5.0
  1760. * @deprecated Use wp_get_attachment_image()
  1761. * @see wp_get_attachment_image()
  1762. *
  1763. * @param int $id Optional. Post ID.
  1764. * @param bool $fullsize Optional, default to false. Whether to have full size image.
  1765. * @param array $max_dims Optional. Dimensions of image.
  1766. * @return string HTML content.
  1767. */
  1768. function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) {
  1769. _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image()' );
  1770. $id = (int) $id;
  1771. if ( !$post = get_post($id) )
  1772. return false;
  1773. if ( !$src = get_attachment_icon_src( $post->ID, $fullsize ) )
  1774. return false;
  1775. list($src, $src_file) = $src;
  1776. // Do we need to constrain the image?
  1777. if ( ($max_dims = apply_filters('attachment_max_dims', $max_dims)) && file_exists($src_file) ) {
  1778. $imagesize = getimagesize($src_file);
  1779. if (($imagesize[0] > $max_dims[0]) || $imagesize[1] > $max_dims[1] ) {
  1780. $actual_aspect = $imagesize[0] / $imagesize[1];
  1781. $desired_aspect = $max_dims[0] / $max_dims[1];
  1782. if ( $actual_aspect >= $desired_aspect ) {
  1783. $height = $actual_aspect * $max_dims[0];
  1784. $constraint = "width='{$max_dims[0]}' ";
  1785. $post->iconsize = array($max_dims[0], $height);
  1786. } else {
  1787. $width = $max_dims[1] / $actual_aspect;
  1788. $constraint = "height='{$max_dims[1]}' ";
  1789. $post->iconsize = array($width, $max_dims[1]);
  1790. }
  1791. } else {
  1792. $post->iconsize = array($imagesize[0], $imagesize[1]);
  1793. $constraint = '';
  1794. }
  1795. } else {
  1796. $constraint = '';
  1797. }
  1798. $post_title = esc_attr($post->post_title);
  1799. $icon = "<img src='$src' title='$post_title' alt='$post_title' $constraint/>";
  1800. return apply_filters( 'attachment_icon', $icon, $post->ID );
  1801. }
  1802. /**
  1803. * Retrieve HTML content of image element.
  1804. *
  1805. * @since 2.0.0
  1806. * @deprecated 2.5.0
  1807. * @deprecated Use wp_get_attachment_image()
  1808. * @see wp_get_attachment_image()
  1809. *
  1810. * @param int $id Optional. Post ID.
  1811. * @param bool $fullsize Optional, default to false. Whether to have full size image.
  1812. * @param array $max_dims Optional. Dimensions of image.
  1813. * @return string
  1814. */
  1815. function get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) {
  1816. _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image()' );
  1817. $id = (int) $id;
  1818. if ( !$post = get_post($id) )
  1819. return false;
  1820. if ( $innerHTML = get_attachment_icon($post->ID, $fullsize, $max_dims))
  1821. return $innerHTML;
  1822. $innerHTML = esc_attr($post->post_title);
  1823. return apply_filters('attachment_innerHTML', $innerHTML, $post->ID);
  1824. }
  1825. /**
  1826. * Retrieve bookmark data based on ID.
  1827. *
  1828. * @since 2.0.0
  1829. * @deprecated 2.1.0
  1830. * @deprecated Use get_bookmark()
  1831. * @see get_bookmark()
  1832. *
  1833. * @param int $bookmark_id ID of link
  1834. * @param string $output OBJECT, ARRAY_N, or ARRAY_A
  1835. * @return object|array
  1836. */
  1837. function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') {
  1838. _deprecated_function( __FUNCTION__, '2.1', 'get_bookmark()' );
  1839. return get_bookmark($bookmark_id, $output, $filter);
  1840. }
  1841. /**
  1842. * Performs esc_url() for database or redirect usage.
  1843. *
  1844. * @since 2.3.1
  1845. * @deprecated 2.8.0
  1846. * @deprecated Use esc_url_raw()
  1847. * @see esc_url_raw()
  1848. *
  1849. * @param string $url The URL to be cleaned.
  1850. * @param array $protocols An array of acceptable protocols.
  1851. * @return string The cleaned URL.
  1852. */
  1853. function sanitize_url( $url, $protocols = null ) {
  1854. _deprecated_function( __FUNCTION__, '2.8', 'esc_url_raw()' );
  1855. return esc_url_raw( $url, $protocols );
  1856. }
  1857. /**
  1858. * Checks and cleans a URL.
  1859. *
  1860. * A number of characters are removed from the URL. If the URL is for displaying
  1861. * (the default behaviour) ampersands are also replaced. The 'clean_url' filter
  1862. * is applied to the returned cleaned URL.
  1863. *
  1864. * @since 1.2.0
  1865. * @deprecated 3.0.0
  1866. * @deprecated Use esc_url()
  1867. * @see Alias for esc_url()
  1868. *
  1869. * @param string $url The URL to be cleaned.
  1870. * @param array $protocols Optional. An array of acceptable protocols.
  1871. * @param string $context Optional. How the URL will be used. Default is 'display'.
  1872. * @return string The cleaned $url after the 'clean_url' filter is applied.
  1873. */
  1874. function clean_url( $url, $protocols = null, $context = 'display' ) {
  1875. if ( $context == 'db' )
  1876. _deprecated_function( 'clean_url( $context = \'db\' )', '3.0', 'esc_url_raw()' );
  1877. else
  1878. _deprecated_function( __FUNCTION__, '3.0', 'esc_url()' );
  1879. return esc_url( $url, $protocols, $context );
  1880. }
  1881. /**
  1882. * Escape single quotes, specialchar double quotes, and fix line endings.
  1883. *
  1884. * The filter 'js_escape' is also applied by esc_js()
  1885. *
  1886. * @since 2.0.4
  1887. * @deprecated 2.8.0
  1888. * @deprecated Use esc_js()
  1889. * @see esc_js()
  1890. *
  1891. * @param string $text The text to be escaped.
  1892. * @return string Escaped text.
  1893. */
  1894. function js_escape( $text ) {
  1895. _deprecated_function( __FUNCTION__, '2.8', 'esc_js()' );
  1896. return esc_js( $text );
  1897. }
  1898. /**
  1899. * Escaping for HTML blocks.
  1900. *
  1901. * @deprecated 2.8.0
  1902. * @deprecated Use esc_html()
  1903. * @see esc_html()
  1904. */
  1905. function wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) {
  1906. _deprecated_function( __FUNCTION__, '2.8', 'esc_html()' );
  1907. if ( func_num_args() > 1 ) { // Maintain backwards compat for people passing additional args
  1908. $args = func_get_args();
  1909. return call_user_func_array( '_wp_specialchars', $args );
  1910. } else {
  1911. return esc_html( $string );
  1912. }
  1913. }
  1914. /**
  1915. * Escaping for HTML attributes.
  1916. *
  1917. * @since 2.0.6
  1918. * @deprecated 2.8.0
  1919. * @deprecated Use esc_attr()
  1920. * @see esc_attr()
  1921. *
  1922. * @param string $text
  1923. * @return string
  1924. */
  1925. function attribute_escape( $text ) {
  1926. _deprecated_function( __FUNCTION__, '2.8', 'esc_attr()' );
  1927. return esc_attr( $text );
  1928. }
  1929. /**
  1930. * Register widget for sidebar with backwards compatibility.
  1931. *
  1932. * Allows $name to be an array that accepts either three elements to grab the
  1933. * first element and the third for the name or just uses the first element of
  1934. * the array for the name.
  1935. *
  1936. * Passes to {@link wp_register_sidebar_widget()} after argument list and
  1937. * backwards compatibility is complete.
  1938. *
  1939. * @since 2.2.0
  1940. * @deprecated 2.8.0
  1941. * @deprecated Use wp_register_sidebar_widget()
  1942. * @see wp_register_sidebar_widget()
  1943. *
  1944. * @param string|int $name Widget ID.
  1945. * @param callback $output_callback Run when widget is called.
  1946. * @param string $classname Classname widget option.
  1947. * @param mixed $params,... Widget parameters.
  1948. */
  1949. function register_sidebar_widget($name, $output_callback, $classname = '') {
  1950. _deprecated_function( __FUNCTION__, '2.8', 'wp_register_sidebar_widget()' );
  1951. // Compat
  1952. if ( is_array($name) ) {
  1953. if ( count($name) == 3 )
  1954. $name = sprintf($name[0], $name[2]);
  1955. else
  1956. $name = $name[0];
  1957. }
  1958. $id = sanitize_title($name);
  1959. $options = array();
  1960. if ( !empty($classname) && is_string($classname) )
  1961. $options['classname'] = $classname;
  1962. $params = array_slice(func_get_args(), 2);
  1963. $args = array($id, $name, $output_callback, $options);
  1964. if ( !empty($params) )
  1965. $args = array_merge($args, $params);
  1966. call_user_func_array('wp_register_sidebar_widget', $args);
  1967. }
  1968. /**
  1969. * Alias of {@link wp_unregister_sidebar_widget()}.
  1970. *
  1971. * @since 2.2.0
  1972. * @deprecated 2.8.0
  1973. * @deprecated Use wp_unregister_sidebar_widget()
  1974. * @see wp_unregister_sidebar_widget()
  1975. *
  1976. * @param int|string $id Widget ID.
  1977. */
  1978. function unregister_sidebar_widget($id) {
  1979. _deprecated_function( __FUNCTION__, '2.8', 'wp_unregister_sidebar_widget()' );
  1980. return wp_unregister_sidebar_widget($id);
  1981. }
  1982. /**
  1983. * Registers widget control callback for customizing options.
  1984. *
  1985. * Allows $name to be an array that accepts either three elements to grab the
  1986. * first element and the third for the name or just uses the first element of
  1987. * the array for the name.
  1988. *
  1989. * Passes to {@link wp_register_widget_control()} after the argument list has
  1990. * been compiled.
  1991. *
  1992. * @since 2.2.0
  1993. * @deprecated 2.8.0
  1994. * @deprecated Use wp_register_widget_control()
  1995. * @see wp_register_widget_control()
  1996. *
  1997. * @param int|string $name Sidebar ID.
  1998. * @param callback $control_callback Widget control callback to display and process form.
  1999. * @param int $width Widget width.
  2000. * @param int $height Widget height.
  2001. */
  2002. function register_widget_control($name, $control_callback, $width = '', $height = '') {
  2003. _deprecated_function( __FUNCTION__, '2.8', 'wp_register_widget_control()' );
  2004. // Compat
  2005. if ( is_array($name) ) {
  2006. if ( count($name) == 3 )
  2007. $name = sprintf($name[0], $name[2]);
  2008. else
  2009. $name = $name[0];
  2010. }
  2011. $id = sanitize_title($name);
  2012. $options = array();
  2013. if ( !empty($width) )
  2014. $options['width'] = $width;
  2015. if ( !empty($height) )
  2016. $options['height'] = $height;
  2017. $params = array_slice(func_get_args(), 4);
  2018. $args = array($id, $name, $control_callback, $options);
  2019. if ( !empty($params) )
  2020. $args = array_merge($args, $params);
  2021. call_user_func_array('wp_register_widget_control', $args);
  2022. }
  2023. /**
  2024. * Alias of {@link wp_unregister_widget_control()}.
  2025. *
  2026. * @since 2.2.0
  2027. * @deprecated 2.8.0
  2028. * @deprecated Use wp_unregister_widget_control()
  2029. * @see wp_unregister_widget_control()
  2030. *
  2031. * @param int|string $id Widget ID.
  2032. */
  2033. function unregister_widget_control($id) {
  2034. _deprecated_function( __FUNCTION__, '2.8', 'wp_unregister_widget_control()' );
  2035. return wp_unregister_widget_control($id);
  2036. }
  2037. /**
  2038. * Remove user meta data.
  2039. *
  2040. * @since 2.0.0
  2041. * @deprecated 3.0.0
  2042. * @deprecated Use delete_user_meta()
  2043. * @see delete_user_meta()
  2044. *
  2045. * @param int $user_id User ID.
  2046. * @param string $meta_key Metadata key.
  2047. * @param mixed $meta_value Metadata value.
  2048. * @return bool True deletion completed and false if user_id is not a number.
  2049. */
  2050. function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) {
  2051. _deprecated_function( __FUNCTION__, '3.0', 'delete_user_meta()' );
  2052. global $wpdb;
  2053. if ( !is_numeric( $user_id ) )
  2054. return false;
  2055. $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
  2056. if ( is_array($meta_value) || is_object($meta_value) )
  2057. $meta_value = serialize($meta_value);
  2058. $meta_value = trim( $meta_value );
  2059. $cur = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
  2060. if ( $cur && $cur->umeta_id )
  2061. do_action( 'delete_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );
  2062. if ( ! empty($meta_value) )
  2063. $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s AND meta_value = %s", $user_id, $meta_key, $meta_value) );
  2064. else
  2065. $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
  2066. clean_user_cache( $user_id );
  2067. wp_cache_delete( $user_id, 'user_meta' );
  2068. if ( $cur && $cur->umeta_id )
  2069. do_action( 'deleted_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );
  2070. return true;
  2071. }
  2072. /**
  2073. * Retrieve user metadata.
  2074. *
  2075. * If $user_id is not a number, then the function will fail over with a 'false'
  2076. * boolean return value. Other returned values depend on whether there is only
  2077. * one item to be returned, which be that single item type. If there is more
  2078. * than one metadata value, then it will be list of metadata values.
  2079. *
  2080. * @since 2.0.0
  2081. * @deprecated 3.0.0
  2082. * @deprecated Use get_user_meta()
  2083. * @see get_user_meta()
  2084. *
  2085. * @param int $user_id User ID
  2086. * @param string $meta_key Optional. Metadata key.
  2087. * @return mixed
  2088. */
  2089. function get_usermeta( $user_id, $meta_key = '' ) {
  2090. _deprecated_function( __FUNCTION__, '3.0', 'get_user_meta()' );
  2091. global $wpdb;
  2092. $user_id = (int) $user_id;
  2093. if ( !$user_id )
  2094. return false;
  2095. if ( !empty($meta_key) ) {
  2096. $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
  2097. $user = wp_cache_get($user_id, 'users');
  2098. // Check the cached user object
  2099. if ( false !== $user && isset($user->$meta_key) )
  2100. $metas = array($user->$meta_key);
  2101. else
  2102. $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
  2103. } else {
  2104. $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d", $user_id) );
  2105. }
  2106. if ( empty($metas) ) {
  2107. if ( empty($meta_key) )
  2108. return array();
  2109. else
  2110. return '';
  2111. }
  2112. $metas = array_map('maybe_unserialize', $metas);
  2113. if ( count($metas) == 1 )
  2114. return $metas[0];
  2115. else
  2116. return $metas;
  2117. }
  2118. /**
  2119. * Update metadata of user.
  2120. *
  2121. * There is no need to serialize values, they will be serialized if it is
  2122. * needed. The metadata key can only be a string with underscores. All else will
  2123. * be removed.
  2124. *
  2125. * Will remove the metadata, if the meta value is empty.
  2126. *
  2127. * @since 2.0.0
  2128. * @deprecated 3.0.0
  2129. * @deprecated Use update_user_meta()
  2130. * @see update_user_meta()
  2131. *
  2132. * @param int $user_id User ID
  2133. * @param string $meta_key Metadata key.
  2134. * @param mixed $meta_value Metadata value.
  2135. * @return bool True on successful update, false on failure.
  2136. */
  2137. function update_usermeta( $user_id, $meta_key, $meta_value ) {
  2138. _deprecated_function( __FUNCTION__, '3.0', 'update_user_meta()' );
  2139. global $wpdb;
  2140. if ( !is_numeric( $user_id ) )
  2141. return false;
  2142. $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
  2143. /** @todo Might need fix because usermeta data is assumed to be already escaped */
  2144. if ( is_string($meta_value) )
  2145. $meta_value = stripslashes($meta_value);
  2146. $meta_value = maybe_serialize($meta_value);
  2147. if (empty($meta_value)) {
  2148. return delete_usermeta($user_id, $meta_key);
  2149. }
  2150. $cur = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
  2151. if ( $cur )
  2152. do_action( 'update_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );
  2153. if ( !$cur )
  2154. $wpdb->insert($wpdb->usermeta, compact('user_id', 'meta_key', 'meta_value') );
  2155. else if ( $cur->meta_value != $meta_value )
  2156. $wpdb->update($wpdb->usermeta, compact('meta_value'), compact('user_id', 'meta_key') );
  2157. else
  2158. return false;
  2159. clean_user_cache( $user_id );
  2160. wp_cache_delete( $user_id, 'user_meta' );
  2161. if ( !$cur )
  2162. do_action( 'added_usermeta', $wpdb->insert_id, $user_id, $meta_key, $meta_value );
  2163. else
  2164. do_action( 'updated_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );
  2165. return true;
  2166. }
  2167. /**
  2168. * Get users for the blog.
  2169. *
  2170. * For setups that use the multi-blog feature. Can be used outside of the
  2171. * multi-blog feature.
  2172. *
  2173. * @since 2.2.0
  2174. * @deprecated 3.1.0
  2175. * @uses $wpdb WordPress database object for queries
  2176. * @uses $blog_id The Blog id of the blog for those that use more than one blog
  2177. *
  2178. * @param int $id Blog ID.
  2179. * @return array List of users that are part of that Blog ID
  2180. */
  2181. function get_users_of_blog( $id = '' ) {
  2182. _deprecated_function( __FUNCTION__, '3.1', 'get_users()' );
  2183. global $wpdb, $blog_id;
  2184. if ( empty($id) )
  2185. $id = (int) $blog_id;
  2186. $blog_prefix = $wpdb->get_blog_prefix($id);
  2187. $users = $wpdb->get_results( "SELECT user_id, user_id AS ID, user_login, display_name, user_email, meta_value FROM $wpdb->users, $wpdb->usermeta WHERE {$wpdb->users}.ID = {$wpdb->usermeta}.user_id AND meta_key = '{$blog_prefix}capabilities' ORDER BY {$wpdb->usermeta}.user_id" );
  2188. return $users;
  2189. }
  2190. /**
  2191. * Enable/disable automatic general feed link outputting.
  2192. *
  2193. * @since 2.8.0
  2194. * @deprecated 3.0.0
  2195. * @deprecated Use add_theme_support( 'automatic-feed-links' )
  2196. *
  2197. * @param boolean $add Optional, default is true. Add or remove links. Defaults to true.
  2198. */
  2199. function automatic_feed_links( $add = true ) {
  2200. _deprecated_function( __FUNCTION__, '3.0', "add_theme_support( 'automatic-feed-links' )" );
  2201. if ( $add )
  2202. add_theme_support( 'automatic-feed-links' );
  2203. else
  2204. remove_action( 'wp_head', 'feed_links_extra', 3 ); // Just do this yourself in 3.0+
  2205. }
  2206. /**
  2207. * Retrieve user data based on field.
  2208. *
  2209. * @since 1.5.0
  2210. * @deprecated 3.0.0
  2211. * @deprecated Use get_the_author_meta()
  2212. * @see get_the_author_meta()
  2213. */
  2214. function get_profile( $field, $user = false ) {
  2215. _deprecated_function( __FUNCTION__, '3.0', 'get_the_author_meta()' );
  2216. if ( $user ) {
  2217. $user = get_user_by( 'login', $user );
  2218. $user = $user->ID;
  2219. }
  2220. return get_the_author_meta( $field, $user );
  2221. }
  2222. /**
  2223. * Number of posts user has written.
  2224. *
  2225. * @since 0.71
  2226. * @deprecated 3.0.0
  2227. * @deprecated Use count_user_posts()
  2228. * @see count_user_posts()
  2229. */
  2230. function get_usernumposts( $userid ) {
  2231. _deprecated_function( __FUNCTION__, '3.0', 'count_user_posts()' );
  2232. return count_user_posts( $userid );
  2233. }
  2234. /**
  2235. * Callback used to change %uXXXX to &#YYY; syntax
  2236. *
  2237. * @since 2.8.0
  2238. * @access private
  2239. * @deprecated 3.0.0
  2240. *
  2241. * @param array $matches Single Match
  2242. * @return string An HTML entity
  2243. */
  2244. function funky_javascript_callback($matches) {
  2245. return "&#".base_convert($matches[1],16,10).";";
  2246. }
  2247. /**
  2248. * Fixes javascript bugs in browsers.
  2249. *
  2250. * Converts unicode characters to HTML numbered entities.
  2251. *
  2252. * @since 1.5.0
  2253. * @uses $is_macIE
  2254. * @uses $is_winIE
  2255. * @deprecated 3.0.0
  2256. *
  2257. * @param string $text Text to be made safe.
  2258. * @return string Fixed text.
  2259. */
  2260. function funky_javascript_fix($text) {
  2261. _deprecated_function( __FUNCTION__, '3.0' );
  2262. // Fixes for browsers' javascript bugs
  2263. global $is_macIE, $is_winIE;
  2264. if ( $is_winIE || $is_macIE )
  2265. $text = preg_replace_callback("/\%u([0-9A-F]{4,4})/",
  2266. "funky_javascript_callback",
  2267. $text);
  2268. return $text;
  2269. }
  2270. /**
  2271. * Checks that the taxonomy name exists.
  2272. *
  2273. * @since 2.3.0
  2274. * @deprecated 3.0.0
  2275. * @deprecated Use taxonomy_exists()
  2276. * @see taxonomy_exists()
  2277. *
  2278. * @param string $taxonomy Name of taxonomy object
  2279. * @return bool Whether the taxonomy exists.
  2280. */
  2281. function is_taxonomy( $taxonomy ) {
  2282. _deprecated_function( __FUNCTION__, '3.0', 'taxonomy_exists()' );
  2283. return taxonomy_exists( $taxonomy );
  2284. }
  2285. /**
  2286. * Check if Term exists.
  2287. *
  2288. * @since 2.3.0
  2289. * @deprecated 3.0.0
  2290. * @deprecated Use term_exists()
  2291. * @see term_exists()
  2292. *
  2293. * @param int|string $term The term to check
  2294. * @param string $taxonomy The taxonomy name to use
  2295. * @param int $parent ID of parent term under which to confine the exists search.
  2296. * @return mixed Get the term id or Term Object, if exists.
  2297. */
  2298. function is_term( $term, $taxonomy = '', $parent = 0 ) {
  2299. _deprecated_function( __FUNCTION__, '3.0', 'term_exists()' );
  2300. return term_exists( $term, $taxonomy, $parent );
  2301. }
  2302. /**
  2303. * Is the current admin page generated by a plugin?
  2304. *
  2305. * @since 1.5.0
  2306. * @deprecated 3.1.0
  2307. * @deprecated Use global $plugin_page and/or get_plugin_page_hookname() hooks.
  2308. *
  2309. * @global $plugin_page
  2310. *
  2311. * @return bool
  2312. */
  2313. function is_plugin_page() {
  2314. _deprecated_function( __FUNCTION__, '3.1' );
  2315. global $plugin_page;
  2316. if ( isset($plugin_page) )
  2317. return true;
  2318. return false;
  2319. }
  2320. /**
  2321. * Update the categories cache.
  2322. *
  2323. * This function does not appear to be used anymore or does not appear to be
  2324. * needed. It might be a legacy function left over from when there was a need
  2325. * for updating the category cache.
  2326. *
  2327. * @since 1.5.0
  2328. * @deprecated 3.1.0
  2329. *
  2330. * @return bool Always return True
  2331. */
  2332. function update_category_cache() {
  2333. _deprecated_function( __FUNCTION__, '3.1' );
  2334. return true;
  2335. }
  2336. /**
  2337. * Check for PHP timezone support
  2338. *
  2339. * @since 2.9.0
  2340. * @deprecated 3.2.0
  2341. *
  2342. * @return bool
  2343. */
  2344. function wp_timezone_supported() {
  2345. _deprecated_function( __FUNCTION__, '3.2' );
  2346. return true;
  2347. }
  2348. /**
  2349. * Display editor: TinyMCE, HTML, or both.
  2350. *
  2351. * @since 2.1.0
  2352. * @deprecated 3.3.0
  2353. * @deprecated Use wp_editor()
  2354. * @see wp_editor()
  2355. *
  2356. * @param string $content Textarea content.
  2357. * @param string $id Optional, default is 'content'. HTML ID attribute value.
  2358. * @param string $prev_id Optional, not used
  2359. * @param bool $media_buttons Optional, default is true. Whether to display media buttons.
  2360. * @param int $tab_index Optional, not used
  2361. */
  2362. function the_editor($content, $id = 'content', $prev_id = 'title', $media_buttons = true, $tab_index = 2, $extended = true) {
  2363. _deprecated_function( __FUNCTION__, '3.3', 'wp_editor()' );
  2364. wp_editor( $content, $id, array( 'media_buttons' => $media_buttons ) );
  2365. return;
  2366. }
  2367. /**
  2368. * Perform the query to get the $metavalues array(s) needed by _fill_user and _fill_many_users
  2369. *
  2370. * @since 3.0.0
  2371. * @deprecated 3.3.0
  2372. *
  2373. * @param array $ids User ID numbers list.
  2374. * @return array of arrays. The array is indexed by user_id, containing $metavalues object arrays.
  2375. */
  2376. function get_user_metavalues($ids) {
  2377. _deprecated_function( __FUNCTION__, '3.3' );
  2378. $objects = array();
  2379. $ids = array_map('intval', $ids);
  2380. foreach ( $ids as $id )
  2381. $objects[$id] = array();
  2382. $metas = update_meta_cache('user', $ids);
  2383. foreach ( $metas as $id => $meta ) {
  2384. foreach ( $meta as $key => $metavalues ) {
  2385. foreach ( $metavalues as $value ) {
  2386. $objects[$id][] = (object)array( 'user_id' => $id, 'meta_key' => $key, 'meta_value' => $value);
  2387. }
  2388. }
  2389. }
  2390. return $objects;
  2391. }
  2392. /**
  2393. * Sanitize every user field.
  2394. *
  2395. * If the context is 'raw', then the user object or array will get minimal santization of the int fields.
  2396. *
  2397. * @since 2.3.0
  2398. * @deprecated 3.3.0
  2399. *
  2400. * @param object|array $user The User Object or Array
  2401. * @param string $context Optional, default is 'display'. How to sanitize user fields.
  2402. * @return object|array The now sanitized User Object or Array (will be the same type as $user)
  2403. */
  2404. function sanitize_user_object($user, $context = 'display') {
  2405. _deprecated_function( __FUNCTION__, '3.3' );
  2406. if ( is_object($user) ) {
  2407. if ( !isset($user->ID) )
  2408. $user->ID = 0;
  2409. if ( !is_a( $user, 'WP_User' ) ) {
  2410. $vars = get_object_vars($user);
  2411. foreach ( array_keys($vars) as $field ) {
  2412. if ( is_string($user->$field) || is_numeric($user->$field) )
  2413. $user->$field = sanitize_user_field($field, $user->$field, $user->ID, $context);
  2414. }
  2415. }
  2416. $user->filter = $context;
  2417. } else {
  2418. if ( !isset($user['ID']) )
  2419. $user['ID'] = 0;
  2420. foreach ( array_keys($user) as $field )
  2421. $user[$field] = sanitize_user_field($field, $user[$field], $user['ID'], $context);
  2422. $user['filter'] = $context;
  2423. }
  2424. return $user;
  2425. }
  2426. /**
  2427. * Get boundary post relational link.
  2428. *
  2429. * Can either be start or end post relational link.
  2430. *
  2431. * @since 2.8.0
  2432. * @deprecated 3.3.0
  2433. *
  2434. * @param string $title Optional. Link title format.
  2435. * @param bool $in_same_cat Optional. Whether link should be in a same category.
  2436. * @param string $excluded_categories Optional. Excluded categories IDs.
  2437. * @param bool $start Optional, default is true. Whether to display link to first or last post.
  2438. * @return string
  2439. */
  2440. function get_boundary_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $start = true) {
  2441. _deprecated_function( __FUNCTION__, '3.3' );
  2442. $posts = get_boundary_post($in_same_cat, $excluded_categories, $start);
  2443. // If there is no post stop.
  2444. if ( empty($posts) )
  2445. return;
  2446. // Even though we limited get_posts to return only 1 item it still returns an array of objects.
  2447. $post = $posts[0];
  2448. if ( empty($post->post_title) )
  2449. $post->post_title = $start ? __('First Post') : __('Last Post');
  2450. $date = mysql2date(get_option('date_format'), $post->post_date);
  2451. $title = str_replace('%title', $post->post_title, $title);
  2452. $title = str_replace('%date', $date, $title);
  2453. $title = apply_filters('the_title', $title, $post->ID);
  2454. $link = $start ? "<link rel='start' title='" : "<link rel='end' title='";
  2455. $link .= esc_attr($title);
  2456. $link .= "' href='" . get_permalink($post) . "' />\n";
  2457. $boundary = $start ? 'start' : 'end';
  2458. return apply_filters( "{$boundary}_post_rel_link", $link );
  2459. }
  2460. /**
  2461. * Display relational link for the first post.
  2462. *
  2463. * @since 2.8.0
  2464. * @deprecated 3.3.0
  2465. *
  2466. * @param string $title Optional. Link title format.
  2467. * @param bool $in_same_cat Optional. Whether link should be in a same category.
  2468. * @param string $excluded_categories Optional. Excluded categories IDs.
  2469. */
  2470. function start_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
  2471. _deprecated_function( __FUNCTION__, '3.3' );
  2472. echo get_boundary_post_rel_link($title, $in_same_cat, $excluded_categories, true);
  2473. }
  2474. /**
  2475. * Get site index relational link.
  2476. *
  2477. * @since 2.8.0
  2478. * @deprecated 3.3.0
  2479. *
  2480. * @return string
  2481. */
  2482. function get_index_rel_link() {
  2483. _deprecated_function( __FUNCTION__, '3.3' );
  2484. $link = "<link rel='index' title='" . esc_attr( get_bloginfo( 'name', 'display' ) ) . "' href='" . esc_url( user_trailingslashit( get_bloginfo( 'url', 'display' ) ) ) . "' />\n";
  2485. return apply_filters( "index_rel_link", $link );
  2486. }
  2487. /**
  2488. * Display relational link for the site index.
  2489. *
  2490. * @since 2.8.0
  2491. * @deprecated 3.3.0
  2492. */
  2493. function index_rel_link() {
  2494. _deprecated_function( __FUNCTION__, '3.3' );
  2495. echo get_index_rel_link();
  2496. }
  2497. /**
  2498. * Get parent post relational link.
  2499. *
  2500. * @since 2.8.0
  2501. * @deprecated 3.3.0
  2502. *
  2503. * @param string $title Optional. Link title format.
  2504. * @return string
  2505. */
  2506. function get_parent_post_rel_link($title = '%title') {
  2507. _deprecated_function( __FUNCTION__, '3.3' );
  2508. if ( ! empty( $GLOBALS['post'] ) && ! empty( $GLOBALS['post']->post_parent ) )
  2509. $post = get_post($GLOBALS['post']->post_parent);
  2510. if ( empty($post) )
  2511. return;
  2512. $date = mysql2date(get_option('date_format'), $post->post_date);
  2513. $title = str_replace('%title', $post->post_title, $title);
  2514. $title = str_replace('%date', $date, $title);
  2515. $title = apply_filters('the_title', $title, $post->ID);
  2516. $link = "<link rel='up' title='";
  2517. $link .= esc_attr( $title );
  2518. $link .= "' href='" . get_permalink($post) . "' />\n";
  2519. return apply_filters( "parent_post_rel_link", $link );
  2520. }
  2521. /**
  2522. * Display relational link for parent item
  2523. *
  2524. * @since 2.8.0
  2525. * @deprecated 3.3.0
  2526. */
  2527. function parent_post_rel_link($title = '%title') {
  2528. _deprecated_function( __FUNCTION__, '3.3' );
  2529. echo get_parent_post_rel_link($title);
  2530. }
  2531. /**
  2532. * Add the "Dashboard"/"Visit Site" menu.
  2533. *
  2534. * @since 3.2.0
  2535. * @deprecated 3.3.0
  2536. */
  2537. function wp_admin_bar_dashboard_view_site_menu( $wp_admin_bar ) {
  2538. _deprecated_function( __FUNCTION__, '3.3' );
  2539. $user_id = get_current_user_id();
  2540. if ( 0 != $user_id ) {
  2541. if ( is_admin() )
  2542. $wp_admin_bar->add_menu( array( 'id' => 'view-site', 'title' => __( 'Visit Site' ), 'href' => home_url() ) );
  2543. elseif ( is_multisite() )
  2544. $wp_admin_bar->add_menu( array( 'id' => 'dashboard', 'title' => __( 'Dashboard' ), 'href' => get_dashboard_url( $user_id ) ) );
  2545. else
  2546. $wp_admin_bar->add_menu( array( 'id' => 'dashboard', 'title' => __( 'Dashboard' ), 'href' => admin_url() ) );
  2547. }
  2548. }
  2549. /**
  2550. * Checks if the current user belong to a given blog.
  2551. *
  2552. * @since MU
  2553. * @deprecated 3.3.0
  2554. * @deprecated Use is_user_member_of_blog()
  2555. * @see is_user_member_of_blog()
  2556. *
  2557. * @param int $blog_id Blog ID
  2558. * @return bool True if the current users belong to $blog_id, false if not.
  2559. */
  2560. function is_blog_user( $blog_id = 0 ) {
  2561. _deprecated_function( __FUNCTION__, '3.3', 'is_user_member_of_blog()' );
  2562. return is_user_member_of_blog( get_current_user_id(), $blog_id );
  2563. }
  2564. /**
  2565. * Open the file handle for debugging.
  2566. *
  2567. * @since 0.71
  2568. * @deprecated Use error_log()
  2569. * @link http://www.php.net/manual/en/function.error-log.php
  2570. * @deprecated 3.4.0
  2571. */
  2572. function debug_fopen( $filename, $mode ) {
  2573. _deprecated_function( __FUNCTION__, 'error_log()' );
  2574. return false;
  2575. }
  2576. /**
  2577. * Write contents to the file used for debugging.
  2578. *
  2579. * @since 0.71
  2580. * @deprecated Use error_log() instead.
  2581. * @link http://www.php.net/manual/en/function.error-log.php
  2582. * @deprecated 3.4.0
  2583. */
  2584. function debug_fwrite( $fp, $string ) {
  2585. _deprecated_function( __FUNCTION__, 'error_log()' );
  2586. if ( ! empty( $GLOBALS['debug'] ) )
  2587. error_log( $string );
  2588. }
  2589. /**
  2590. * Close the debugging file handle.
  2591. *
  2592. * @since 0.71
  2593. * @deprecated Use error_log()
  2594. * @link http://www.php.net/manual/en/function.error-log.php
  2595. * @deprecated 3.4.0
  2596. */
  2597. function debug_fclose( $fp ) {
  2598. _deprecated_function( __FUNCTION__, 'error_log()' );
  2599. }
  2600. /**
  2601. * Retrieve list of themes with theme data in theme directory.
  2602. *
  2603. * The theme is broken, if it doesn't have a parent theme and is missing either
  2604. * style.css and, or index.php. If the theme has a parent theme then it is
  2605. * broken, if it is missing style.css; index.php is optional.
  2606. *
  2607. * @since 1.5.0
  2608. * @deprecated 3.4.0
  2609. * @deprecated Use wp_get_themes()
  2610. * @see wp_get_themes()
  2611. *
  2612. * @return array Theme list with theme data.
  2613. */
  2614. function get_themes() {
  2615. _deprecated_function( __FUNCTION__, '3.4', 'wp_get_themes()' );
  2616. global $wp_themes;
  2617. if ( isset( $wp_themes ) )
  2618. return $wp_themes;
  2619. $themes = wp_get_themes();
  2620. $wp_themes = array();
  2621. foreach ( $themes as $theme ) {
  2622. $name = $theme->get('Name');
  2623. if ( isset( $wp_themes[ $name ] ) )
  2624. $wp_themes[ $name . '/' . $theme->get_stylesheet() ] = $theme;
  2625. else
  2626. $wp_themes[ $name ] = $theme;
  2627. }
  2628. return $wp_themes;
  2629. }
  2630. /**
  2631. * Retrieve theme data.
  2632. *
  2633. * @since 1.5.0
  2634. * @deprecated 3.4.0
  2635. * @deprecated Use wp_get_theme()
  2636. * @see wp_get_theme()
  2637. *
  2638. * @param string $theme Theme name.
  2639. * @return array|null Null, if theme name does not exist. Theme data, if exists.
  2640. */
  2641. function get_theme( $theme ) {
  2642. _deprecated_function( __FUNCTION__, '3.4', 'wp_get_theme( $stylesheet )' );
  2643. $themes = get_themes();
  2644. if ( is_array( $themes ) && array_key_exists( $theme, $themes ) )
  2645. return $themes[ $theme ];
  2646. return null;
  2647. }
  2648. /**
  2649. * Retrieve current theme name.
  2650. *
  2651. * @since 1.5.0
  2652. * @deprecated 3.4.0
  2653. * @deprecated Use (string) wp_get_theme()
  2654. * @see wp_get_theme()
  2655. *
  2656. * @return string
  2657. */
  2658. function get_current_theme() {
  2659. _deprecated_function( __FUNCTION__, '3.4', 'wp_get_theme()' );
  2660. if ( $theme = get_option( 'current_theme' ) )
  2661. return $theme;
  2662. return wp_get_theme()->get('Name');
  2663. }
  2664. /**
  2665. * Accepts matches array from preg_replace_callback in wpautop() or a string.
  2666. *
  2667. * Ensures that the contents of a <<pre>>...<</pre>> HTML block are not
  2668. * converted into paragraphs or line-breaks.
  2669. *
  2670. * @since 1.2.0
  2671. * @deprecated 3.4.0
  2672. *
  2673. * @param array|string $matches The array or string
  2674. * @return string The pre block without paragraph/line-break conversion.
  2675. */
  2676. function clean_pre($matches) {
  2677. _deprecated_function( __FUNCTION__, '3.4' );
  2678. if ( is_array($matches) )
  2679. $text = $matches[1] . $matches[2] . "</pre>";
  2680. else
  2681. $text = $matches;
  2682. $text = str_replace(array('<br />', '<br/>', '<br>'), array('', '', ''), $text);
  2683. $text = str_replace('<p>', "\n", $text);
  2684. $text = str_replace('</p>', '', $text);
  2685. return $text;
  2686. }
  2687. /**
  2688. * Add callbacks for image header display.
  2689. *
  2690. * @since 2.1.0
  2691. * @deprecated 3.4.0
  2692. * @deprecated Use add_theme_support('custom-header', $args)
  2693. * @see add_theme_support()
  2694. *
  2695. * @param callback $wp_head_callback Call on 'wp_head' action.
  2696. * @param callback $admin_head_callback Call on custom header administration screen.
  2697. * @param callback $admin_preview_callback Output a custom header image div on the custom header administration screen. Optional.
  2698. */
  2699. function add_custom_image_header( $wp_head_callback, $admin_head_callback, $admin_preview_callback = '' ) {
  2700. _deprecated_function( __FUNCTION__, '3.4', 'add_theme_support( \'custom-header\', $args )' );
  2701. $args = array(
  2702. 'wp-head-callback' => $wp_head_callback,
  2703. 'admin-head-callback' => $admin_head_callback,
  2704. );
  2705. if ( $admin_preview_callback )
  2706. $args['admin-preview-callback'] = $admin_preview_callback;
  2707. return add_theme_support( 'custom-header', $args );
  2708. }
  2709. /**
  2710. * Remove image header support.
  2711. *
  2712. * @since 3.1.0
  2713. * @deprecated 3.4.0
  2714. * @deprecated Use remove_theme_support('custom-header')
  2715. * @see remove_theme_support()
  2716. *
  2717. * @return bool Whether support was removed.
  2718. */
  2719. function remove_custom_image_header() {
  2720. _deprecated_function( __FUNCTION__, '3.4', 'remove_theme_support( \'custom-header\' )' );
  2721. return remove_theme_support( 'custom-header' );
  2722. }
  2723. /**
  2724. * Add callbacks for background image display.
  2725. *
  2726. * @since 3.0.0
  2727. * @deprecated 3.4.0
  2728. * @deprecated Use add_theme_support('custom-background, $args)
  2729. * @see add_theme_support()
  2730. *
  2731. * @param callback $wp_head_callback Call on 'wp_head' action.
  2732. * @param callback $admin_head_callback Call on custom background administration screen.
  2733. * @param callback $admin_preview_callback Output a custom background image div on the custom background administration screen. Optional.
  2734. */
  2735. function add_custom_background( $wp_head_callback = '', $admin_head_callback = '', $admin_preview_callback = '' ) {
  2736. _deprecated_function( __FUNCTION__, '3.4', 'add_theme_support( \'custom-background\', $args )' );
  2737. $args = array();
  2738. if ( $wp_head_callback )
  2739. $args['wp-head-callback'] = $wp_head_callback;
  2740. if ( $admin_head_callback )
  2741. $args['admin-head-callback'] = $admin_head_callback;
  2742. if ( $admin_preview_callback )
  2743. $args['admin-preview-callback'] = $admin_preview_callback;
  2744. return add_theme_support( 'custom-background', $args );
  2745. }
  2746. /**
  2747. * Remove custom background support.
  2748. *
  2749. * @since 3.1.0
  2750. * @see add_custom_background()
  2751. *
  2752. * @return bool Whether support was removed.
  2753. */
  2754. function remove_custom_background() {
  2755. _deprecated_function( __FUNCTION__, '3.4', 'remove_theme_support( \'custom-background\' )' );
  2756. return remove_theme_support( 'custom-background' );
  2757. }
  2758. /**
  2759. * Retrieve theme data from parsed theme file.
  2760. *
  2761. * @since 1.5.0
  2762. * @deprecated 3.4.0
  2763. * @deprecated Use wp_get_theme()
  2764. * @see wp_get_theme()
  2765. *
  2766. * @param string $theme_file Theme file path.
  2767. * @return array Theme data.
  2768. */
  2769. function get_theme_data( $theme_file ) {
  2770. _deprecated_function( __FUNCTION__, '3.4', 'wp_get_theme()' );
  2771. $theme = new WP_Theme( basename( dirname( $theme_file ) ), dirname( dirname( $theme_file ) ) );
  2772. $theme_data = array(
  2773. 'Name' => $theme->get('Name'),
  2774. 'URI' => $theme->display('ThemeURI', true, false),
  2775. 'Description' => $theme->display('Description', true, false),
  2776. 'Author' => $theme->display('Author', true, false),
  2777. 'AuthorURI' => $theme->display('AuthorURI', true, false),
  2778. 'Version' => $theme->get('Version'),
  2779. 'Template' => $theme->get('Template'),
  2780. 'Status' => $theme->get('Status'),
  2781. 'Tags' => $theme->get('Tags'),
  2782. 'Title' => $theme->get('Name'),
  2783. 'AuthorName' => $theme->get('Author'),
  2784. );
  2785. foreach ( apply_filters( 'extra_theme_headers', array() ) as $extra_header ) {
  2786. if ( ! isset( $theme_data[ $extra_header ] ) )
  2787. $theme_data[ $extra_header ] = $theme->get( $extra_header );
  2788. }
  2789. return $theme_data;
  2790. }
  2791. /**
  2792. * Alias of update_post_cache().
  2793. *
  2794. * @see update_post_cache() Posts and pages are the same, alias is intentional
  2795. *
  2796. * @since 1.5.1
  2797. * @deprecated 3.4.0
  2798. *
  2799. * @param array $pages list of page objects
  2800. */
  2801. function update_page_cache( &$pages ) {
  2802. _deprecated_function( __FUNCTION__, '3.4', 'update_post_cache()' );
  2803. update_post_cache( $pages );
  2804. }
  2805. /**
  2806. * Will clean the page in the cache.
  2807. *
  2808. * Clean (read: delete) page from cache that matches $id. Will also clean cache
  2809. * associated with 'all_page_ids' and 'get_pages'.
  2810. *
  2811. * @since 2.0.0
  2812. * @deprecated 3.4.0
  2813. *
  2814. * @uses do_action() Will call the 'clean_page_cache' hook action.
  2815. *
  2816. * @param int $id Page ID to clean
  2817. */
  2818. function clean_page_cache( $id ) {
  2819. _deprecated_function( __FUNCTION__, '3.4', 'clean_post_cache()' );
  2820. clean_post_cache( $id );
  2821. }
  2822. /**
  2823. * Retrieve nonce action "Are you sure" message.
  2824. *
  2825. * Deprecated in 3.4.1 and 3.5.0. Backported to 3.3.3.
  2826. *
  2827. * @since 2.0.4
  2828. * @deprecated 3.4.1
  2829. * @deprecated Use wp_nonce_ays()
  2830. * @see wp_nonce_ays()
  2831. *
  2832. * @param string $action Nonce action.
  2833. * @return string Are you sure message.
  2834. */
  2835. function wp_explain_nonce( $action ) {
  2836. _deprecated_function( __FUNCTION__, '3.4.1', 'wp_nonce_ays()' );
  2837. return __( 'Are you sure you want to do this?' );
  2838. }
  2839. /**
  2840. * Display "sticky" CSS class, if a post is sticky.
  2841. *
  2842. * @since 2.7.0
  2843. * @deprecated 3.5.0
  2844. * @deprecated Use post_class()
  2845. * @see post_class()
  2846. *
  2847. * @param int $post_id An optional post ID.
  2848. */
  2849. function sticky_class( $post_id = null ) {
  2850. _deprecated_function( __FUNCTION__, '3.5', 'post_class()' );
  2851. if ( is_sticky( $post_id ) )
  2852. echo ' sticky';
  2853. }
  2854. /**
  2855. * Retrieve post ancestors.
  2856. *
  2857. * This is no longer needed as WP_Post lazy-loads the ancestors
  2858. * property with get_post_ancestors().
  2859. *
  2860. * @since 2.3.4
  2861. * @deprecated 3.5.0
  2862. * @see get_post_ancestors()
  2863. */
  2864. function _get_post_ancestors( &$post ) {
  2865. _deprecated_function( __FUNCTION__, '3.5' );
  2866. }
  2867. /**
  2868. * Retrieve a single post, based on post ID.
  2869. *
  2870. * Has categories in 'post_category' property or key. Has tags in 'tags_input'
  2871. * property or key.
  2872. *
  2873. * @since 1.0.0
  2874. * @deprecated 3.5.0
  2875. * @see get_post()
  2876. *
  2877. * @param int $postid Post ID.
  2878. * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A.
  2879. * @return object|array Post object or array holding post contents and information
  2880. */
  2881. function wp_get_single_post( $postid = 0, $mode = OBJECT ) {
  2882. _deprecated_function( __FUNCTION__, '3.5', 'get_post()' );
  2883. return get_post( $postid, $mode, 'edit' );
  2884. }
  2885. /**
  2886. * Check that the user login name and password is correct.
  2887. *
  2888. * @since 0.71
  2889. * @deprecated 3.5.0
  2890. * @deprecated Use wp_authenticate()
  2891. * @see wp_authenticate()
  2892. *
  2893. * @param string $user_login User name.
  2894. * @param string $user_pass User password.
  2895. * @return bool False if does not authenticate, true if username and password authenticates.
  2896. */
  2897. function user_pass_ok($user_login, $user_pass) {
  2898. _deprecated_function( __FUNCTION__, '3.5', 'wp_authenticate()' );
  2899. $user = wp_authenticate( $user_login, $user_pass );
  2900. if ( is_wp_error( $user ) )
  2901. return false;
  2902. return true;
  2903. }
  2904. /**
  2905. * Callback formerly fired on the save_post hook. No longer needed.
  2906. *
  2907. * @since 2.3.0
  2908. * @deprecated 3.5.0
  2909. */
  2910. function _save_post_hook() {}