Ticket #7538: 7538.r8665.diff
| File 7538.r8665.diff, 68.7 KB (added by santosj, 4 years ago) |
|---|
-
post.php
2 2 /** 3 3 * Post functions and post utility function. 4 4 * 5 * Warning: The inline documentation for the functions contained6 * in this file might be inaccurate, so the documentation is not7 * authoritative at the moment.8 *9 5 * @package WordPress 10 6 * @subpackage Post 11 * @since 1.5 7 * @since 1.5.0 12 8 */ 13 9 14 10 /** … … 22 18 * prevent looking up the meta name and provide a mechanism for sending the 23 19 * attached filename through a filter. 24 20 * 25 * @package WordPress 26 * @subpackage Post 27 * @since 2.0 28 * @uses apply_filters() Calls 'get_attached_file' on file path and attachment ID 21 * @since 2.0.0 22 * @uses apply_filters() Calls 'get_attached_file' on file path and attachment ID. 29 23 * 30 24 * @param int $attachment_id Attachment ID 31 25 * @param bool $unfiltered Whether to apply filters or not … … 44 38 * Used to update the file path of the attachment, which uses post meta name 45 39 * '_wp_attached_file' to store the path of the attachment. 46 40 * 47 * @package WordPress 48 * @subpackage Post 49 * @since 2.1 50 * @uses apply_filters() Calls 'update_attached_file' on file path and attachment ID 41 * @since 2.1.0 42 * @uses apply_filters() Calls 'update_attached_file' on file path and attachment ID. 51 43 * 52 44 * @param int $attachment_id Attachment ID 53 45 * @param string $file File path for the attachment … … 79 71 * example of what is possible. 80 72 * 81 73 * The arguments listed as defaults are for this function and also of the 82 * get_posts() function. The arguments are combined with the get_children 83 * defaults and are then passed to the get_posts() function, which accepts 84 * additional arguments. You can replace the defaults in this function, listed 85 * below and the additional arguments listed in the get_posts() function. 74 * {@link get_posts()} function. The arguments are combined with the 75 * get_children defaults and are then passed to the {@link get_posts()} 76 * function, which accepts additional arguments. You can replace the defaults in 77 * this function, listed below and the additional arguments listed in the 78 * {@link get_posts()} function. 86 79 * 87 80 * The 'post_parent' is the most important argument and important attention 88 81 * needs to be paid to the $args parameter. If you pass either an object or an … … 103 96 * @see get_posts() Has additional arguments that can be replaced. 104 97 * @internal Claims made in the long description might be inaccurate. 105 98 * 106 * @package WordPress 107 * @subpackage Post 108 * @since 2.0 99 * @since 2.0.0 109 100 * 110 101 * @param mixed $args Optional. User defined arguments for replacing the defaults. 111 102 * @param string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N. … … 156 147 } 157 148 158 149 /** 159 * get_extended() - Get extended entry info (<!--more-->)150 * Get extended entry info (<!--more-->). 160 151 * 161 * {@internal Missing Long Description}} 152 * There should not be any space after the second dash and before the word 153 * 'more'. There can be text or space(s) after the word 'more', but won't be 154 * referenced. 162 155 * 163 * @package WordPress 164 * @subpackage Post 156 * The returned array has 'main' and 'extended' keys. Main has the text before 157 * the <code><!--more--></code>. The 'extended' key has the content after the 158 * <code><!--more--></code> comment. 159 * 165 160 * @since 1.0.0 166 161 * 167 * @param string $post {@internal Missing Description}}168 * @return array {@internal Missing Description}}162 * @param string $post Post content. 163 * @return array Post before ('main') and after ('extended'). 169 164 */ 170 165 function get_extended($post) { 171 166 //Match the new style more links … … 184 179 } 185 180 186 181 /** 187 * get_post() -Retrieves post data given a post ID or post object.182 * Retrieves post data given a post ID or post object. 188 183 * 189 * {@internal Missing Long Description}} 184 * See {@link sanitize_post()} for optional $filter values. Also, the parameter 185 * $post, must be given as a variable, since it is passed by reference. 190 186 * 191 * @package WordPress192 * @subpackage Post193 187 * @since 1.5.1 194 188 * @uses $wpdb 195 189 * @link http://codex.wordpress.org/Function_Reference/get_post 196 190 * 197 * @param int|object &$post post ID or post object198 * @param string $output {@internal Missing Description}}199 * @param string $filter {@internal Missing Description}}200 * @return mixed {@internal Missing Description}}191 * @param int|object $post Post ID or post object. 192 * @param string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N. 193 * @param string $filter Optional, default is raw. 194 * @return mixed Post data 201 195 */ 202 196 function &get_post(&$post, $output = OBJECT, $filter = 'raw') { 203 197 global $wpdb; … … 241 235 /** 242 236 * Retrieve ancestors of a post. 243 237 * 244 * @package WordPress 245 * @subpackage Post 246 * @since 2.5 238 * @since 2.5.0 247 239 * 248 240 * @param int|object $post Post ID or post object 249 241 * @return array Ancestor IDs or empty array if none are found. … … 266 258 * The context values are based off of the taxonomy filter functions and 267 259 * supported values are found within those functions. 268 260 * 269 * @package WordPress 270 * @subpackage Post 271 * @since 2.3 261 * @since 2.3.0 272 262 * @uses sanitize_post_field() See for possible $context values. 273 263 * 274 264 * @param string $field Post field name … … 298 288 * This function can be used with any post type, but it makes more sense with 299 289 * attachments. 300 290 * 301 * @package WordPress 302 * @subpackage Post 303 * @since 2.0 291 * @since 2.0.0 304 292 * 305 293 * @param int $ID Optional. Post ID. 306 294 * @return bool|string False on failure or returns the mime type … … 320 308 * If the post ID is of an attachment, then the parent post status will be given 321 309 * instead. 322 310 * 323 * @package WordPress 324 * @subpackage Post 325 * @since 2.0 311 * @since 2.0.0 326 312 * 327 313 * @param int $ID Post ID 328 314 * @return string|bool Post status or false on failure. … … 346 332 * Posts have a limited set of valid status values, this provides the 347 333 * post_status values and descriptions. 348 334 * 349 * @package WordPress 350 * @subpackage Post 351 * @since 2.5 335 * @since 2.5.0 352 336 * 353 337 * @return array List of post statuses. 354 338 */ … … 369 353 * Pages have a limited set of valid status values, this provides the 370 354 * post_status values and descriptions. 371 355 * 372 * @package WordPress 373 * @subpackage Page 374 * @since 2.5 356 * @since 2.5.0 375 357 * 376 358 * @return array List of page statuses. 377 359 */ … … 386 368 } 387 369 388 370 /** 389 * get_post_type() - Returns post type371 * Retrieve the post type of the current post or of a given post. 390 372 * 391 * {@internal Missing Long Description}}373 * @since 2.1.0 392 374 * 393 * @package WordPress394 * @subpackage Post395 * @since 2.1396 *397 375 * @uses $wpdb 398 * @uses $posts {@internal Missing Description}}376 * @uses $posts The Loop post global 399 377 * 400 * @param mixed $post post object or post ID401 * @return mixed post type or false378 * @param mixed $post Optional. Post object or post ID. 379 * @return bool|string post type or false on failure. 402 380 */ 403 381 function get_post_type($post = false) { 404 382 global $posts; … … 415 393 } 416 394 417 395 /** 418 * set_post_type() - Set post type396 * Updates the post type for the post ID. 419 397 * 420 * {@internal Missing Long Description}}398 * The page or post cache will be cleaned for the post ID. 421 399 * 422 * @package WordPress 423 * @subpackage Post 424 * @since 2.5 400 * @since 2.5.0 425 401 * 426 402 * @uses $wpdb 427 * @uses $posts {@internal Missing Description}}428 403 * 429 * @param mixed $post_id post ID430 * @param mixed post type431 * @return bool {@internal Missing Description}}404 * @param int $post_id Post ID to change post type. Not actually optional. 405 * @param string $post_type Optional, default is post. Supported values are 'post' or 'page' to name a few. 406 * @return int Amount of rows changed. Should be 1 for success and 0 for failure. 432 407 */ 433 408 function set_post_type( $post_id = 0, $post_type = 'post' ) { 434 409 global $wpdb; … … 445 420 } 446 421 447 422 /** 448 * get_posts() - Returns a number of posts423 * Retrieve list of latest posts or posts matching criteria. 449 424 * 450 * {@internal Missing Long Description}} 425 * The defaults are as follows: 426 * 'numberposts' - Default is 5. Total number of posts to retrieve. 427 * 'offset' - Default is 0. See {@link WP_Query::query()} for more. 428 * 'category' - What category to pull the posts from. 429 * 'orderby' - Default is 'post_date'. How to order the posts. 430 * 'order' - Default is 'DESC'. The order to retrieve the posts. 431 * 'include' - See {@link WP_Query::query()} for more. 432 * 'exclude' - See {@link WP_Query::query()} for more. 433 * 'meta_key' - See {@link WP_Query::query()} for more. 434 * 'meta_value' - See {@link WP_Query::query()} for more. 435 * 'post_type' - Default is 'post'. Can be 'page', or 'attachment' to name a few. 436 * 'post_parent' - The parent of the post or post type. 437 * 'post_status' - Default is 'published'. Post status to retrieve. 451 438 * 452 * @package WordPress 453 * @subpackage Post 454 * @since 1.2 439 * @since 1.2.0 455 440 * @uses $wpdb 441 * @uses WP_Query::query() See for more default arguments and information. 456 442 * @link http://codex.wordpress.org/Template_Tags/get_posts 457 443 * 458 * @param array $args {@internal Missing Description}}459 * @return array {@internal Missing Description}}444 * @param array $args Optional. Override defaults. 445 * @return array List of posts. 460 446 */ 461 447 function get_posts($args = null) { 462 448 $defaults = array( … … 494 480 // 495 481 496 482 /** 497 * add_post_meta() - adds metadata for post483 * Add meta data field to a post. 498 484 * 499 * {@internal Missing Long Description}}485 * Post meta data is called "Custom Fields" on the Administration Panels. 500 486 * 501 * @package WordPress 502 * @subpackage Post 503 * @since 1.5 487 * @since 1.5.0 504 488 * @uses $wpdb 505 489 * @link http://codex.wordpress.org/Function_Reference/add_post_meta 506 490 * 507 * @param int $post_id post ID508 * @param string $key {@internal Missing Description}}509 * @param mixed $value {@internal Missing Description}}510 * @param bool $unique whether to check for a value with the same key511 * @return bool {@internal Missing Description}}491 * @param int $post_id Post ID. 492 * @param string $key Metadata name. 493 * @param mixed $value Metadata value. 494 * @param bool $unique Optional, default is false. Whether the same key should not be added. 495 * @return bool False for failure. True for success. 512 496 */ 513 497 function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) { 514 498 global $wpdb; … … 533 517 } 534 518 535 519 /** 536 * delete_post_meta() - delete post metadata520 * Remove metadata matching criteria from a post. 537 521 * 538 * {@internal Missing Long Description}} 522 * You can match based on the key, or key and value. Removing based on key and 523 * value, will keep from removing duplicate metadata with the same key. It also 524 * allows removing all metadata matching key, if needed. 539 525 * 540 * @package WordPress 541 * @subpackage Post 542 * @since 1.5 526 * @since 1.5.0 543 527 * @uses $wpdb 544 528 * @link http://codex.wordpress.org/Function_Reference/delete_post_meta 545 529 * 546 530 * @param int $post_id post ID 547 * @param string $key {@internal Missing Description}}548 * @param mixed $value {@internal Missing Description}}549 * @return bool {@internal Missing Description}}531 * @param string $key Metadata name. 532 * @param mixed $value Optional. Metadata value. 533 * @return bool False for failure. True for success. 550 534 */ 551 535 function delete_post_meta($post_id, $key, $value = '') { 552 536 global $wpdb; … … 576 560 } 577 561 578 562 /** 579 * get_post_meta() - Get a post meta field563 * Retrieve post meta field for a post. 580 564 * 581 * {@internal Missing Long Description}} 582 * 583 * @package WordPress 584 * @subpackage Post 585 * @since 1.5 565 * @since 1.5.0 586 566 * @uses $wpdb 587 567 * @link http://codex.wordpress.org/Function_Reference/get_post_meta 588 568 * 589 * @param int $post_id post ID590 * @param string $key The meta key to retrieve 591 * @param bool $single Whether to return a single value 592 * @return mixed {@internal Missing Description}}569 * @param int $post_id Post ID. 570 * @param string $key The meta key to retrieve. 571 * @param bool $single Whether to return a single value. 572 * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true. 593 573 */ 594 574 function get_post_meta($post_id, $key, $single = false) { 595 575 $post_id = (int) $post_id; … … 620 600 } 621 601 622 602 /** 623 * update_post_meta() - Update a post meta field603 * Update post meta field based on post ID. 624 604 * 625 * {@internal Missing Long Description}} 605 * Use the $prev_value parameter to differentiate between meta fields with the 606 * same key and post ID. 626 607 * 627 * @package WordPress628 * @subpackage Post608 * If the meta field for the post does not exist, it will be added. 609 * 629 610 * @since 1.5 630 611 * @uses $wpdb 631 612 * @link http://codex.wordpress.org/Function_Reference/update_post_meta 632 613 * 633 * @param int $post_id post ID634 * @param string $key {@internal Missing Description}}635 * @param mixed $value {@internal Missing Description}}636 * @param mixed $prev_value previous value (for differentiating between meta fields with the same key and post ID)637 * @return bool {@internal Missing Description}}614 * @param int $post_id Post ID. 615 * @param string $key Metadata key. 616 * @param mixed $value Metadata value. 617 * @param mixed $prev_value Optional. Previous value to check before removing. 618 * @return bool False on failure, true if success. 638 619 */ 639 620 function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') { 640 621 global $wpdb; … … 662 643 } 663 644 664 645 /** 665 * delete_post_meta_by_key() - Delete everything from post meta matching $post_meta_key646 * Delete everything from post meta matching meta key. 666 647 * 667 * @package WordPress 668 * @subpackage Post 669 * @since 2.3 648 * @since 2.3.0 670 649 * @uses $wpdb 671 650 * 672 * @param string $post_meta_key What to search for when deleting651 * @param string $post_meta_key Key to search for when deleting. 673 652 * @return bool Whether the post meta key was deleted from the database 674 653 */ 675 654 function delete_post_meta_by_key($post_meta_key) { … … 683 662 } 684 663 685 664 /** 686 * get_post_custom() - Retrieve post custom fields665 * Retrieve post meta fields, based on post ID. 687 666 * 688 * {@internal Missing Long Description}} 667 * The post meta fields are retrieved from the cache, so the function is 668 * optimized to be called more than once. It also applies to the functions, that 669 * use this function. 689 670 * 690 * @package WordPress 691 * @subpackage Post 692 * @since 1.2 671 * @since 1.2.0 693 672 * @link http://codex.wordpress.org/Function_Reference/get_post_custom 694 673 * 695 * @uses $id 696 * @uses $wpdb 674 * @uses $id Current Loop Post ID 697 675 * 698 676 * @param int $post_id post ID 699 * @return array {@internal Missing Description}}677 * @return array 700 678 */ 701 679 function get_post_custom($post_id = 0) { 702 680 global $id; … … 713 691 } 714 692 715 693 /** 716 * get_post_custom_keys() - Retrieve post custom field names694 * Retrieve meta field names for a post. 717 695 * 718 * @package WordPress719 * @subpackage Post720 * @since 1.2 696 * If there are no meta fields, then nothing (null) will be returned. 697 * 698 * @since 1.2.0 721 699 * @link http://codex.wordpress.org/Function_Reference/get_post_custom_keys 722 700 * 723 701 * @param int $post_id post ID 724 * @return array|null Either array of the keys, or null if keys would not be retrieved702 * @return array|null Either array of the keys, or null if keys could not be retrieved. 725 703 */ 726 704 function get_post_custom_keys( $post_id = 0 ) { 727 705 $custom = get_post_custom( $post_id ); … … 734 712 } 735 713 736 714 /** 737 * get_post_custom_values() - Retrieve values for a custom post field715 * Retrieve values for a custom post field. 738 716 * 739 * @package WordPress 740 * @subpackage Post 741 * @since 1.2 717 * The parameters must not be considered optional. All of the post meta fields 718 * will be retrieved and only the meta field key values returned. 719 * 720 * @since 1.2.0 742 721 * @link http://codex.wordpress.org/Function_Reference/get_post_custom_values 743 722 * 744 * @param string $key field name745 * @param int $post_id post ID746 * @return mixed {@internal Missing Description}}723 * @param string $key Meta field key. 724 * @param int $post_id Post ID 725 * @return array Meta field values. 747 726 */ 748 727 function get_post_custom_values( $key = '', $post_id = 0 ) { 749 728 $custom = get_post_custom($post_id); … … 752 731 } 753 732 754 733 /** 755 * is_sticky() - Check if post is sticky734 * Check if post is sticky. 756 735 * 757 * {@internal Missing Long Description}} 736 * Sticky posts should remain at the top of The Loop. If the post ID is not 737 * given, then The Loop ID for the current post will be used. 758 738 * 759 * @package WordPress 760 * @subpackage Post 761 * @since 2.7 739 * @since 2.7.0 762 740 * 763 * @param int $post_id A post ID764 * @return bool 741 * @param int $post_id Optional. Post ID. 742 * @return bool Whether post is sticky (true) or not sticky (false). 765 743 */ 766 744 function is_sticky($post_id = null) { 767 745 global $id; … … 782 760 return false; 783 761 } 784 762 785 786 763 /** 787 * sanitize_post() - Sanitize every post field764 * Sanitize every post field. 788 765 * 789 * {@internal Missing Long Description}}766 * If the context is 'raw', then the post object or array will just be returned. 790 767 * 791 * @package WordPress 792 * @subpackage Post 793 * @since 2.3 768 * @since 2.3.0 769 * @uses sanitize_post_field() Used to sanitize the fields. 794 770 * 795 771 * @param object|array $post The Post Object or Array 796 * @param string $context How to sanitize post fields772 * @param string $context Optional, default is 'display'. How to sanitize post fields. 797 773 * @return object|array The now sanitized Post Object or Array (will be the same type as $post) 798 774 */ 799 775 function sanitize_post($post, $context = 'display') { … … 810 786 } 811 787 812 788 /** 813 * sanitize_post_field() - Sanitize post field based on context789 * Sanitize post field based on context. 814 790 * 815 * {@internal Missing Long Description}} 791 * Possible context values are: raw, edit, db, attribute, js, and display. The 792 * display context is used by default. 816 793 * 817 * @package WordPress 818 * @subpackage Post 819 * @since 2.3 794 * @since 2.3.0 820 795 * 821 * @param string $field The Post Object field name 822 * @param string $value The Post Object value823 * @param int $post id Post ID824 * @param string $context How to sanitize post fields 825 * @return string Sanitized value796 * @param string $field The Post Object field name. 797 * @param mixed $value The Post Object value. 798 * @param int $post_id Post ID. 799 * @param string $context How to sanitize post fields. 800 * @return mixed Sanitized value. 826 801 */ 827 802 function sanitize_post_field($field, $value, $post_id, $context) { 828 803 $int_fields = array('ID', 'post_parent', 'menu_order'); … … 882 857 } 883 858 884 859 /** 885 * Make a post sticky 860 * Make a post sticky. 886 861 * 887 * Makes a post stick to the top of the front page862 * Sticky posts should be displayed at the top of the front page. 888 863 * 889 * @package WordPress 890 * @subpackage Post 891 * @since 2.7 864 * @since 2.7.0 892 865 * 893 * @param int $post_id A post ID866 * @param int $post_id Post ID. 894 867 */ 895 868 function stick_post($post_id) { 896 869 $stickies = get_option('sticky_posts'); … … 905 878 } 906 879 907 880 /** 908 * Unstick a post 881 * Unstick a post. 909 882 * 910 * Unstick a post from the front page883 * Sticky posts should be displayed at the top of the front page. 911 884 * 912 * @package WordPress 913 * @subpackage Post 914 * @since 2.7 885 * @since 2.7.0 915 886 * 916 * @param int $post_id A post ID887 * @param int $post_id Post ID. 917 888 */ 918 889 function unstick_post($post_id) { 919 890 $stickies = get_option('sticky_posts'); … … 944 915 * The $perm parameter checks for 'readable' value and if the user can read 945 916 * private posts, it will display that for the user that is signed in. 946 917 * 947 * @package WordPress 948 * @subpackage Post 949 * @since 2.5 918 * @since 2.5.0 950 919 * @link http://codex.wordpress.org/Template_Tags/wp_count_posts 951 920 * 952 921 * @param string $type Optional. Post type to retrieve count … … 988 957 989 958 990 959 /** 991 * wp_count_attachments() - Count number of attachments960 * Count number of attachments for the mime type(s). 992 961 * 993 * {@internal Missing Long Description}} 962 * If you set the optional mime_type parameter, then an array will still be 963 * returned, but will only have the item you are looking for. It does not give 964 * you the number of attachments that are children of a post. You can get that 965 * by counting the number of children that post has. 994 966 * 995 * @package WordPress 996 * @subpackage Post 997 * @since 2.5 967 * @since 2.5.0 998 968 * 999 * @param string|array $ post_mime_type Array or comma-separated list of MIME patterns1000 * @return array Number of posts for each post_mime_type969 * @param string|array $mime_type Optional. Array or comma-separated list of MIME patterns. 970 * @return array Number of posts for each mime type. 1001 971 */ 1002 1003 972 function wp_count_attachments( $mime_type = '' ) { 1004 973 global $wpdb; 1005 974 … … 1015 984 } 1016 985 1017 986 /** 1018 * wp_match_mime_type() - Check a MIME-Type against a list987 * Check a MIME-Type against a list. 1019 988 * 1020 * {@internal Missing Long Description}} 989 * If the wildcard_mime_types parameter is a string, it must be comma separated 990 * list. If the real_mime_types is a string, it is also comma separated to 991 * create the list. 1021 992 * 1022 * @package WordPress 1023 * @subpackage Post 1024 * @since 2.5 993 * @since 2.5.0 1025 994 * 1026 995 * @param string|array $wildcard_mime_types e.g. audio/mpeg or image (same as image/*) or flash (same as *flash*) 1027 996 * @param string|array $real_mime_types post_mime_type values … … 1052 1021 } 1053 1022 1054 1023 /** 1055 * wp_get_post_mime_type_where() - Convert MIME types into SQL1024 * Convert MIME types into SQL. 1056 1025 * 1057 * @package WordPress 1058 * @subpackage Post 1059 * @since 2.5 1026 * @since 2.5.0 1060 1027 * 1061 * @param string|array $mime_types MIME types1062 * @return string SQL AND clause1028 * @param string|array $mime_types List of mime types or comma separated string of mime types. 1029 * @return string The SQL AND clause for mime searching. 1063 1030 */ 1064 1031 function wp_post_mime_type_where($post_mime_types) { 1065 1032 $where = ''; … … 1099 1066 } 1100 1067 1101 1068 /** 1102 * wp_delete_post() - Deletes a Post1069 * Removes a post, attachment, or page. 1103 1070 * 1104 * {@internal Missing Long Description}} 1071 * When the post and page goes, everything that is tied to it is deleted also. 1072 * This includes comments, post meta fields, and terms associated with the post. 1105 1073 * 1106 * @package WordPress1107 * @subpackage Post1108 1074 * @since 1.0.0 1075 * @uses do_action() Calls 'deleted_post' hook on post ID. 1109 1076 * 1110 * @param int $postid post ID1111 * @return mixed {@internal Missing Description}}1077 * @param int $postid Post ID. 1078 * @return mixed 1112 1079 */ 1113 1080 function wp_delete_post($postid = 0) { 1114 1081 global $wpdb, $wp_rewrite; … … 1177 1144 } 1178 1145 1179 1146 /** 1180 * wp_get_post_categories() - Retrieve the list of categories for a post1147 * Retrieve the list of categories for a post. 1181 1148 * 1182 1149 * Compatibility layer for themes and plugins. Also an easy layer of abstraction 1183 1150 * away from the complexity of the taxonomy layer. 1184 1151 * 1185 * @package WordPress 1186 * @subpackage Post 1187 * @since 2.1 1152 * @since 2.1.0 1188 1153 * 1189 * @uses wp_get_object_terms() Retrieves the categories. Args details can be found here 1154 * @uses wp_get_object_terms() Retrieves the categories. Args details can be found here. 1190 1155 * 1191 * @param int $post_id Optional. The Post ID 1192 * @param array $args Optional. Overwrite the defaults 1193 * @return array {@internal Missing Description}}1156 * @param int $post_id Optional. The Post ID. 1157 * @param array $args Optional. Overwrite the defaults. 1158 * @return array 1194 1159 */ 1195 1160 function wp_get_post_categories( $post_id = 0, $args = array() ) { 1196 1161 $post_id = (int) $post_id; … … 1203 1168 } 1204 1169 1205 1170 /** 1206 * wp_get_post_tags() - Retrieve the post tags1171 * Retrieve the tags for a post. 1207 1172 * 1173 * There is only one default for this function, called 'fields' and by default 1174 * is set to 'all'. There are other defaults that can be override in 1175 * {@link wp_get_object_terms()}. 1176 * 1208 1177 * @package WordPress 1209 1178 * @subpackage Post 1210 * @since 2.3 1179 * @since 2.3.0 1211 1180 * 1212 1181 * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here 1213 1182 * 1214 1183 * @param int $post_id Optional. The Post ID 1215 1184 * @param array $args Optional. Overwrite the defaults 1216 * @return mixed The tags the post has currently1185 * @return array List of post tags. 1217 1186 */ 1218 1187 function wp_get_post_tags( $post_id = 0, $args = array() ) { 1219 1188 $post_id = (int) $post_id; … … 1227 1196 } 1228 1197 1229 1198 /** 1230 * wp_get_recent_posts() - Get the $num most recent posts1199 * Retrieve number of recent posts. 1231 1200 * 1232 * {@internal Missing Long Description}}1233 *1234 * @package WordPress1235 * @subpackage Post1236 1201 * @since 1.0.0 1202 * @uses $wpdb 1237 1203 * 1238 * @param int $num number of posts to get1239 * @return array {@internal Missing Description}}1204 * @param int $num Optional, default is 10. Number of posts to get. 1205 * @return array List of posts. 1240 1206 */ 1241 1207 function wp_get_recent_posts($num = 10) { 1242 1208 global $wpdb; … … 1250 1216 $sql = "SELECT * FROM $wpdb->posts WHERE post_type = 'post' ORDER BY post_date DESC $limit"; 1251 1217 $result = $wpdb->get_results($sql,ARRAY_A); 1252 1218 1253 return $result ?$result:array();1219 return $result ? $result : array(); 1254 1220 } 1255 1221 1256 1222 /** 1257 * wp_get_single_post() - Get one post1223 * Retrieve a single post, based on post ID. 1258 1224 * 1259 * {@internal Missing Long Description}} 1225 * Has categories in 'post_category' property or key. Has tags in 'tags_input' 1226 * property or key. 1260 1227 * 1261 * @package WordPress1262 * @subpackage Post1263 1228 * @since 1.0.0 1264 * @uses $wpdb1265 1229 * 1266 * @param int $postid post ID1267 * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A 1230 * @param int $postid Post ID. 1231 * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A. 1268 1232 * @return object|array Post object or array holding post contents and information 1269 1233 */ 1270 1234 function wp_get_single_post($postid = 0, $mode = OBJECT) { … … 1286 1250 } 1287 1251 1288 1252 /** 1289 * wp_insert_post() - Insert a post1253 * Insert a post. 1290 1254 * 1291 * {@internal Missing Long Description}}1255 * If the $postarr parameter has 'ID' set to a value, then post will be updated. 1292 1256 * 1293 * @package WordPress1294 * @subpackage Post1295 * @since 1.0.01257 * You can set the post date manually, but setting the values for 'post_date' 1258 * and 'post_date_gmt' keys. You can close the comments or open the comments by 1259 * setting the value for 'comment_status' key. 1296 1260 * 1261 * The defaults for the parameter $postarr are: 1262 * 'post_status' - Default is 'draft'. 1263 * 'post_type' - Default is 'post'. 1264 * 'post_author' - Default is current user ID. The ID of the user, who added 1265 * the post. 1266 * 'ping_status' - Default is the value in default ping status option. 1267 * Whether the attachment can accept pings. 1268 * 'post_parent' - Default is 0. Set this for the post it belongs to, if 1269 * any. 1270 * 'menu_order' - Default is 0. The order it is displayed. 1271 * 'to_ping' - Whether to ping. 1272 * 'pinged' - Default is empty string. 1273 * 'post_password' - Default is empty string. The password to access the 1274 * attachment. 1275 * 'guid' - Global Unique ID for referencing the attachment. 1276 * 'post_content_filtered' - Post content filtered. 1277 * 'post_excerpt' - Post excerpt. 1278 * 1279 * @since 1.0.0 1297 1280 * @uses $wpdb 1298 1281 * @uses $wp_rewrite 1299 1282 * @uses $user_ID 1300 * @uses $allowedtags1301 1283 * 1302 * @param array $postarr post contents 1303 * @return int post ID or 0 on error 1284 * @param array $postarr Optional. Override defaults. 1285 * @param bool $wp_error Optional. Allow return of WP_Error on failure. 1286 * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success. 1304 1287 */ 1305 1288 function wp_insert_post($postarr = array(), $wp_error = false) { 1306 1289 global $wpdb, $wp_rewrite, $user_ID; … … 1507 1490 } 1508 1491 1509 1492 /** 1510 * wp_update_post() - Update a post1493 * Update a post with new post data. 1511 1494 * 1512 * {@internal Missing Long Description}} 1495 * The date does not have to be set for drafts. You can set the date and it will 1496 * not be overridden. 1513 1497 * 1514 * @package WordPress1515 * @subpackage Post1516 1498 * @since 1.0.0 1517 * @uses $wpdb1518 1499 * 1519 * @param array $postarr post data1520 * @return int {@internal Missing Description}}1500 * @param array|object $postarr Post data. 1501 * @return int 0 on failure, Post ID on success. 1521 1502 */ 1522 1503 function wp_update_post($postarr = array()) { 1523 1504 if ( is_object($postarr) ) … … 1558 1539 } 1559 1540 1560 1541 /** 1561 * wp_publish_post() - Mark a post as "published"1542 * Publish a post by transitioning the post status. 1562 1543 * 1563 * {@internal Missing Long Description}} 1564 * 1565 * @package WordPress 1566 * @subpackage Post 1567 * @since 2.1 1544 * @since 2.1.0 1568 1545 * @uses $wpdb 1546 * @uses do_action() Calls 'edit_post', 'save_post', and 'wp_insert_post' on post_id and post data. 1569 1547 * 1570 * @param int $post_id Post ID 1571 * @return int|null {@internal Missing Description}}1548 * @param int $post_id Post ID. 1549 * @return null 1572 1550 */ 1573 1551 function wp_publish_post($post_id) { 1574 1552 global $wpdb; … … 1599 1577 } 1600 1578 1601 1579 /** 1602 * check_and_publish_future_post() - check to make sure post has correct status before 1603 * passing it on to be published. Invoked by cron 'publish_future_post' event 1604 * This safeguard prevents cron from publishing drafts, etc. 1580 * Publish future post and make sure post ID has future post status. 1605 1581 * 1606 * {@internal Missing Long Description}} 1582 * Invoked by cron 'publish_future_post' event. This safeguard prevents cron 1583 * from publishing drafts, etc. 1607 1584 * 1608 * @package WordPress 1609 * @subpackage Post 1610 * @since 2.5 1611 * @uses $wpdb 1585 * @since 2.5.0 1612 1586 * 1613 * @param int $post_id Post ID 1614 * @return int|null {@internal Missing Description}}1587 * @param int $post_id Post ID. 1588 * @return null Nothing is returned. Which can mean that no action is required or post was published. 1615 1589 */ 1616 1590 function check_and_publish_future_post($post_id) { 1617 1591 … … 1627 1601 } 1628 1602 1629 1603 /** 1630 * wp_add_post_tags() - Adds the tags to a post1604 * Adds tags to a post. 1631 1605 * 1632 * @uses wp_set_post_tags() Same first two para eters, but the last parameter is always set to true.1606 * @uses wp_set_post_tags() Same first two parameters, but the last parameter is always set to true. 1633 1607 * 1634 1608 * @package WordPress 1635 1609 * @subpackage Post 1636 * @since 2.3 1610 * @since 2.3.0 1637 1611 * 1638 * @param int $post_id Optional.Post ID1639 * @param string $tags The tags to set for the post 1612 * @param int $post_id Post ID 1613 * @param string $tags The tags to set for the post, separated by commas. 1640 1614 * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise 1641 1615 */ 1642 1616 function wp_add_post_tags($post_id = 0, $tags = '') { 1643 1617 return wp_set_post_tags($post_id, $tags, true); 1644 1618 } 1645 1619 1620 1646 1621 /** 1647 * wp_set_post_tags() - Set the tags for a post1622 * Set the tags for a post. 1648 1623 * 1649 * {@internal Missing Long Description}} 1624 * @since 2.3.0 1625 * @uses wp_set_object_terms() Sets the tags for the post. 1650 1626 * 1651 * @package WordPress 1652 * @subpackage Post 1653 * @since 2.3 1654 * @uses $wpdb 1655 * 1656 * @param int $post_id post ID 1657 * @param string $tags The tags to set for the post 1627 * @param int $post_id Post ID. 1628 * @param string $tags The tags to set for the post, separated by commas. 1658 1629 * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. 1659 1630 * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise 1660 1631 */ … … 1672 1643 } 1673 1644 1674 1645 /** 1675 * wp_set_post_categories() - Set categories for a post1646 * Set categories for a post. 1676 1647 * 1677 * {@internal Missing Long Description}} 1648 * If the post categories parameter is not set, then the default category is 1649 * going used. 1678 1650 * 1679 * @package WordPress 1680 * @subpackage Post 1681 * @since 2.1 1682 * @uses $wpdb 1651 * @since 2.1.0 1683 1652 * 1684 * @param int $post_ID post ID1685 * @param array $post_categories 1686 * @return bool|mixed {@internal Missing Description}}1653 * @param int $post_ID Post ID. 1654 * @param array $post_categories Optional. List of categories. 1655 * @return bool|mixed 1687 1656 */ 1688 1657 function wp_set_post_categories($post_ID = 0, $post_categories = array()) { 1689 1658 $post_ID = (int) $post_ID; … … 1697 1666 $post_categories = array_unique($post_categories); 1698 1667 1699 1668 return wp_set_object_terms($post_ID, $post_categories, 'category'); 1700 } // wp_set_post_categories()1669 } 1701 1670 1702 1671 /** 1703 * wp_transition_post_status() - Change the post transition status1672 * Transition the post status of a post. 1704 1673 * 1705 * {@internal Missing Long Description}} 1674 * Calls hooks to transition post status. If the new post status is not the same 1675 * as the previous post status, then two hooks will be ran, the first is 1676 * 'transition_post_status' with new status, old status, and post data. The 1677 * next action called is 'OLDSTATUS_to_NEWSTATUS' the NEWSTATUS is the 1678 * $new_status parameter and the OLDSTATUS is $old_status parameter; it has the 1679 * post data. 1706 1680 * 1707 * @package WordPress1708 * @subpackage Post1709 * @since 2.31681 * The final action will run whether or not the post statuses are the same. The 1682 * action is named 'NEWSTATUS_POSTTYPE', NEWSTATUS is from the $new_status 1683 * parameter and POSTTYPE is post_type post data. 1710 1684 * 1711 * @param string $new_status {@internal Missing Description}} 1712 * @param string $old_status {@internal Missing Description}} 1713 * @param int $post {@internal Missing Description}} 1685 * @since 2.3.0 1686 * 1687 * @param string $new_status Transition to this post status. 1688 * @param string $old_status Previous post status. 1689 * @param object $post Post data. 1714 1690 */ 1715 1691 function wp_transition_post_status($new_status, $old_status, $post) { 1716 1692 if ( $new_status != $old_status ) { … … 1725 1701 // 1726 1702 1727 1703 /** 1728 * add_ping() - Add a URL to those already pung1704 * Add a URL to those already pung. 1729 1705 * 1730 * {@internal Missing Long Description}} 1731 * 1732 * @package WordPress 1733 * @subpackage Post 1734 * @since 1.5 1706 * @since 1.5.0 1735 1707 * @uses $wpdb 1736 1708 * 1737 * @param int $post_id post ID1738 * @param string $uri {@internal Missing Description}}1739 * @return mixed {@internal Missing Description}}1709 * @param int $post_id Post ID. 1710 * @param string $uri Ping URI. 1711 * @return int How many rows were updated. 1740 1712 */ 1741 1713 function add_ping($post_id, $uri) { 1742 1714 global $wpdb; … … 1752 1724 } 1753 1725 1754 1726 /** 1755 * get_enclosed() - Get enclosures already enclosed for a post1727 * Retrieve enclosures already enclosed for a post. 1756 1728 * 1757 * {@internal Missing Long Description}} 1758 * 1759 * @package WordPress 1760 * @subpackage Post 1761 * @since 1.5 1729 * @since 1.5.0 1762 1730 * @uses $wpdb 1763 1731 * 1764 * @param int $post_id post ID1765 * @return array {@internal Missing Description}}1732 * @param int $post_id Post ID. 1733 * @return array List of enclosures 1766 1734 */ 1767 1735 function get_enclosed($post_id) { 1768 1736 $custom_fields = get_post_custom( $post_id ); … … 1783 1751 } 1784 1752 1785 1753 /** 1786 * get_pung() - Get URLs already pinged for a post1754 * Retrieve URLs already pinged for a post. 1787 1755 * 1788 * {@internal Missing Long Description}} 1789 * 1790 * @package WordPress 1791 * @subpackage Post 1792 * @since 1.5 1756 * @since 1.5.0 1793 1757 * @uses $wpdb 1794 1758 * 1795 * @param int $post_id post ID1796 * @return array {@internal Missing Description}}1759 * @param int $post_id Post ID. 1760 * @return array 1797 1761 */ 1798 1762 function get_pung($post_id) { 1799 1763 global $wpdb; … … 1805 1769 } 1806 1770 1807 1771 /** 1808 * get_to_ping() - Get any URLs in the todo list1772 * Retrieve URLs that need to be pinged. 1809 1773 * 1810 * {@internal Missing Long Description}} 1811 * 1812 * @package WordPress 1813 * @subpackage Post 1814 * @since 1.5 1774 * @since 1.5.0 1815 1775 * @uses $wpdb 1816 1776 * 1817 * @param int $post_id post ID1818 * @return array {@internal Missing Description}}1777 * @param int $post_id Post ID 1778 * @return array 1819 1779 */ 1820 1780 function get_to_ping($post_id) { 1821 1781 global $wpdb; … … 1827 1787 } 1828 1788 1829 1789 /** 1830 * trackback_url_list() - Do trackbacks for a list of urls1790 * Do trackbacks for a list of URLs. 1831 1791 * 1832 * {@internal Missing Long Description}}1833 *1834 * @package WordPress1835 * @subpackage Post1836 1792 * @since 1.0.0 1837 1793 * 1838 * @param string $tb_list comma separated list of URLs1839 * @param int $post_id post ID1794 * @param string $tb_list Comma separated list of URLs 1795 * @param int $post_id Post ID 1840 1796 */ 1841 1797 function trackback_url_list($tb_list, $post_id) { 1842 if ( !empty($tb_list)) {1798 if ( ! empty( $tb_list ) ) { 1843 1799 // get post data 1844 1800 $postdata = wp_get_single_post($post_id, ARRAY_A); 1845 1801 … … 1847 1803 extract($postdata, EXTR_SKIP); 1848 1804 1849 1805 // form an excerpt 1850 $excerpt = strip_tags($post_excerpt ?$post_excerpt:$post_content);1806 $excerpt = strip_tags($post_excerpt ? $post_excerpt : $post_content); 1851 1807 1852 1808 if (strlen($excerpt) > 255) { 1853 1809 $excerpt = substr($excerpt,0,252) . '...'; … … 1855 1811 1856 1812 $trackback_urls = explode(',', $tb_list); 1857 1813 foreach( (array) $trackback_urls as $tb_url) { 1858 1859 1814 $tb_url = trim($tb_url); 1815 trackback($tb_url, stripslashes($post_title), $excerpt, $post_id); 1860 1816 } 1861 1817 } 1862 1818 } 1863 1819 1864 1820 // … … 1866 1822 // 1867 1823 1868 1824 /** 1869 * get_all_page_ids() - Get a list of page IDs1825 * Get a list of page IDs. 1870 1826 * 1871 * {@internal Missing Long Description}} 1872 * 1873 * @package WordPress 1874 * @subpackage Post 1875 * @since 2.0 1827 * @since 2.0.0 1876 1828 * @uses $wpdb 1877 1829 * 1878 * @return array {@internal Missing Description}}1830 * @return array List of page IDs. 1879 1831 */ 1880 1832 function get_all_page_ids() { 1881 1833 global $wpdb; … … 1889 1841 } 1890 1842 1891 1843 /** 1892 * get_page() - Retrieves page data given a page ID or page object1844 * Retrieves page data given a page ID or page object. 1893 1845 * 1894 * {@internal Missing Long Description}}1895 *1896 * @package WordPress1897 * @subpackage Post1898 1846 * @since 1.5.1 1899 1847 * 1900 * @param mixed &$page page object or page ID1901 * @param string $output what to output1848 * @param mixed $page Page object or page ID. Passed by reference. 1849 * @param string $output What to output. OBJECT, ARRAY_A, or ARRAY_N. 1902 1850 * @param string $filter How the return value should be filtered. 1903 * @return mixed {@internal Missing Description}}1851 * @return mixed Page data. 1904 1852 */ 1905 1853 function &get_page(&$page, $output = OBJECT, $filter = 'raw') { 1906 1854 if ( empty($page) ) { … … 1916 1864 } 1917 1865 1918 1866 /** 1919 * get_page_by_path() - Retrieves a page given its path1867 * Retrieves a page given its path. 1920 1868 * 1921 * {@internal Missing Long Description}} 1922 * 1923 * @package WordPress 1924 * @subpackage Post 1925 * @since 2.1 1869 * @since 2.1.0 1926 1870 * @uses $wpdb 1927 1871 * 1928 * @param string $page_path page path1929 * @param string $output output type1930 * @return mixed {@internal Missing Description}}1872 * @param string $page_path Page path 1873 * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. 1874 * @return mixed Null when complete. 1931 1875 */ 1932 1876 function get_page_by_path($page_path, $output = OBJECT) { 1933 1877 global $wpdb; … … 1944 1888 $pages = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_name = %s AND (post_type = 'page' OR post_type = 'attachment')", $leaf_path )); 1945 1889 1946 1890 if ( empty($pages) ) 1947 return NULL;1891 return null; 1948 1892 1949 1893 foreach ($pages as $page) { 1950 1894 $path = '/' . $leaf_path; … … 1958 1902 return get_page($page->ID, $output); 1959 1903 } 1960 1904 1961 return NULL;1905 return null; 1962 1906 } 1963 1907 1964 1908 /** 1965 * get_page_by_title() - Retrieve a page given its title1909 * Retrieve a page given its title. 1966 1910 * 1967 * {@internal Missing Long Description}} 1968 * 1969 * @package WordPress 1970 * @subpackage Post 1971 * @since 2.1 1911 * @since 2.1.0 1972 1912 * @uses $wpdb 1973 1913 * 1974 * @param string $page_title page title1975 * @param string $output output type1976 * @return mixed {@internal Missing Description}}1914 * @param string $page_title Page title 1915 * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. 1916 * @return mixed 1977 1917 */ 1978 1918 function get_page_by_title($page_title, $output = OBJECT) { 1979 1919 global $wpdb; … … 1981 1921 if ( $page ) 1982 1922 return get_page($page, $output); 1983 1923 1984 return NULL;1924 return null; 1985 1925 } 1986 1926 1987 1927 /** 1988 * get_page_children() - Retrieve child pages1928 * Retrieve child pages from list of pages matching page ID. 1989 1929 * 1990 * {@internal Missing Long Description}} 1930 * Matches against the pages parameter against the page ID. Also matches all 1931 * children for the same to retrieve all children of a page. Does not make any 1932 * SQL queries to get the children. 1991 1933 * 1992 * @package WordPress1993 * @subpackage Post1994 1934 * @since 1.5.1 1995 1935 * 1996 * @param int $page_id page ID1997 * @param array $pages list of pages1998 * @return array {@internal Missing Description}}1936 * @param int $page_id Page ID. 1937 * @param array $pages List of pages' objects. 1938 * @return array 1999 1939 */ 2000 1940 function &get_page_children($page_id, $pages) { 2001 1941 $page_list = array(); … … 2010 1950 } 2011 1951 2012 1952 /** 2013 * get_page_hierarchy() - {@internal Missing Short Description}}1953 * Order the pages with children under parents in a flat list. 2014 1954 * 2015 * Fetches the pages returned as a FLAT list, but arranged in order of their hierarchy,2016 * i.e., child parents immediately follow their parents.1955 * Fetches the pages returned as a FLAT list, but arranged in order of their 1956 * hierarchy, i.e., child parents immediately follow their parents. 2017 1957 * 2018 * @package WordPress 2019 * @subpackage Post 2020 * @since 2.0 1958 * @since 2.0.0 2021 1959 * 2022 * @param array $posts posts array2023 * @param int $parent parent page ID2024 * @return array {@internal Missing Description}}1960 * @param array $posts Posts array. 1961 * @param int $parent Parent page ID. 1962 * @return array 2025 1963 */ 2026 1964 function get_page_hierarchy($posts, $parent = 0) { 2027 1965 $result = array ( ); … … 2036 1974 } 2037 1975 2038 1976 /** 2039 * get_page_uri() - Builds a page URI1977 * Builds URI for a page. 2040 1978 * 2041 * {@internal Missing Long Description}}1979 * Sub pages will be in the "directory" under the parent page post name. 2042 1980 * 2043 * @package WordPress 2044 * @subpackage Post 2045 * @since 1.5 1981 * @since 1.5.0 2046 1982 * 2047 * @param int $page_id page ID2048 * @return string {@internal Missing Description}}1983 * @param int $page_id Page ID. 1984 * @return string Page URI. 2049 1985 */ 2050 1986 function get_page_uri($page_id) { 2051 1987 $page = get_page($page_id); … … 2064 2000 } 2065 2001 2066 2002 /** 2067 * get_pages() - Retrieve a list of pages2003 * Retrieve a list of pages. 2068 2004 * 2069 * {@internal Missing Long Description}} 2005 * The defaults that can be overridden are the following: 'child_of', 2006 * 'sort_order', 'sort_column', 'post_title', 'hierarchical', 'exclude', 2007 * 'include', 'meta_key', 'meta_value', and 'authors'. 2070 2008 * 2071 * @package WordPress 2072 * @subpackage Post 2073 * @since 1.5 2009 * @since 1.5.0 2074 2010 * @uses $wpdb 2075 2011 * 2076 * @param mixed $args Optional. Array or string of options 2012 * @param mixed $args Optional. Array or string of options that overrides defaults. 2077 2013 * @return array List of pages matching defaults or $args 2078 2014 */ 2079 2015 function &get_pages($args = '') { … … 2161 2097 if ( ! empty( $meta_key ) || ! empty( $meta_value ) ) { 2162 2098 $join = " LEFT JOIN $wpdb->postmeta ON ( $wpdb->posts.ID = $wpdb->postmeta.post_id )"; 2163 2099 2164 // meta_key and met _value might be slashed2100 // meta_key and meta_value might be slashed 2165 2101 $meta_key = stripslashes($meta_key); 2166 2102 $meta_value = stripslashes($meta_value); 2167 2103 if ( ! empty( $meta_key ) ) … … 2198 2134 // 2199 2135 2200 2136 /** 2201 * is_local_attachment() -Check if the attachment URI is local one and is really an attachment.2137 * Check if the attachment URI is local one and is really an attachment. 2202 2138 * 2203 * {@internal Missing Long Description}}2139 * @since 2.0.0 2204 2140 * 2205 * @package WordPress2206 * @subpackage Post2207 * @since 2.02208 *2209 2141 * @param string $url URL to check 2210 * @return bool {@internal Missing Description}}2142 * @return bool True on success, false on failure. 2211 2143 */ 2212 2144 function is_local_attachment($url) { 2213 2145 if (strpos($url, get_bloginfo('url')) === false) … … 2223 2155 } 2224 2156 2225 2157 /** 2226 * wp_insert_attachment() - Insert an attachment2158 * Insert an attachment. 2227 2159 * 2228 * {@internal Missing Long Description}} 2160 * If you set the 'ID' in the $object parameter, it will mean that you are 2161 * updating and attempt to update the attachment. You can also set the 2162 * attachment name or title by setting the key 'post_name' or 'post_title'. 2229 2163 * 2230 * @package WordPress 2231 * @subpackage Post 2232 * @since 2.0 2164 * You can set the dates for the attachment manually by setting the 'post_date' 2165 * and 'post_date_gmt' keys' values. 2233 2166 * 2167 * By default, the comments will use the default settings for whether the 2168 * comments are allowed. You can close them manually or keep them open by 2169 * setting the value for the 'comment_status' key. 2170 * 2171 * The $object parameter can have the following: 2172 * 'post_status' - Default is 'draft'. Can not be override, set the same as 2173 * parent post. 2174 * 'post_type' - Default is 'post', will be set to attachment. Can not 2175 * override. 2176 * 'post_author' - Default is current user ID. The ID of the user, who added 2177 * the attachment. 2178 * 'ping_status' - Default is the value in default ping status option. 2179 * Whether the attachment can accept pings. 2180 * 'post_parent' - Default is 0. Can use $parent parameter or set this for 2181 * the post it belongs to, if any. 2182 * 'menu_order' - Default is 0. The order it is displayed. 2183 * 'to_ping' - Whether to ping. 2184 * 'pinged' - Default is empty string. 2185 * 'post_password' - Default is empty string. The password to access the 2186 * attachment. 2187 * 'guid' - Global Unique ID for referencing the attachment. 2188 * 'post_content_filtered' - Attachment post content filtered. 2189 * 'post_excerpt' - Attachment excerpt. 2190 * 2191 * @since 2.0.0 2234 2192 * @uses $wpdb 2235 2193 * @uses $user_ID 2236 2194 * 2237 * @param object $object attachment object2238 * @param string $file filename2239 * @param int $post_parent parent post ID2240 * @return int {@internal Missing Description}}2195 * @param string|array $object Arguments to override defaults. 2196 * @param string $file Optional filename. 2197 * @param int $post_parent Parent post ID. 2198 * @return int Attachment ID. 2241 2199 */ 2242 2200 function wp_insert_attachment($object, $file = false, $parent = 0) { 2243 2201 global $wpdb, $user_ID; … … 2300 2258 $post_date_gmt = current_time('mysql', 1); 2301 2259 2302 2260 if ( empty($post_modified) ) 2303 2261 $post_modified = $post_date; 2304 2262 if ( empty($post_modified_gmt) ) 2305 2263 $post_modified_gmt = $post_date_gmt; 2306 2264 2307 2265 if ( empty($comment_status) ) { 2308 2266 if ( $update ) … … 2367 2325 } 2368 2326 2369 2327 /** 2370 * wp_delete_attachment() - Delete an attachment2328 * Delete an attachment. 2371 2329 * 2372 * {@internal Missing Long Description}} 2330 * Will remove the file also, when the attachment is removed. Removes all post 2331 * meta fields, taxonomy, comments, etc associated with the attachment (except 2332 * the main post). 2373 2333 * 2374 * @package WordPress 2375 * @subpackage Post 2376 * @since 2.0 2334 * @since 2.0.0 2377 2335 * @uses $wpdb 2336 * @uses do_action() Calls 'delete_attachment' hook on Attachment ID. 2378 2337 * 2379 * @param int $postid attachment Id2380 * @return mixed {@internal Missing Description}}2338 * @param int $postid Attachment ID. 2339 * @return mixed False on failure. Post data on success. 2381 2340 */ 2382 2341 function wp_delete_attachment($postid) { 2383 2342 global $wpdb; … … 2431 2390 } 2432 2391 2433 2392 /** 2434 * wp_get_attachment_metadata() - Retrieve metadata for an attachment2393 * Retrieve attachment meta field for attachment ID. 2435 2394 * 2436 * {@internal Missing Long Description}}2395 * @since 2.1.0 2437 2396 * 2438 * @package WordPress 2439 * @subpackage Post 2440 * @since 2.1 2441 * 2442 * @param int $post_id attachment ID 2443 * @param bool $unfiltered Optional, default is false. If true, filters are not run 2444 * @return array {@internal Missing Description}} 2397 * @param int $post_id Attachment ID 2398 * @param bool $unfiltered Optional, default is false. If true, filters are not run. 2399 * @return string|bool Attachment meta field. False on failure. 2445 2400 */ 2446 2401 function wp_get_attachment_metadata( $post_id, $unfiltered = false ) { 2447 2402 $post_id = (int) $post_id; … … 2455 2410 } 2456 2411 2457 2412 /** 2458 * wp_update_attachment_metadata() - Update metadata for an attachment2413 * Update metadata for an attachment. 2459 2414 * 2460 * {@internal Missing Long Description}}2415 * @since 2.1.0 2461 2416 * 2462 * @package WordPress 2463 * @subpackage Post 2464 * @since 2.1 2465 * 2466 * @param int $post_id attachment ID 2467 * @param array $data attachment data 2468 * @return int {@internal Missing Description}} 2417 * @param int $post_id Attachment ID. 2418 * @param array $data Attachment data. 2419 * @return int 2469 2420 */ 2470 2421 function wp_update_attachment_metadata( $post_id, $data ) { 2471 2422 $post_id = (int) $post_id; … … 2478 2429 } 2479 2430 2480 2431 /** 2481 * wp_get_attachment_url() - Retrieve the URL for an attachment2432 * Retrieve the URL for an attachment. 2482 2433 * 2483 * {@internal Missing Long Description}}2434 * @since 2.1.0 2484 2435 * 2485 * @package WordPress 2486 * @subpackage Post 2487 * @since 2.1 2488 * 2489 * @param int $post_id attachment ID 2490 * @return string {@internal Missing Description}} 2436 * @param int $post_id Attachment ID. 2437 * @return string 2491 2438 */ 2492 2439 function wp_get_attachment_url( $post_id = 0 ) { 2493 2440 $post_id = (int) $post_id; … … 2503 2450 } 2504 2451 2505 2452 /** 2506 * wp_get_attachment_thumb_file() - Retrieve thumbnail for an attachment2453 * Retrieve thumbnail for an attachment. 2507 2454 * 2508 * {@internal Missing Long Description}}2455 * @since 2.1.0 2509 2456 * 2510 * @package WordPress 2511 * @subpackage Post 2512 * @since 2.1 2513 * 2514 * @param int $post_id attachment ID 2515 * @return mixed {@internal Missing Description}} 2457 * @param int $post_id Attachment ID. 2458 * @return mixed False on failure. Thumbnail file path on success. 2516 2459 */ 2517 2460 function wp_get_attachment_thumb_file( $post_id = 0 ) { 2518 2461 $post_id = (int) $post_id; … … 2529 2472 } 2530 2473 2531 2474 /** 2532 * wp_get_attachment_thumb_url() - Retrieve URL for an attachment thumbnail2475 * Retrieve URL for an attachment thumbnail. 2533 2476 * 2534 * {@internal Missing Long Description}}2477 * @since 2.1.0 2535 2478 * 2536 * @package WordPress 2537 * @subpackage Post 2538 * @since 2.1 2539 * 2540 * @param int $post_id attachment ID 2541 * @return string {@internal Missing Description}} 2479 * @param int $post_id Attachment ID 2480 * @return string|bool False on failure. Thumbnail URL on success. 2542 2481 */ 2543 2482 function wp_get_attachment_thumb_url( $post_id = 0 ) { 2544 2483 $post_id = (int) $post_id; … … 2560 2499 } 2561 2500 2562 2501 /** 2563 * wp_attachment_is_image() - Check if the attachment is an image2502 * Check if the attachment is an image. 2564 2503 * 2565 * {@internal Missing Long Description}}2504 * @since 2.1.0 2566 2505 * 2567 * @package WordPress 2568 * @subpackage Post 2569 * @since 2.1 2570 * 2571 * @param int $post_id attachment ID 2572 * @return bool {@internal Missing Description}} 2506 * @param int $post_id Attachment ID 2507 * @return bool 2573 2508 */ 2574 2509 function wp_attachment_is_image( $post_id = 0 ) { 2575 2510 $post_id = (int) $post_id; … … 2589 2524 } 2590 2525 2591 2526 /** 2592 * wp_mime_type_icon() - Retrieve the icon for a MIME type2527 * Retrieve the icon for a MIME type. 2593 2528 * 2594 * {@internal Missing Long Description}}2529 * @since 2.1.0 2595 2530 * 2596 * @package WordPress2597 * @subpackage Post2598 * @since 2.12599 *2600 2531 * @param string $mime MIME type 2601 * @return string|bool {@internal Missing Description}}2532 * @return string|bool 2602 2533 */ 2603 2534 function wp_mime_type_icon( $mime = 0 ) { 2604 2535 if ( !is_numeric($mime) ) … … 2679 2610 } 2680 2611 2681 2612 /** 2682 * wp_check_for_changed_slugs() - {@internal Missing Short Description}}2613 * Checked for changed slugs for published posts and save old slug. 2683 2614 * 2684 * {@internal Missing Long Description}} 2615 * The function is used along with form POST data. It checks for the wp-old-slug 2616 * POST field. Will only be concerned with published posts and the slug actually 2617 * changing. 2685 2618 * 2686 * @package WordPress2687 * @subpackage Post2688 * @since 2.12619 * If the slug was changed and not already part of the old slugs then it will be 2620 * added to the post meta field ('_wp_old_slug') for storing old slugs for that 2621 * post. 2689 2622 * 2690 * @param int $post_id The Post ID 2623 * The most logically usage of this function is redirecting changed posts, so 2624 * that those that linked to an changed post will be redirected to the new post. 2625 * 2626 * @since 2.1.0 2627 * 2628 * @param int $post_id Post ID. 2691 2629 * @return int Same as $post_id 2692 2630 */ 2693 2631 function wp_check_for_changed_slugs($post_id) { … … 2718 2656 } 2719 2657 2720 2658 /** 2721 * get_private_posts_cap_sql() - {@internal Missing Short Description}}2659 * Retrieve the private post SQL based on capability. 2722 2660 * 2723 * This function provides a standardized way to appropriately select on 2724 * the post_status of posts/pages. The function will return a piece of 2725 * SQL code that can be added to a WHERE clause; this SQL is constructed 2726 * to allow all published posts, and all private posts to which the user 2727 * has access. 2661 * This function provides a standardized way to appropriately select on the 2662 * post_status of posts/pages. The function will return a piece of SQL code that 2663 * can be added to a WHERE clause; this SQL is constructed to allow all 2664 * published posts, and all private posts to which the user has access. 2728 2665 * 2729 * @package WordPress2730 * @subpackage Post2731 * @since 2.22666 * It also allows plugins that define their own post type to control the cap by 2667 * using the hook 'pub_priv_sql_capability'. The plugin is expected to return 2668 * the capability the user must have to read the private post type. 2732 2669 * 2670 * @since 2.2.0 2671 * 2733 2672 * @uses $user_ID 2734 * @uses apply_filters() Call 'pub_priv_sql_capability' filter for plugins with different post types 2673 * @uses apply_filters() Call 'pub_priv_sql_capability' filter for plugins with different post types. 2735 2674 * 2736 2675 * @param string $post_type currently only supports 'post' or 'page'. 2737 2676 * @return string SQL code that can be added to a where clause. … … 2773 2712 } 2774 2713 2775 2714 /** 2776 * get_lastpostdate() - {@internal Missing Short Description}}2715 * Retrieve the date the the last post was published. 2777 2716 * 2778 * {@internal Missing Long Description}} 2717 * The server timezone is the default and is the difference between GMT and 2718 * server time. The 'blog' value is the date when the last post was posted. The 2719 * 'gmt' is when the last post was posted in GMT formatted date. 2779 2720 * 2780 * @package WordPress2781 * @subpackage Post2782 2721 * @since 0.71 2783 2722 * 2784 2723 * @uses $wpdb … … 2814 2753 } 2815 2754 2816 2755 /** 2817 * get_lastpostmodified() - {@internal Missing Short Description}}2756 * Retrieve last post modified date depending on timezone. 2818 2757 * 2819 * {@internal Missing Long Description}} 2758 * The server timezone is the default and is the difference between GMT and 2759 * server time. The 'blog' value is just when the last post was modified. The 2760 * 'gmt' is when the last post was modified in GMT time. 2820 2761 * 2821 * @package WordPress 2822 * @subpackage Post 2823 * @since 1.2 2824 * 2762 * @since 1.2.0 2825 2763 * @uses $wpdb 2826 2764 * @uses $blog_id 2827 2765 * @uses apply_filters() Calls 'get_lastpostmodified' filter 2828 2766 * 2829 2767 * @global mixed $cache_lastpostmodified Stores the date the last post was modified 2830 * @global mixed $pagenow The current page being viewed2831 2768 * 2832 2769 * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. 2833 2770 * @return string The date the post was last modified. … … 2859 2796 } 2860 2797 2861 2798 /** 2862 * update_post_cache() - Updates posts in cache2799 * Updates posts in cache. 2863 2800 * 2864 * @usedby update_page_cache() update_page_cache() aliased by this function.2801 * @usedby update_page_cache() Aliased by this function. 2865 2802 * 2866 2803 * @package WordPress 2867 2804 * @subpackage Cache … … 2878 2815 } 2879 2816 2880 2817 /** 2881 * clean_post_cache() - Will clean the post in the cache2818 * Will clean the post in the cache. 2882 2819 * 2883 * Cleaning means delete from the cache of the post. Will call to clean 2884 * the termobject cache associated with the post ID.2820 * Cleaning means delete from the cache of the post. Will call to clean the term 2821 * object cache associated with the post ID. 2885 2822 * 2886 2823 * @package WordPress 2887 2824 * @subpackage Cache 2888 * @since 2.0 2825 * @since 2.0.0 2889 2826 * 2890 2827 * @uses do_action() Will call the 'clean_post_cache' hook action. 2891 2828 * … … 2911 2848 } 2912 2849 2913 2850 /** 2914 * update_page_cache() - Alias of update_post_cache()2851 * Alias of update_post_cache(). 2915 2852 * 2916 2853 * @see update_post_cache() Posts and pages are the same, alias is intentional 2917 2854 * … … 2926 2863 } 2927 2864 2928 2865 /** 2929 * clean_page_cache() - Will clean the page in the cache2866 * Will clean the page in the cache. 2930 2867 * 2931 * Clean (read: delete) page from cache that matches $id. Will also clean 2932 * cacheassociated with 'all_page_ids' and 'get_pages'.2868 * Clean (read: delete) page from cache that matches $id. Will also clean cache 2869 * associated with 'all_page_ids' and 'get_pages'. 2933 2870 * 2934 2871 * @package WordPress 2935 2872 * @subpackage Cache 2936 * @since 2.0 2873 * @since 2.0.0 2937 2874 * 2938 2875 * @uses do_action() Will call the 'clean_page_cache' hook action. 2939 2876 * … … 2949 2886 } 2950 2887 2951 2888 /** 2952 * update_post_caches() -Call major cache updating functions for list of Post objects.2889 * Call major cache updating functions for list of Post objects. 2953 2890 * 2954 2891 * @package WordPress 2955 2892 * @subpackage Cache 2956 * @since 1.5 2893 * @since 1.5.0 2957 2894 * 2958 2895 * @uses $wpdb 2959 2896 * @uses update_post_cache() … … 2980 2917 } 2981 2918 2982 2919 /** 2983 * update_postmeta_cache() - {@internal Missing Short Description}}2920 * Updates metadata cache for list of post IDs. 2984 2921 * 2985 * {@internal Missing Long Description}} 2922 * Performs SQL query to retrieve the metadata for the post IDs and updates the 2923 * metadata cache for the posts. Therefore, the functions, which call this 2924 * function, do not need to perform SQL queries on their own. 2986 2925 * 2987 2926 * @package WordPress 2988 2927 * @subpackage Cache 2989 * @since 2.1 2928 * @since 2.1.0 2990 2929 * 2991 2930 * @uses $wpdb 2992 2931 * 2993 * @param array $post_ids {@internal Missing Description}}2994 * @return bool|array Returns false if there is nothing to update or an array of metadata 2932 * @param array $post_ids List of post IDs. 2933 * @return bool|array Returns false if there is nothing to update or an array of metadata. 2995 2934 */ 2996 2935 function update_postmeta_cache($post_ids) { 2997 2936 global $wpdb; … … 3051 2990 // 3052 2991 3053 2992 /** 3054 * _transition_post_status() - Hook {@internal Missing Short Description}}2993 * Hook for managing future post transitions to published. 3055 2994 * 3056 * {@internal Missing Long Description}} 3057 * 3058 * @package WordPress 3059 * @subpackage Post 3060 * @since 2.3 3061 * 2995 * @since 2.3.0 2996 * @access private 3062 2997 * @uses $wpdb 3063 2998 * 3064 * @param string $new_status {@internal Missing Description}}3065 * @param string $old_status {@internal Missing Description}}2999 * @param string $new_status New post status 3000 * @param string $old_status Previous post status 3066 3001 * @param object $post Object type containing the post information 3067 3002 */ 3068 3003 function _transition_post_status($new_status, $old_status, $post) { … … 3080 3015 } 3081 3016 3082 3017 /** 3083 * _future_post_hook() -Hook used to schedule publication for a post marked for the future.3018 * Hook used to schedule publication for a post marked for the future. 3084 3019 * 3085 3020 * The $post properties used and must exist are 'ID' and 'post_date_gmt'. 3086 3021 * 3087 * @package WordPress 3088 * @subpackage Post 3089 * @since 2.3 3022 * @since 2.3.0 3090 3023 * 3091 * @param int $ post_id Not Used. Can be set to null.3024 * @param int $deprecated Not Used. Can be set to null. 3092 3025 * @param object $post Object type containing the post information 3093 3026 */ 3094 3027 function _future_post_hook($deprecated = '', $post) { … … 3097 3030 } 3098 3031 3099 3032 /** 3100 * _publish_post_hook() - Hook {@internal Missing Short Description}}3033 * Hook to schedule pings and enclosures when a post is published. 3101 3034 * 3102 * {@internal Missing Long Description}} 3103 * 3104 * @package WordPress 3105 * @subpackage Post 3106 * @since 2.3 3107 * 3035 * @since 2.3.0 3108 3036 * @uses $wpdb 3109 3037 * @uses XMLRPC_REQUEST 3110 3038 * @uses APP_REQUEST … … 3132 3060 } 3133 3061 3134 3062 /** 3135 * _save_post_hook() - Hook used to prevent page/post cache and rewrite rules from staying dirty3063 * Hook used to prevent page/post cache and rewrite rules from staying dirty. 3136 3064 * 3137 * Does two things. If the post is a page and has a template then it will update/add that 3138 * template to the meta. For both pages and posts, it will clean the post cache to make sure 3139 * that the cache updates to the changes done recently. For pages, the rewrite rules of 3140 * WordPress are flushed to allow for any changes. 3065 * Does two things. If the post is a page and has a template then it will 3066 * update/add that template to the meta. For both pages and posts, it will clean 3067 * the post cache to make sure that the cache updates to the changes done 3068 * recently. For pages, the rewrite rules of WordPress are flushed to allow for 3069 * any changes. 3141 3070 * 3142 * The $post parameter, only uses 'post_type' property and 'page_template' property. 3071 * The $post parameter, only uses 'post_type' property and 'page_template' 3072 * property. 3143 3073 * 3144 * @package WordPress 3145 * @subpackage Post 3146 * @since 2.3 3147 * 3074 * @since 2.3.0 3148 3075 * @uses $wp_rewrite Flushes Rewrite Rules. 3149 3076 * 3150 3077 * @param int $post_id The ID in the database table for the $post … … 3160 3087 } 3161 3088 } 3162 3089 3163 // 3164 // Private 3165 // 3166 3090 /** 3091 * Retrieve post ancestors and append to post ancestors property. 3092 * 3093 * Will only retrieve ancestors once, if property is already set, then nothing 3094 * will be done. If there is not a parent post, or post ID and post parent ID 3095 * are the same then nothing will be done. 3096 * 3097 * The parameter is passed by reference, so nothing needs to be returned. The 3098 * property will be updated and can be referenced after the function is 3099 * complete. The post parent will be an ancestor and the parent of the post 3100 * parent will be an ancestor. There will only be two ancestors at the most. 3101 * 3102 * @access private 3103 * @since unknown 3104 * @uses $wpdb 3105 * 3106 * @param object $_post Post data. 3107 * @return null When nothing needs to be done. 3108 */ 3167 3109 function _get_post_ancestors(&$_post) { 3168 3110 global $wpdb; 3169 3111 … … 3183 3125 } 3184 3126 } 3185 3127 3186 /* Post Revisions */3187 3188 3128 /** 3189 * _wp_post_revision_fields() - determines which fields of posts are to be saved in revisions3129 * Determines which fields of posts are to be saved in revisions. 3190 3130 * 3191 * Does two things. If passed a post *array*, it will return a post array ready to be3192 * insterted into the posts table as a post revision.3193 * Otherwise, returnsan array whose keys are the post fields to be saved for post revisions.3131 * Does two things. If passed a post *array*, it will return a post array ready 3132 * to be insterted into the posts table as a post revision. Otherwise, returns 3133 * an array whose keys are the post fields to be saved for post revisions. 3194 3134 * 3195 3135 * @package WordPress 3196 * @subpackage Post Revisions 3197 * @since 2.6 3136 * @subpackage Post_Revisions 3137 * @since 2.6.0 3138 * @access private 3198 3139 * 3199 * @param array $post optional a post array to be processed for insertion as a post revision3140 * @param array $post Optional a post array to be processed for insertion as a post revision. 3200 3141 * @param bool $autosave optional Is the revision an autosave? 3201 * @return array post array ready to be inserted as a post revision or array of fields that can be versioned3142 * @return array Post array ready to be inserted as a post revision or array of fields that can be versioned. 3202 3143 */ 3203 3144 function _wp_post_revision_fields( $post = null, $autosave = false ) { 3204 3145 static $fields = false; … … 3237 3178 } 3238 3179 3239 3180 /** 3240 * wp_save_post_revision() - Saves an already existing post as a post revision. Typically used immediately prior to post updates.3181 * Saves an already existing post as a post revision. 3241 3182 * 3183 * Typically used immediately prior to post updates. 3184 * 3242 3185 * @package WordPress 3243 * @subpackage Post 3244 * @since 2.6 3186 * @subpackage Post_Revisions 3187 * @since 2.6.0 3245 3188 * 3246 3189 * @uses _wp_put_post_revision() 3247 3190 * 3248 * @param int $post_id The ID of the post to save as a revision 3249 * @return mixed null or 0 if error, new revision ID if success3191 * @param int $post_id The ID of the post to save as a revision. 3192 * @return mixed Null or 0 if error, new revision ID, if success. 3250 3193 */ 3251 3194 function wp_save_post_revision( $post_id ) { 3252 3195 // We do autosaves manually with wp_create_post_autosave() … … 3290 3233 } 3291 3234 3292 3235 /** 3293 * wp_get_post_autosave() - returnsthe autosaved data of the specified post.3236 * Retrieve the autosaved data of the specified post. 3294 3237 * 3295 * Returns a post object containing the information that was autosaved for the specified post. 3238 * Returns a post object containing the information that was autosaved for the 3239 * specified post. 3296 3240 * 3297 3241 * @package WordPress 3298 * @subpackage Post 3299 * @since 2.6 3242 * @subpackage Post_Revisions 3243 * @since 2.6.0 3300 3244 * 3301 * @param int $post_id The post ID 3302 * @return object|bool the autosaved data or false on failure or when no autosave exists3245 * @param int $post_id The post ID. 3246 * @return object|bool The autosaved data or false on failure or when no autosave exists. 3303 3247 */ 3304 3248 function wp_get_post_autosave( $post_id ) { 3305 3249 global $wpdb; … … 3326 3270 return false; 3327 3271 } 3328 3272 3329 // Internally used to hack WP_Query into submission 3273 /** 3274 * Internally used to hack WP_Query into submission. 3275 * 3276 * @package WordPress 3277 * @subpackage Post_Revisions 3278 * @since 2.6.0 3279 * 3280 * @param object $query WP_Query object 3281 */ 3330 3282 function _wp_get_post_autosave_hack( $query ) { 3331 3283 $query->is_single = false; 3332 3284 } 3333 3285 3334 3335 3286 /** 3336 * wp_is_post_revision() -Determines if the specified post is a revision.3287 * Determines if the specified post is a revision. 3337 3288 * 3338 3289 * @package WordPress 3339 * @subpackage Post 3340 * @since 2.6 3290 * @subpackage Post_Revisions 3291 * @since 2.6.0 3341 3292 * 3342 * @param int|object $post post ID or post object3343 * @return bool|int false if not a revision, ID of revision's parent otherwise3293 * @param int|object $post Post ID or post object. 3294 * @return bool|int False if not a revision, ID of revision's parent otherwise. 3344 3295 */ 3345 3296 function wp_is_post_revision( $post ) { 3346 3297 if ( !$post = wp_get_post_revision( $post ) ) … … 3349 3300 } 3350 3301 3351 3302 /** 3352 * wp_is_post_autosave() -Determines if the specified post is an autosave.3303 * Determines if the specified post is an autosave. 3353 3304 * 3354 3305 * @package WordPress 3355 * @subpackage Post 3356 * @since 2.6 3306 * @subpackage Post_Revisions 3307 * @since 2.6.0 3357 3308 * 3358 * @param int|object $post post ID or post object3359 * @return bool|int false if not a revision, ID of autosave's parent otherwise3309 * @param int|object $post Post ID or post object. 3310 * @return bool|int False if not a revision, ID of autosave's parent otherwise 3360 3311 */ 3361 3312 function wp_is_post_autosave( $post ) { 3362 3313 if ( !$post = wp_get_post_revision( $post ) ) … … 3367 3318 } 3368 3319 3369 3320 /** 3370 * _wp_put_post_revision() - Inserts post data into the posts table as a post revision3321 * Inserts post data into the posts table as a post revision. 3371 3322 * 3372 3323 * @package WordPress 3373 * @subpackage Post 3374 * @since 2.6 3324 * @subpackage Post_Revisions 3325 * @since 2.6.0 3375 3326 * 3376 3327 * @uses wp_insert_post() 3377 3328 * 3378 * @param int|object|array $post post ID, post object OR post array3379 * @param bool $autosave optionalIs the revision an autosave?3380 * @return mixed null or 0 if error, new revision ID if success3329 * @param int|object|array $post Post ID, post object OR post array. 3330 * @param bool $autosave Optional. Is the revision an autosave? 3331 * @return mixed Null or 0 if error, new revision ID if success. 3381 3332 */ 3382 3333 function _wp_put_post_revision( $post = null, $autosave = false ) { 3383 3334 if ( is_object($post) ) … … 3402 3353 } 3403 3354 3404 3355 /** 3405 * wp_get_post_revision() - Gets a post revision3356 * Gets a post revision. 3406 3357 * 3407 3358 * @package WordPress 3408 * @subpackage Post 3409 * @since 2.6 3359 * @subpackage Post_Revisions 3360 * @since 2.6.0 3410 3361 * 3411 3362 * @uses get_post() 3412 3363 * 3413 * @param int|object $post post ID or post object3414 * @param $output optional OBJECT, ARRAY_A, or ARRAY_N3415 * @param string $filter optional sanitation filter. @see sanitize_post()3416 * @return mixed null if error or post object if success3364 * @param int|object $post Post ID or post object 3365 * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. 3366 * @param string $filter Optional sanitation filter. @see sanitize_post() 3367 * @return mixed Null if error or post object if success 3417 3368 */ 3418 3369 function &wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') { 3419 3370 $null = null; … … 3436 3387 } 3437 3388 3438 3389 /** 3439 * wp_restore_post_revision() - Restores a post to the specified revision3390 * Restores a post to the specified revision. 3440 3391 * 3441 * Can restore a past using all fields of the post revision, or only selected fields. 3392 * Can restore a past using all fields of the post revision, or only selected 3393 * fields. 3442 3394 * 3443 3395 * @package WordPress 3444 * @subpackage Post 3445 * @since 2.6 3396 * @subpackage Post_Revisions 3397 * @since 2.6.0 3446 3398 * 3447 3399 * @uses wp_get_post_revision() 3448 3400 * @uses wp_update_post() 3449 3401 * 3450 * @param int|object $revision_id revision ID or revision object3451 * @param array $fields optionalWhat fields to restore from. Defaults to all.3452 * @return mixed null if error, false if no fields to restore, (int) post ID if success3402 * @param int|object $revision_id Revision ID or revision object. 3403 * @param array $fields Optional. What fields to restore from. Defaults to all. 3404 * @return mixed Null if error, false if no fields to restore, (int) post ID if success. 3453 3405 */ 3454 3406 function wp_restore_post_revision( $revision_id, $fields = null ) { 3455 3407 if ( !$revision = wp_get_post_revision( $revision_id, ARRAY_A ) ) … … 3478 3430 } 3479 3431 3480 3432 /** 3481 * wp_delete_post_revision() -Deletes a revision.3433 * Deletes a revision. 3482 3434 * 3483 * Deletes the row from the posts table corresponding to the specified revision 3435 * Deletes the row from the posts table corresponding to the specified revision. 3484 3436 * 3485 3437 * @package WordPress 3486 * @subpackage Post 3487 * @since 2.6 3438 * @subpackage Post_Revisions 3439 * @since 2.6.0 3488 3440 * 3489 3441 * @uses wp_get_post_revision() 3490 3442 * @uses wp_delete_post() 3491 3443 * 3492 * @param int|object $revision_id revision ID or revision object3493 * @param array $fields optionalWhat fields to restore from. Defaults to all.3494 * @return mixed null if error, false if no fields to restore, (int) post ID if success3444 * @param int|object $revision_id Revision ID or revision object. 3445 * @param array $fields Optional. What fields to restore from. Defaults to all. 3446 * @return mixed Null if error, false if no fields to restore, (int) post ID if success. 3495 3447 */ 3496 3448 function wp_delete_post_revision( $revision_id ) { 3497 3449 if ( !$revision = wp_get_post_revision( $revision_id ) ) … … 3508 3460 } 3509 3461 3510 3462 /** 3511 * wp_get_post_revisions() - Returns all revisions of specified post3463 * Returns all revisions of specified post. 3512 3464 * 3513 3465 * @package WordPress 3514 * @subpackage Post 3515 * @since 2.6 3466 * @subpackage Post_Revisions 3467 * @since 2.6.0 3516 3468 * 3517 3469 * @uses get_children() 3518 3470 * 3519 * @param int|object $post_id post ID or post object3471 * @param int|object $post_id Post ID or post object 3520 3472 * @return array empty if no revisions 3521 3473 */ 3522 3474 function wp_get_post_revisions( $post_id = 0, $args = null ) {
