Make WordPress Core

Ticket #30217: 30217.diff

File 30217.diff, 23.4 KB (added by DrewAPicture, 10 years ago)
  • src/wp-admin/export.php

     
    112112/**
    113113 * Create the date options fields for exporting a given post type.
    114114 *
    115  * @global wpdb      $wpdb      WordPress database object.
     115 * @global wpdb      $wpdb      WordPress database abstraction object.
    116116 * @global WP_Locale $wp_locale Date and Time Locale object.
    117117 *
    118118 * @since 3.1.0
  • src/wp-admin/includes/comment.php

     
    1010 * Determine if a comment exists based on author and date.
    1111 *
    1212 * @since 2.0.0
    13  * @uses $wpdb
    1413 *
     14 * @global wpdb $wpdb WordPress database abstraction object.
     15 *
    1516 * @param string $comment_author Author of the comment
    1617 * @param string $comment_date Date of the comment
    1718 * @return mixed Comment post ID on success.
     
    110111 * Get the number of pending comments on a post or posts
    111112 *
    112113 * @since 2.3.0
    113  * @uses $wpdb
    114114 *
     115 * @global wpdb $wpdb WordPress database abstraction object.
     116 *
    115117 * @param int|array $post_id Either a single Post ID or an array of Post IDs
    116118 * @return int|array Either a single Posts pending comments as an int or an array of ints keyed on the Post IDs
    117119 */
  • src/wp-admin/includes/schema.php

     
    324324 * Create WordPress options and set the default values.
    325325 *
    326326 * @since 1.5.0
    327  * @uses $wpdb
     327 *
     328 * @global wpdb $wpdb WordPress database abstraction object.
    328329 * @uses $wp_db_version
    329330 */
    330331function populate_options() {
  • src/wp-admin/install-helper.php

     
    4444 *
    4545 * @since 1.0.0
    4646 *
    47  * @uses $wpdb
     47 * @global wpdb $wpdb WordPress database abstraction object.
    4848 *
    4949 * @param string $table_name Database table name.
    5050 * @param string $create_ddl Create database table SQL.
     
    7676 *
    7777 * @since 1.0.0
    7878 *
    79  * @uses $wpdb
     79 * @global wpdb $wpdb WordPress database abstraction object.
    8080 *
    8181 * @param string $table_name Database table name
    8282 * @param string $column_name Table column name
     
    110110 *
    111111 * @since 1.0.0
    112112 *
    113  * @uses $wpdb
     113 * @global wpdb $wpdb WordPress database abstraction object.
    114114 *
    115115 * @param string $table_name Table name
    116116 * @param string $column_name Column name
  • src/wp-includes/bookmark.php

     
    1010 * Retrieve Bookmark data
    1111 *
    1212 * @since 2.1.0
    13  * @uses $wpdb Database Object
    1413 *
     14 * @global wpdb $wpdb WordPress database abstraction object.
     15 *
    1516 * @param mixed $bookmark
    1617 * @param string $output Optional. Either OBJECT, ARRAY_N, or ARRAY_A constant
    1718 * @param string $filter Optional, default is 'raw'.
     
    9192 *
    9293 * @since 2.1.0
    9394 *
    94  * @global wpdb $wpdb WordPress database access abstraction object.
     95 * @global wpdb $wpdb WordPress database abstraction object.
    9596 *
    9697 * @param string|array $args {
    9798 *     Optional. String or array of arguments to retrieve bookmarks.
  • src/wp-includes/canonical.php

     
    512512 * Attempts to guess the correct URL based on query vars
    513513 *
    514514 * @since 2.3.0
    515  * @uses $wpdb
    516515 *
     516 * @global wpdb $wpdb WordPress database abstraction object.
     517 *
    517518 * @return bool|string The correct URL if one is found. False on failure.
    518519 */
    519520function redirect_guess_404_permalink() {
  • src/wp-includes/capabilities.php

     
    104104         *
    105105         * @since 2.1.0
    106106         * @access protected
    107          * @uses $wpdb Used to get the database prefix.
     107         *
     108         * @global wpdb  $wpdb          WordPress database abstraction object.
    108109         * @global array $wp_user_roles Used to set the 'roles' property value.
    109110         */
    110111        protected function _init() {
  • src/wp-includes/comment.php

     
    2424 *
    2525 * @since 1.2.0
    2626 *
    27  * @global wpdb $wpdb WordPress database access abstraction object.
     27 * @global wpdb $wpdb WordPress database abstraction object.
    2828 *
    2929 * @param string $author       Comment author name.
    3030 * @param string $email        Comment author email.
     
    155155 * comment variable will be used, if it is set.
    156156 *
    157157 * @since 2.0.0
    158  * @uses $wpdb
    159158 *
     159 * @global wpdb $wpdb WordPress database abstraction object.
     160 *
    160161 * @param object|string|int $comment Comment to retrieve.
    161162 * @param string $output Optional. OBJECT or ARRAY_A or ARRAY_N constants.
    162163 * @return object|array|null Depends on $output value.
     
    214215 * 'order', 'number', 'offset', and 'post_id'.
    215216 *
    216217 * @since 2.7.0
    217  * @uses $wpdb
    218218 *
     219 * @global wpdb $wpdb WordPress database abstraction object.
     220 *
    219221 * @param mixed $args Optional. Array or string of options to override defaults.
    220222 * @return array List of comments.
    221223 */
     
    757759 * The date the last comment was modified.
    758760 *
    759761 * @since 1.5.0
    760  * @uses $wpdb
    761762 *
     763 * @global wpdb $wpdb WordPress database abstraction object.
     764 *
    762765 * @param string $timezone Which timezone to use in reference to 'gmt', 'blog',
    763766 *              or 'server' locations.
    764767 * @return string Last comment modified date.
     
    797800 * caches, but this function does not.
    798801 *
    799802 * @since 2.0.0
    800  * @uses $wpdb
    801803 *
     804 * @global wpdb $wpdb WordPress database abstraction object.
     805 *
    802806 * @param int $post_id Optional. Comment amount in post if > 0, else total comments blog wide.
    803807 * @return array The amount of spam, approved, awaiting moderation, and total comments.
    804808 */
     
    10151019 * Validates whether this comment is allowed to be made.
    10161020 *
    10171021 * @since 2.0.0
    1018  * @uses $wpdb
    10191022 *
     1023 * @global wpdb $wpdb WordPress database abstraction object.
     1024 *
    10201025 * @param array $commentdata Contains information on the comment
    10211026 * @return mixed Signifies the approval status (0|1|'spam')
    10221027 */
     
    11321137 * administrators.
    11331138 *
    11341139 * @since 2.3.0
    1135  * @uses $wpdb
    11361140 *
     1141 * @global wpdb $wpdb WordPress database abstraction object.
     1142 *
    11371143 * @param string $ip Comment IP.
    11381144 * @param string $email Comment author email address.
    11391145 * @param string $date MySQL time string.
     
    14351441 * post ID available.
    14361442 *
    14371443 * @since 2.0.0
    1438  * @uses $wpdb
    14391444 *
     1445 * @global wpdb $wpdb WordPress database abstraction object.
     1446 *
    14401447 * @param int $comment_id Comment ID
    14411448 * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
    14421449 * @return bool True on success, false on failure.
     
    18101817 * 'comment_date_gmt', 'comment_parent', 'comment_approved', and 'user_id'.
    18111818 *
    18121819 * @since 2.0.0
    1813  * @uses $wpdb
    18141820 *
     1821 * @global wpdb $wpdb WordPress database abstraction object.
     1822 *
    18151823 * @param array $commentdata Contains information on the comment.
    18161824 * @return int|bool The new comment's ID on success, false on failure.
    18171825 */
     
    21052113 * Filters the comment and makes sure certain fields are valid before updating.
    21062114 *
    21072115 * @since 2.0.0
    2108  * @uses $wpdb
    21092116 *
     2117 * @global wpdb $wpdb WordPress database abstraction object.
     2118 *
    21102119 * @param array $commentarr Contains information on the comment.
    21112120 * @return int Comment was updated if value is 1, or was not updated if value is 0.
    21122121 */
     
    22432252 * Updates the comment count for the post.
    22442253 *
    22452254 * @since 2.5.0
    2246  * @uses $wpdb
    22472255 *
     2256 * @global wpdb $wpdb WordPress database abstraction object.
     2257 *
    22482258 * @param int $post_id Post ID
    22492259 * @return bool True on success, false on '0' $post_id or if post with ID does not exist.
    22502260 */
     
    23572367 * Perform all pingbacks, enclosures, trackbacks, and send to pingback services.
    23582368 *
    23592369 * @since 2.1.0
    2360  * @uses $wpdb
     2370 *
     2371 * @global wpdb $wpdb WordPress database abstraction object.
    23612372 */
    23622373function do_all_pings() {
    23632374        global $wpdb;
     
    23882399 * Perform trackbacks.
    23892400 *
    23902401 * @since 1.5.0
    2391  * @uses $wpdb
    23922402 *
     2403 * @global wpdb $wpdb WordPress database abstraction object.
     2404 *
    23932405 * @param int $post_id Post ID to do trackbacks on.
    23942406 */
    23952407function do_trackbacks($post_id) {
     
    25622574 * Updates database when sending trackback to prevent duplicates.
    25632575 *
    25642576 * @since 0.71
    2565  * @uses $wpdb
    25662577 *
     2578 * @global wpdb $wpdb WordPress database abstraction object.
     2579 *
    25672580 * @param string $trackback_url URL to send trackbacks.
    25682581 * @param string $title Title of post.
    25692582 * @param string $excerpt Excerpt of post.
  • src/wp-includes/deprecated.php

     
    24242424 *
    24252425 * @since 2.2.0
    24262426 * @deprecated 3.1.0
    2427  * @uses $wpdb WordPress database object for queries
     2427 *
     2428 * @global wpdb $wpdb WordPress database abstraction object.
    24282429 * @uses $blog_id The Blog id of the blog for those that use more than one blog
    24292430 *
    24302431 * @param int $id Blog ID.
  • src/wp-includes/functions.php

     
    10871087 *
    10881088 * @since 2.0.0
    10891089 *
    1090  * @global wpdb $wpdb WordPress database access abstraction object.
     1090 * @global wpdb $wpdb WordPress database abstraction object.
    10911091 *
    10921092 * @return int Number of database queries.
    10931093 */
     
    12531253 *
    12541254 * @since 2.1.0
    12551255 *
    1256  * @global wpdb $wpdb WordPress database access abstraction object.
     1256 * @global wpdb $wpdb WordPress database abstraction object.
    12571257 *
    12581258 * @return bool Whether the blog is already installed.
    12591259 */
     
    32383238 *
    32393239 * @since 2.3.2
    32403240 *
    3241  * @global wpdb $wpdb WordPress database access abstraction object.
     3241 * @global wpdb $wpdb WordPress database abstraction object.
    32423242 */
    32433243function dead_db() {
    32443244        global $wpdb;
  • src/wp-includes/media.php

     
    32603260 *
    32613261 * @since 4.0.0
    32623262 *
    3263  * @global wpdb $wpdb WordPress database access abstraction object.
     3263 * @global wpdb $wpdb WordPress database abstraction object.
    32643264 *
    32653265 * @param string $url The URL to resolve.
    32663266 * @return int The found post ID.
  • src/wp-includes/meta.php

     
    1515 * Add metadata for the specified object.
    1616 *
    1717 * @since 2.9.0
    18  * @uses $wpdb WordPress database object for queries.
    1918 *
     19 * @global wpdb $wpdb WordPress database abstraction object.
     20 *
    2021 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
    2122 * @param int $object_id ID of the object metadata is for
    2223 * @param string $meta_key Metadata key
     
    128129 * ID and metadata key, the metadata will be added.
    129130 *
    130131 * @since 2.9.0
    131  * @uses $wpdb WordPress database object for queries.
    132132 *
     133 * @global wpdb $wpdb WordPress database abstraction object.
     134 *
    133135 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
    134136 * @param int $object_id ID of the object metadata is for
    135137 * @param string $meta_key Metadata key
     
    278280 * Delete metadata for the specified object.
    279281 *
    280282 * @since 2.9.0
    281  * @uses $wpdb WordPress database object for queries.
    282283 *
     284 * @global wpdb $wpdb WordPress database abstraction object.
     285 *
    283286 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
    284287 * @param int $object_id ID of the object metadata is for
    285288 * @param string $meta_key Metadata key
     
    756759 * Update the metadata cache for the specified objects.
    757760 *
    758761 * @since 2.9.0
    759  * @uses $wpdb WordPress database object for queries.
    760762 *
     763 * @global wpdb $wpdb WordPress database abstraction object.
     764 *
    761765 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
    762766 * @param int|array $object_ids array or comma delimited list of object IDs to update cache for
    763767 * @return mixed Metadata cache for the specified objects, or false on failure.
     
    15001504 * Retrieve the name of the metadata table for the specified object type.
    15011505 *
    15021506 * @since 2.9.0
    1503  * @uses $wpdb WordPress database object for queries.
    15041507 *
     1508 * @global wpdb $wpdb WordPress database abstraction object.
     1509 *
    15051510 * @param string $type Type of object to get metadata table for (e.g., comment, post, or user)
    15061511 * @return mixed Metadata table name, or false if no metadata table exists
    15071512 */
  • src/wp-includes/pluggable.php

     
    14841484 *
    14851485 * @since 1.0.0
    14861486 *
    1487  * @uses $wpdb
     1487 * @global wpdb $wpdb WordPress database abstraction object.
    14881488 *
    14891489 * @param int $comment_id Comment ID
    14901490 * @return bool Always returns true
     
    20642064 *
    20652065 * @since 2.5.0
    20662066 *
    2067  * @uses $wpdb WordPress database object for queries
     2067 * @global wpdb $wpdb WordPress database abstraction object.
    20682068 *
    20692069 * @param string $password The plaintext new user password
    20702070 * @param int $user_id User ID
  • src/wp-includes/post.php

     
    17891789 *
    17901790 * @since 2.5.0
    17911791 *
    1792  * @global wpdb $wpdb WordPress database access abstraction object.
     1792 * @global wpdb $wpdb WordPress database abstraction object.
    17931793 *
    17941794 * @param int    $post_id   Optional. Post ID to change post type. Default 0.
    17951795 * @param string $post_type Optional. Post type. Accepts 'post' or 'page' to
     
    25542554 *
    25552555 * @since 1.0.0
    25562556 *
    2557  * @global wpdb $wpdb WordPress database access abstraction object.
     2557 * @global wpdb $wpdb WordPress database abstraction object.
    25582558 * @see wp_delete_attachment()
    25592559 * @see wp_trash_post()
    25602560 *
     
    27992799 *
    28002800 * @since 2.9.0
    28012801 *
    2802  * @global wpdb $wpdb WordPress database access abstraction object.
     2802 * @global wpdb $wpdb WordPress database abstraction object.
    28032803 *
    28042804 * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.
    28052805 * @return mixed False on failure.
     
    47414741 *
    47424742 * @since 2.0.0
    47434743 *
    4744  * @global wpdb $wpdb WordPress database access abstraction object.
     4744 * @global wpdb $wpdb WordPress database abstraction object.
    47454745 *
    47464746 * @param int  $post_id      Attachment ID.
    47474747 * @param bool $force_delete Optional. Whether to bypass trash and force deletion.
     
    54305430 *
    54315431 * @since 2.0.0
    54325432 *
    5433  * @global wpdb $wpdb WordPress database access abstraction object.
     5433 * @global wpdb $wpdb WordPress database abstraction object.
    54345434 *
    54355435 * @param int|WP_Post $post Post ID or post object to remove from the cache.
    54365436 */
     
    55885588 * @access private
    55895589 *
    55905590 * @see wp_clear_scheduled_hook()
    5591  * @global wpdb $wpdb WordPress database access abstraction object.
     5591 * @global wpdb $wpdb WordPress database abstraction object.
    55925592 *
    55935593 * @param string  $new_status New post status.
    55945594 * @param string  $old_status Previous post status.
     
    57805780 *
    57815781 * @since 3.4.0
    57825782 *
    5783  * @global wpdb $wpdb WordPress database access abstraction object.
     5783 * @global wpdb $wpdb WordPress database abstraction object.
    57845784 */
    57855785function wp_delete_auto_drafts() {
    57865786        global $wpdb;
  • src/wp-includes/query.php

     
    22112211         * @since 4.0.0
    22122212         * @access protected
    22132213         *
    2214          * @global wpdb $wpdb WordPress database access abstraction object.
     2214         * @global wpdb $wpdb WordPress database abstraction object.
    22152215         *
    22162216         * @param string $orderby Alias for the field to order by.
    22172217         * @return string|bool Table-prefixed value to used in the ORDER clause. False otherwise.
     
    46194619 * Attempts to find the current slug from the past slugs.
    46204620 *
    46214621 * @since 2.1.0
     4622 *
    46224623 * @uses $wp_query
    4623  * @uses $wpdb
     4624 * @global wpdb $wpdb WordPress database abstraction object.
    46244625 *
    46254626 * @return null If no link is found, null is returned.
    46264627 */
  • src/wp-includes/taxonomy.php

     
    562562 *
    563563 * @since 2.3.0
    564564 *
    565  * @uses $wpdb
     565 * @global wpdb $wpdb WordPress database abstraction object.
    566566 *
    567567 * @param int|array $term_ids Term id or array of term ids of terms that will be used
    568568 * @param string|array $taxonomies String of taxonomy name or Array of string values of taxonomy names
     
    12611261 *
    12621262 * @since 2.3.0
    12631263 *
    1264  * @uses $wpdb
     1264 * @global wpdb $wpdb WordPress database abstraction object.
    12651265 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
    12661266 *
    12671267 * @param int|object $term If integer, will get from database. If object will apply filters and return $term.
     
    13561356 *
    13571357 * @since 2.3.0
    13581358 *
    1359  * @uses $wpdb
     1359 * @global wpdb $wpdb WordPress database abstraction object.
    13601360 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
    13611361 *
    13621362 * @param string $field Either 'slug', 'name', 'id' (term_id), or 'term_taxonomy_id'
     
    14461446 *
    14471447 * @since 2.3.0
    14481448 *
    1449  * @uses $wpdb
     1449 * @global wpdb $wpdb WordPress database abstraction object.
    14501450 *
    14511451 * @param string $term_id ID of Term to get children
    14521452 * @param string $taxonomy Taxonomy Name
     
    15531553 *
    15541554 * @since 2.3.0
    15551555 *
    1556  * @global wpdb $wpdb WordPress database access abstraction object.
     1556 * @global wpdb $wpdb WordPress database abstraction object.
    15571557 *
    15581558 * @param string|array $taxonomies Taxonomy name or list of Taxonomy names.
    15591559 * @param array|string $args {
     
    20032003 *
    20042004 * @since 3.0.0
    20052005 *
    2006  * @uses $wpdb
     2006 * @global wpdb $wpdb WordPress database abstraction object.
    20072007 *
    20082008 * @param int|string $term The term to check
    20092009 * @param string $taxonomy The taxonomy name to use
     
    21432143 *
    21442144 * @since 2.3.0
    21452145 *
    2146  * @uses $wpdb
     2146 * @global wpdb $wpdb WordPress database abstraction object.
    21472147 *
    21482148 * @param string $field Term field to sanitize
    21492149 * @param string $value Search for this term value
     
    23632363 *
    23642364 * @since 2.3.0
    23652365 *
    2366  * @uses $wpdb
     2366 * @global wpdb $wpdb WordPress database abstraction object.
    23672367 *
    23682368 * @param int $term Term ID
    23692369 * @param string $taxonomy Taxonomy Name
     
    25622562 * array of all matching term ids or term names will be returned respectively.
    25632563 *
    25642564 * @since 2.3.0
    2565  * @uses $wpdb
    25662565 *
     2566 * @global wpdb $wpdb WordPress database abstraction object.
     2567 *
    25672568 * @param int|array $object_ids The ID(s) of the object(s) to retrieve.
    25682569 * @param string|array $taxonomies The taxonomies to retrieve terms from.
    25692570 * @param array|string $args Change what is returned
     
    27332734 * If the term already exists on the same hierarchical level,
    27342735 * or the term slug and name are not unique, a WP_Error object will be returned.
    27352736 *
    2736  * @global wpdb $wpdb The WordPress database object.
     2737 * @global wpdb $wpdb WordPress database abstraction object.
    27372738
    27382739 * @since 2.3.0
    27392740 *
     
    30893090 * Remove term(s) associated with a given object.
    30903091 *
    30913092 * @since 3.6.0
    3092  * @uses $wpdb
    30933093 *
     3094 * @global wpdb $wpdb WordPress database abstraction object.
     3095 *
    30943096 * @param int $object_id The ID of the object from which the terms will be removed.
    30953097 * @param array|int|string $terms The slug(s) or ID(s) of the term(s) to remove.
    30963098 * @param array|string $taxonomy Taxonomy name.
     
    31773179 * The only purpose for $term is for appending a parent, if one exists.
    31783180 *
    31793181 * @since 2.3.0
    3180  * @uses $wpdb
    31813182 *
     3183 * @global wpdb $wpdb WordPress database abstraction object.
     3184 *
    31823185 * @param string $slug The string that will be tried for a unique slug
    31833186 * @param object $term The term object that the $slug will belong too
    31843187 * @return string Will return a true unique slug.
     
    32493252 *
    32503253 * @since 2.3.0
    32513254 *
    3252  * @uses $wpdb
     3255 * @global wpdb $wpdb WordPress database abstraction object.
    32533256 *
    32543257 * @param int $term_id The ID of the term
    32553258 * @param string $taxonomy The context in which to relate the term to the object.
     
    34943497 * of term ID. Once that is done, then update the database.
    34953498 *
    34963499 * @since 2.3.0
    3497  * @uses $wpdb
    34983500 *
     3501 * @global wpdb $wpdb WordPress database abstraction object.
     3502 *
    34993503 * @param int|array $terms The term_taxonomy_id of the terms
    35003504 * @param string $taxonomy The context of the term.
    35013505 * @return bool If no terms will return false, and if successful will return true.
     
    36073611 * Will remove all of the term ids from the cache.
    36083612 *
    36093613 * @since 2.3.0
    3610  * @uses $wpdb
    36113614 *
     3615 * @global wpdb $wpdb WordPress database abstraction object.
     3616 *
    36123617 * @param int|array $ids Single or list of Term IDs
    36133618 * @param string $taxonomy Can be empty and will assume tt_ids, else will use for context.
    36143619 * @param bool $clean_taxonomy Whether to clean taxonomy wide caches (true), or just individual term object caches (false). Default is true.
     
    38703875 *
    38713876 * @access private
    38723877 * @since 2.3.0
    3873  * @uses $wpdb
    38743878 *
     3879 * @global wpdb $wpdb WordPress database abstraction object.
     3880 *
    38753881 * @param array $terms List of Term IDs
    38763882 * @param string $taxonomy Term Context
    38773883 * @return null Will break from function if conditions are not met.
     
    39343940 *
    39353941 * @access private
    39363942 * @since 2.3.0
    3937  * @uses $wpdb
    39383943 *
     3944 * @global wpdb $wpdb WordPress database abstraction object.
     3945 *
    39393946 * @param array $terms List of Term taxonomy IDs
    39403947 * @param object $taxonomy Current taxonomy object of terms
    39413948 */
     
    39823989 * Default callback for the link_category taxonomy.
    39833990 *
    39843991 * @since 3.3.0
    3985  * @uses $wpdb
    39863992 *
     3993 * @global wpdb $wpdb WordPress database abstraction object.
     3994 *
    39873995 * @param array $terms List of Term taxonomy IDs
    39883996 * @param object $taxonomy Current taxonomy object of terms
    39893997 */
  • src/wp-includes/user.php

     
    806806                 *
    807807                 * @since 3.2.0
    808808                 *
    809                  * @global wpdb $wpdb WordPress database object.
     809                 * @global wpdb $wpdb WordPress database abstraction object.
    810810                 *
    811811                 * @param string $sql The SELECT FOUND_ROWS() query for the current WP_User_Query.
    812812                 */
  • src/wp-login.php

     
    263263/**
    264264 * Handles sending password retrieval email to user.
    265265 *
    266  * @uses $wpdb WordPress Database object
     266 * @global wpdb         $wpdb      WordPress database abstraction object.
     267 * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
    267268 *
    268269 * @return bool|WP_Error True: when finish. WP_Error on error
    269270 */