WordPress.org

Make WordPress Core

Ticket #23567: 23567.3.diff

File 23567.3.diff, 10.2 KB (added by SergeyBiryukov, 10 months ago)
  • tbex.xml

     
    579579          <signature>get_all_category_ids() </signature> 
    580580          <docrelurl>get_all_category_ids</docrelurl> 
    581581        </item> 
    582         <item name= "get_ancestors"> 
    583           <description>Returns an array containing the parents of the given object. </description> 
    584           <signature>get_ancestors( 208, 'category' ); </signature> 
    585           <docrelurl>get_ancestors</docrelurl> 
    586         </item> 
    587582        <item name= "get_cat_ID"> 
    588583          <description>Retrieve the ID of a category from its name. </description> 
    589584          <signature>get_cat_ID( $cat_name ) </signature> 
     
    613608          </signature> 
    614609          <docrelurl>get_categories</docrelurl> 
    615610        </item> 
    616         <item name= "get_categories"> 
    617           <description>Returns an array of category objects matching the query parameters. Arguments are pretty much the same as wp_list_categories and can be passed as either array or in query syntax. </description> 
    618           <signature> 
    619             $args = array( 
    620             'type'                     => 'post', 
    621             'child_of'                 => 0, 
    622             'parent'                   => '', 
    623             'orderby'                  => 'name', 
    624             'order'                    => 'ASC', 
    625             'hide_empty'               => 1, 
    626             'hierarchical'             => 1, 
    627             'exclude'                  => '', 
    628             'include'                  => '', 
    629             'number'                   => '', 
    630             'taxonomy'                 => 'category', 
    631             'pad_counts'               => false ); 
    632           </signature> 
    633           <docrelurl>get_categories</docrelurl> 
    634         </item> 
    635611        <item name= "get_category"> 
    636612          <description>Retrieves category data given a category ID or category object. If you pass the $category parameter an object, which is assumed to be the category row object retrieved the database. It will cache the category data. If you pass $category an integer of the category ID, then that category will be retrieved from the database, if it isn't already cached, and pass it back. If you look at get_term(), then both types will be passed through several filters and finally sanitized based on the $filter parameter value. The category will converted to maintain backwards compatibility. Note: use get_term() to get Link Categories based on their ID's. get_category only returns Post Categories. </description> 
    637613          <signature>get_category( $category, $output, $filter ) </signature> 
     
    939915          <signature></signature> 
    940916          <docrelurl>add_role</docrelurl> 
    941917        </item> 
    942         <item name= "add_role"> 
    943           <description>Adds a new Role to WordPress. </description> 
    944           <signature></signature> 
    945           <docrelurl>add_role</docrelurl> 
    946         </item> 
    947918        <item name= "author_can"> 
    948919          <description>Whether author of supplied post has capability or role. </description> 
    949920          <signature></signature> 
     
    978949          </signature> 
    979950          <docrelurl>get_super_admins</docrelurl> 
    980951        </item> 
    981         <item name= "get_super_admins"> 
    982           <description>Retrieve a list of super admins. Uses $super_admins Super admins global variable, if set. </description> 
    983           <signature> 
    984             $super_admins = get_super_admins(); 
    985             echo 'List of super-admin users:<ul> 
    986               '; 
    987               foreach ($super_admins as $admin) { 
    988               echo '<li>' . $admin . '</li>'; 
    989               } 
    990               echo ' 
    991             </ul>'; 
    992           </signature> 
    993           <docrelurl>get_super_admins</docrelurl> 
    994         </item> 
    995952        <item name= "is_super_admin"> 
    996953          <description>Determine if user is a network (super) admin. </description> 
    997954          <signature></signature> 
     
    10821039          </signature> 
    10831040          <docrelurl>get_userdata</docrelurl> 
    10841041        </item> 
    1085         <item name= "get_userdata"> 
    1086           <description>Returns a WP_User object with the information pertaining to the user whose ID is passed to it. Properties map directly to wp_users and wp_usermeta tables in the database (see Database Description). If the user does not exist, the function returns false. An alias of get_user_by('id'). </description> 
    1087           <signature> 
    1088             $user_info = get_userdata(1); 
    1089             echo 'Username: ' . $user_info->user_login . "\n"; 
    1090             echo 'User level: ' . $user_info->user_level . "\n"; 
    1091             echo 'User ID: ' . $user_info->ID . "\n"; 
    1092           </signature> 
    1093           <docrelurl>get_userdata</docrelurl> 
    1094         </item> 
    10951042        <item name= "get_usernumposts"> 
    10961043          <description>Returns the post count for the user whose ID is passed to it. Properties map directly to the wp_posts table in the database (see Database Description). </description> 
    10971044          <signature>echo 'Posts made: ' . get_usernumposts(1); </signature> 
     
    11071054          <signature>set_current_user( $id, $name ) </signature> 
    11081055          <docrelurl>set_current_user</docrelurl> 
    11091056        </item> 
    1110         <item name= "set_current_user"> 
    1111           <description>This function can be replaced via plugins. If plugins do not redefine these functions, then this will be used instead. Changes the current user by ID or name. Set $id to null and specify a name if you do not know a user's ID. </description> 
    1112           <signature>set_current_user( $id, $name ) </signature> 
    1113           <docrelurl>set_current_user</docrelurl> 
    1114         </item> 
    11151057        <item name= "user_pass_ok"> 
    11161058          <description>Check that the user login name and password is correct. </description> 
    11171059          <signature>user_pass_ok( $user_login, $user_pass ) </signature> 
     
    27222664          <signature>$wp_admin_bar->get_nodes(); </signature> 
    27232665          <docrelurl>get_nodes</docrelurl> 
    27242666        </item> 
    2725         <item name= "get_nodes"> 
    2726           <description>This function returns an array of all the Toolbar items on the current page. Toolbar items are also called "nodes". The Toolbar replaces the Admin Bar since WordPress Version 3.3. note: This function is a method of the WP_Admin_Bar class and $wp_admin_bar global object, which may not exist except during the 'admin_bar_menu' or 'wp_before_admin_bar_render' hooks. </description> 
    2727           <signature>$wp_admin_bar->get_nodes(); </signature> 
    2728           <docrelurl>get_nodes</docrelurl> 
    2729         </item> 
    2730         <item name= "get_nodes"> 
    2731           <description>This function returns an array of all the Toolbar items on the current page. Toolbar items are also called "nodes". The Toolbar replaces the Admin Bar since WordPress Version 3.3. note: This function is a method of the WP_Admin_Bar class and $wp_admin_bar global object, which may not exist except during the 'admin_bar_menu' or 'wp_before_admin_bar_render' hooks. </description> 
    2732           <signature>$wp_admin_bar->get_nodes(); </signature> 
    2733           <docrelurl>get_nodes</docrelurl> 
    2734         </item> 
    2735         <item name= "get_nodes"> 
    2736           <description>This function returns an array of all the Toolbar items on the current page. Toolbar items are also called "nodes". The Toolbar replaces the Admin Bar since WordPress Version 3.3. note: This function is a method of the WP_Admin_Bar class and $wp_admin_bar global object, which may not exist except during the 'admin_bar_menu' or 'wp_before_admin_bar_render' hooks. </description> 
    2737           <signature>$wp_admin_bar->get_nodes(); </signature> 
    2738           <docrelurl>get_nodes</docrelurl> 
    2739         </item> 
    27402667        <item name= "checked"> 
    27412668          <description>Compares two given values (for example, a saved option vs. one chosen in a form) and, if the values are the same, adds the checked attribute to the current radio button or checkbox. This is essentially the same as comparing values with if(), but results in more concise code. </description> 
    27422669          <signature></signature> 
     
    27522679          <signature></signature> 
    27532680          <docrelurl>selected</docrelurl> 
    27542681        </item> 
    2755         <item name= "selected"> 
    2756           <description>For use in dropdown form fields. Compares two given values (for example, a saved option vs. one chosen in a form) and, if the values are the same, adds the selected attribute to the current option tag. </description> 
    2757           <signature></signature> 
    2758           <docrelurl>selected</docrelurl> 
    2759         </item> 
    2760         <item name= "selected"> 
    2761           <description>For use in dropdown form fields. Compares two given values (for example, a saved option vs. one chosen in a form) and, if the values are the same, adds the selected attribute to the current option tag. </description> 
    2762           <signature></signature> 
    2763           <docrelurl>selected</docrelurl> 
    2764         </item> 
    2765         <item name= "selected"> 
    2766           <description>For use in dropdown form fields. Compares two given values (for example, a saved option vs. one chosen in a form) and, if the values are the same, adds the selected attribute to the current option tag. </description> 
    2767           <signature></signature> 
    2768           <docrelurl>selected</docrelurl> 
    2769         </item> 
    27702682        <item name= "check_admin_referer"> 
    27712683          <description>Tests if the current request was referred from an admin page, or (given $action parameter) if the current request carries a valid nonce. Used to avoid security exploits. </description> 
    27722684          <signature>check_admin_referer( $action, $query_arg ); </signature> 
     
    28422754          <signature>xmlrpc_removepostdata( $content ) </signature> 
    28432755          <docrelurl>xmlrpc_removepostdata</docrelurl> 
    28442756        </item> 
    2845         <item name= "user_pass_ok"> 
    2846           <description>Check that the user login name and password is correct. </description> 
    2847           <signature>user_pass_ok( $user_login, $user_pass ) </signature> 
    2848           <docrelurl>user_pass_ok</docrelurl> 
    2849         </item> 
    28502757        <item name= "__"> 
    28512758          <description>Retrieves the translated string from the translate(). </description> 
    28522759          <signature>$translated_text = __( $text, $domain ); </signature>