phpDoc corrections for wp-includes. See #7550 props santosj.
git-svn-id: http://svn.automattic.com/wordpress/trunk@8742 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
westi
parent
5b88b2c5c9
commit
f7b32217a3
|
|
@ -381,7 +381,7 @@ function the_author_posts() {
|
|||
* link to the author's posts.
|
||||
*
|
||||
* @link http://codex.wordpress.org/Template_Tags/the_author_posts_link
|
||||
* @since 1.2
|
||||
* @since 1.2.0
|
||||
* @uses $authordata The current author's DB object.
|
||||
* @uses get_author_posts_url()
|
||||
* @uses get_the_author()
|
||||
|
|
@ -400,7 +400,7 @@ function the_author_posts_link($deprecated = '') {
|
|||
/**
|
||||
* Retrieve the URL to the author page of the author of the current post.
|
||||
*
|
||||
* @since 2.1
|
||||
* @since 2.1.0
|
||||
* @uses $wp_rewrite WP_Rewrite
|
||||
* @return string The URL to the author's page.
|
||||
*/
|
||||
|
|
@ -453,7 +453,7 @@ function get_author_name( $auth_id ) {
|
|||
* echo (boolean) (true): Set to false to return the output, instead of echoing.
|
||||
*
|
||||
* @link http://codex.wordpress.org/Template_Tags/wp_list_authors
|
||||
* @since 1.2
|
||||
* @since 1.2.0
|
||||
* @param array $args The argument array.
|
||||
* @return null|string The output, if echo is set to false.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* The formatted output of a list of bookmarks
|
||||
* The formatted output of a list of bookmarks.
|
||||
*
|
||||
* The $bookmarks array must contain bookmark objects and will be iterated over
|
||||
* to retrieve the bookmark to be used in the output.
|
||||
|
|
@ -34,7 +34,7 @@
|
|||
* description, and image.
|
||||
* 'show_rating' - Default is 0 (integer). Whether to show the link rating.
|
||||
*
|
||||
* @since 2.1
|
||||
* @since 2.1.0
|
||||
* @access private
|
||||
* @usedby wp_list_bookmarks()
|
||||
*
|
||||
|
|
@ -120,7 +120,7 @@ function _walk_bookmarks($bookmarks, $args = '' ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Retrieve or echo all of the bookmarks
|
||||
* Retrieve or echo all of the bookmarks.
|
||||
*
|
||||
* List of default arguments are as follows:
|
||||
* 'orderby' - Default is 'name' (string). How to order the links by. String is
|
||||
|
|
@ -174,7 +174,7 @@ function _walk_bookmarks($bookmarks, $args = '' ) {
|
|||
* passed to get_bookmarks().
|
||||
* @link http://codex.wordpress.org/Template_Tags/wp_list_bookmarks
|
||||
*
|
||||
* @since 2.1
|
||||
* @since 2.1.0
|
||||
* @uses _list_bookmarks() Used to iterate over all of the bookmarks and return
|
||||
* the html
|
||||
* @uses get_terms() Gets all of the categories that are for links.
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
/**
|
||||
* Retrieve Bookmark data based on ID
|
||||
*
|
||||
* @since 2.1
|
||||
* @since 2.1.0
|
||||
* @uses $wpdb Database Object
|
||||
*
|
||||
* @param int $bookmark_id
|
||||
|
|
@ -39,7 +39,7 @@ function get_bookmark($bookmark_id, $output = OBJECT, $filter = 'raw') {
|
|||
/**
|
||||
* Retrieve single bookmark data item or field.
|
||||
*
|
||||
* @since 2.3
|
||||
* @since 2.3.0
|
||||
* @uses get_bookmark() Gets bookmark object using $bookmark as ID
|
||||
* @uses sanitize_bookmark_field() Sanitizes Bookmark field based on $context.
|
||||
*
|
||||
|
|
@ -67,7 +67,7 @@ function get_bookmark_field( $field, $bookmark, $context = 'display' ) {
|
|||
/**
|
||||
* Retrieve bookmark data based on ID.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
* @deprecated Use get_bookmark()
|
||||
* @see get_bookmark()
|
||||
*
|
||||
|
|
@ -106,7 +106,7 @@ function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') {
|
|||
* 'exclude' - Default is empty string (string). Exclude other categories
|
||||
* separated by commas.
|
||||
*
|
||||
* @since 2.1
|
||||
* @since 2.1.0
|
||||
* @uses $wpdb Database Object
|
||||
* @link http://codex.wordpress.org/Template_Tags/get_bookmarks
|
||||
*
|
||||
|
|
@ -238,7 +238,7 @@ function get_bookmarks($args = '') {
|
|||
/**
|
||||
* Sanitizes all bookmark fields
|
||||
*
|
||||
* @since 2.3
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @param object|array $bookmark Bookmark row
|
||||
* @param string $context Optional, default is 'display'. How to filter the
|
||||
|
|
@ -279,7 +279,7 @@ function sanitize_bookmark($bookmark, $context = 'display') {
|
|||
* $field has the filter name and is passed the $value, $bookmark_id, and
|
||||
* $context respectively.
|
||||
*
|
||||
* @since 2.3
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @param string $field The bookmark field
|
||||
* @param mixed $value The bookmark field value
|
||||
|
|
@ -333,7 +333,7 @@ function sanitize_bookmark_field($field, $value, $bookmark_id, $context) {
|
|||
/**
|
||||
* Deletes entire bookmark cache
|
||||
*
|
||||
* @since 2.1
|
||||
* @since 2.1.0
|
||||
* @uses wp_cache_delete() Deletes the contents of 'get_bookmarks'
|
||||
*/
|
||||
function delete_get_bookmark_cache() {
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
/**
|
||||
* Adds data to the cache, if the cache key doesn't aleady exist.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
* @uses $wp_object_cache Object Cache Class
|
||||
* @see WP_Object_Cache::add()
|
||||
*
|
||||
|
|
@ -35,7 +35,7 @@ function wp_cache_add($key, $data, $flag = '', $expire = 0) {
|
|||
* does not mean that plugins can't implement this function when they need to
|
||||
* make sure that the cache is cleaned up after WordPress no longer needs it.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*
|
||||
* @return bool Always returns True
|
||||
*/
|
||||
|
|
@ -46,7 +46,7 @@ function wp_cache_close() {
|
|||
/**
|
||||
* Removes the cache contents matching ID and flag.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
* @uses $wp_object_cache Object Cache Class
|
||||
* @see WP_Object_Cache::delete()
|
||||
*
|
||||
|
|
@ -63,7 +63,7 @@ function wp_cache_delete($id, $flag = '') {
|
|||
/**
|
||||
* Removes all cache items.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
* @uses $wp_object_cache Object Cache Class
|
||||
* @see WP_Object_Cache::flush()
|
||||
*
|
||||
|
|
@ -78,7 +78,7 @@ function wp_cache_flush() {
|
|||
/**
|
||||
* Retrieves the cache contents from the cache by ID and flag.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
* @uses $wp_object_cache Object Cache Class
|
||||
* @see WP_Object_Cache::get()
|
||||
*
|
||||
|
|
@ -96,7 +96,7 @@ function wp_cache_get($id, $flag = '') {
|
|||
/**
|
||||
* Sets up Object Cache Global and assigns it.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
* @global WP_Object_Cache $wp_object_cache WordPress Object Cache
|
||||
*/
|
||||
function wp_cache_init() {
|
||||
|
|
@ -106,7 +106,7 @@ function wp_cache_init() {
|
|||
/**
|
||||
* Replaces the contents of the cache with new data.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
* @uses $wp_object_cache Object Cache Class
|
||||
* @see WP_Object_Cache::replace()
|
||||
*
|
||||
|
|
@ -144,7 +144,7 @@ function wp_cache_set($key, $data, $flag = '', $expire = 0) {
|
|||
/**
|
||||
* Adds a group or set of groups to the list of global groups.
|
||||
*
|
||||
* @since 2.6
|
||||
* @since 2.6.0
|
||||
*
|
||||
* @param string|array $groups A group or an array of groups to add
|
||||
*/
|
||||
|
|
@ -156,7 +156,7 @@ function wp_cache_add_global_groups( $groups ) {
|
|||
/**
|
||||
* Adds a group or set of groups to the list of non-persistent groups.
|
||||
*
|
||||
* @since 2.6
|
||||
* @since 2.6.0
|
||||
*
|
||||
* @param string|array $groups A group or an array of groups to add
|
||||
*/
|
||||
|
|
@ -188,7 +188,7 @@ class WP_Object_Cache {
|
|||
*
|
||||
* @var array
|
||||
* @access private
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*/
|
||||
var $cache = array ();
|
||||
|
||||
|
|
@ -197,14 +197,14 @@ class WP_Object_Cache {
|
|||
*
|
||||
* @var array
|
||||
* @access private
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*/
|
||||
var $non_existant_objects = array ();
|
||||
|
||||
/**
|
||||
* The amount of times the cache data was already stored in the cache.
|
||||
*
|
||||
* @since 2.5
|
||||
* @since 2.5.0
|
||||
* @access private
|
||||
* @var int
|
||||
*/
|
||||
|
|
@ -215,7 +215,7 @@ class WP_Object_Cache {
|
|||
*
|
||||
* @var int
|
||||
* @access public
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*/
|
||||
var $cache_misses = 0;
|
||||
|
||||
|
|
@ -226,7 +226,7 @@ class WP_Object_Cache {
|
|||
* @uses WP_Object_Cache::set Sets the data after the checking the cache
|
||||
* contents existance.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*
|
||||
* @param int|string $id What to call the contents in the cache
|
||||
* @param mixed $data The contents to store in the cache
|
||||
|
|
@ -254,7 +254,7 @@ class WP_Object_Cache {
|
|||
* On success the group and the id will be added to the
|
||||
* $non_existant_objects property in the class.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*
|
||||
* @param int|string $id What the contents in the cache are called
|
||||
* @param string $group Where the cache contents are grouped
|
||||
|
|
@ -277,7 +277,7 @@ class WP_Object_Cache {
|
|||
/**
|
||||
* Clears the object cache of all data
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*
|
||||
* @return bool Always returns true
|
||||
*/
|
||||
|
|
@ -300,7 +300,7 @@ class WP_Object_Cache {
|
|||
* misses will be incremented and the cache group and ID will be added to
|
||||
* the nonexistant objects.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*
|
||||
* @param int|string $id What the contents in the cache are called
|
||||
* @param string $group Where the cache contents are grouped
|
||||
|
|
@ -327,7 +327,7 @@ class WP_Object_Cache {
|
|||
/**
|
||||
* Replace the contents in the cache, if contents already exist
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
* @see WP_Object_Cache::set()
|
||||
*
|
||||
* @param int|string $id What to call the contents in the cache
|
||||
|
|
@ -358,7 +358,7 @@ class WP_Object_Cache {
|
|||
* expire for each time a page is accessed and PHP finishes. The method is
|
||||
* more for cache plugins which use files.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*
|
||||
* @param int|string $id What to call the contents in the cache
|
||||
* @param mixed $data The contents to store in the cache
|
||||
|
|
@ -387,7 +387,7 @@ class WP_Object_Cache {
|
|||
* Gives the cache hits, and cache misses. Also prints every cached group,
|
||||
* key and the data.
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*/
|
||||
function stats() {
|
||||
echo "<p>";
|
||||
|
|
@ -408,7 +408,7 @@ class WP_Object_Cache {
|
|||
/**
|
||||
* PHP4 constructor; Calls PHP 5 style constructor
|
||||
*
|
||||
* @since 2.0
|
||||
* @since 2.0.0
|
||||
*
|
||||
* @return WP_Object_Cache
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -8,11 +8,11 @@
|
|||
* @author Scott Yang
|
||||
* @author Mark Jaquith
|
||||
* @package WordPress
|
||||
* @since 2.3
|
||||
* @since 2.3.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Redirects incoming links to the proper URL based on the site url
|
||||
* Redirects incoming links to the proper URL based on the site url.
|
||||
*
|
||||
* Search engines consider www.somedomain.com and somedomain.com to be two
|
||||
* different URLs when they both go to the same location. This SEO enhancement
|
||||
|
|
@ -26,7 +26,7 @@
|
|||
* not exist based on exact WordPress query. Will instead try to parse the URL
|
||||
* or query in an attempt to figure the correct page to go to.
|
||||
*
|
||||
* @since 2.3
|
||||
* @since 2.3.0
|
||||
* @uses $wp_rewrite
|
||||
* @uses $is_IIS
|
||||
*
|
||||
|
|
@ -243,9 +243,9 @@ function redirect_canonical($requested_url=null, $do_redirect=true) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Attempts to guess correct post based on query vars
|
||||
* Attempts to guess correct post based on query vars.
|
||||
*
|
||||
* @since 2.3
|
||||
* @since 2.3.0
|
||||
* @uses $wpdb
|
||||
*
|
||||
* @return bool|string Returns False, if it can't find post, returns correct
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ function &get_categories( $args = '' ) {
|
|||
*
|
||||
* The category will converted to maintain backwards compatibility.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @since 1.5.1
|
||||
* @uses get_term() Used to get the category data from the taxonomy.
|
||||
*
|
||||
* @param int|object $category Category ID or Category row object
|
||||
|
|
|
|||
|
|
@ -1,6 +1,9 @@
|
|||
<?php
|
||||
/**
|
||||
* Deprecated functions from past WordPress versions
|
||||
* Deprecated functions from past WordPress versions. You shouldn't use these
|
||||
* globals and functions and look for the alternatives instead. The functions
|
||||
* and globals will be removed in a later version.
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage Deprecated
|
||||
*/
|
||||
|
|
@ -76,7 +79,7 @@ $tablepostmeta = $wpdb->postmeta;
|
|||
*/
|
||||
|
||||
/**
|
||||
* get_postdata() - Entire Post data
|
||||
* Entire Post data.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use get_post()
|
||||
|
|
@ -112,7 +115,7 @@ function get_postdata($postid) {
|
|||
}
|
||||
|
||||
/**
|
||||
* start_wp() - Sets up the WordPress Loop
|
||||
* Sets up the WordPress Loop.
|
||||
*
|
||||
* @since 1.0.1
|
||||
* @deprecated Since 1.5 - {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
|
||||
|
|
@ -129,7 +132,7 @@ function start_wp() {
|
|||
}
|
||||
|
||||
/**
|
||||
* the_category_ID() - Return or Print Category ID
|
||||
* Return or Print Category ID.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated use get_the_category()
|
||||
|
|
@ -152,7 +155,7 @@ function the_category_ID($echo = true) {
|
|||
}
|
||||
|
||||
/**
|
||||
* the_category_head() - Print category with optional text before and after
|
||||
* Print category with optional text before and after.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated use get_the_category_by_ID()
|
||||
|
|
@ -178,7 +181,7 @@ function the_category_head($before='', $after='') {
|
|||
}
|
||||
|
||||
/**
|
||||
* previous_post() - Prints link to the previous post
|
||||
* Prints link to the previous post.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use previous_post_link()
|
||||
|
|
@ -214,7 +217,7 @@ function previous_post($format='%', $previous='previous post: ', $title='yes', $
|
|||
}
|
||||
|
||||
/**
|
||||
* next_post() - Prints link to the next post
|
||||
* Prints link to the next post.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use next_post_link()
|
||||
|
|
@ -249,7 +252,7 @@ function next_post($format='%', $next='next post: ', $title='yes', $in_same_cat=
|
|||
}
|
||||
|
||||
/**
|
||||
* user_can_create_post() - Whether user can create a post
|
||||
* Whether user can create a post.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use current_user_can()
|
||||
|
|
@ -268,7 +271,7 @@ function user_can_create_post($user_id, $blog_id = 1, $category_id = 'None') {
|
|||
}
|
||||
|
||||
/**
|
||||
* user_can_create_draft() - Whether user can create a post
|
||||
* Whether user can create a post.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use current_user_can()
|
||||
|
|
@ -287,7 +290,7 @@ function user_can_create_draft($user_id, $blog_id = 1, $category_id = 'None') {
|
|||
}
|
||||
|
||||
/**
|
||||
* user_can_edit_post() - Whether user can edit a post
|
||||
* Whether user can edit a post.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use current_user_can()
|
||||
|
|
@ -315,7 +318,7 @@ function user_can_edit_post($user_id, $post_id, $blog_id = 1) {
|
|||
}
|
||||
|
||||
/**
|
||||
* user_can_delete_post() - Whether user can delete a post
|
||||
* Whether user can delete a post.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use current_user_can()
|
||||
|
|
@ -334,7 +337,7 @@ function user_can_delete_post($user_id, $post_id, $blog_id = 1) {
|
|||
}
|
||||
|
||||
/**
|
||||
* user_can_set_post_date() - Whether user can set new posts' dates
|
||||
* Whether user can set new posts' dates.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use current_user_can()
|
||||
|
|
@ -352,9 +355,8 @@ function user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') {
|
|||
return (($author_data->user_level > 4) && user_can_create_post($user_id, $blog_id, $category_id));
|
||||
}
|
||||
|
||||
/* returns true if $user_id can edit $post_id's date */
|
||||
/**
|
||||
* user_can_edit_post_date() - Whether user can delete a post
|
||||
* Whether user can delete a post.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use current_user_can()
|
||||
|
|
@ -363,7 +365,7 @@ function user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') {
|
|||
* @param int $user_id
|
||||
* @param int $post_id
|
||||
* @param int $blog_id Not Used
|
||||
* @return bool
|
||||
* @return bool returns true if $user_id can edit $post_id's date
|
||||
*/
|
||||
function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) {
|
||||
_deprecated_function(__FUNCTION__, '0.0', 'current_user_can()');
|
||||
|
|
@ -372,9 +374,8 @@ function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) {
|
|||
return (($author_data->user_level > 4) && user_can_edit_post($user_id, $post_id, $blog_id));
|
||||
}
|
||||
|
||||
/* returns true if $user_id can edit $post_id's comments */
|
||||
/**
|
||||
* user_can_edit_post_comments() - Whether user can delete a post
|
||||
* Whether user can delete a post.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use current_user_can()
|
||||
|
|
@ -383,7 +384,7 @@ function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) {
|
|||
* @param int $user_id
|
||||
* @param int $post_id
|
||||
* @param int $blog_id Not Used
|
||||
* @return bool
|
||||
* @return bool returns true if $user_id can edit $post_id's comments
|
||||
*/
|
||||
function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) {
|
||||
_deprecated_function(__FUNCTION__, '0.0', 'current_user_can()');
|
||||
|
|
@ -392,9 +393,8 @@ function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) {
|
|||
return user_can_edit_post($user_id, $post_id, $blog_id);
|
||||
}
|
||||
|
||||
/* returns true if $user_id can delete $post_id's comments */
|
||||
/**
|
||||
* user_can_delete_post_comments() - Whether user can delete a post
|
||||
* Whether user can delete a post.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use current_user_can()
|
||||
|
|
@ -403,7 +403,7 @@ function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) {
|
|||
* @param int $user_id
|
||||
* @param int $post_id
|
||||
* @param int $blog_id Not Used
|
||||
* @return bool
|
||||
* @return bool returns true if $user_id can delete $post_id's comments
|
||||
*/
|
||||
function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) {
|
||||
_deprecated_function(__FUNCTION__, '0.0', 'current_user_can()');
|
||||
|
|
@ -413,7 +413,7 @@ function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) {
|
|||
}
|
||||
|
||||
/**
|
||||
* user_can_edit_user() - Can user can edit other user
|
||||
* Can user can edit other user.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use current_user_can()
|
||||
|
|
@ -435,7 +435,7 @@ function user_can_edit_user($user_id, $other_user) {
|
|||
}
|
||||
|
||||
/**
|
||||
* get_linksbyname() - Gets the links associated with category $cat_name.
|
||||
* Gets the links associated with category $cat_name.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use get_links()
|
||||
|
|
@ -468,7 +468,7 @@ function get_linksbyname($cat_name = "noname", $before = '', $after = '<br />',
|
|||
}
|
||||
|
||||
/**
|
||||
* wp_get_linksbyname() - Gets the links associated with the named category.
|
||||
* Gets the links associated with the named category.
|
||||
*
|
||||
* @since 1.0.1
|
||||
* @deprecated Use wp_get_links()
|
||||
|
|
@ -491,7 +491,7 @@ function wp_get_linksbyname($category, $args = '') {
|
|||
}
|
||||
|
||||
/**
|
||||
* get_linkobjectsbyname() - Gets an array of link objects associated with category $cat_name.
|
||||
* Gets an array of link objects associated with category $cat_name.
|
||||
*
|
||||
* <code>
|
||||
* $links = get_linkobjectsbyname('fred');
|
||||
|
|
@ -523,7 +523,7 @@ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit
|
|||
}
|
||||
|
||||
/**
|
||||
* get_linkobjects() - Gets an array of link objects associated with category n.
|
||||
* Gets an array of link objects associated with category n.
|
||||
*
|
||||
* Usage:
|
||||
* <code>
|
||||
|
|
@ -577,7 +577,7 @@ function get_linkobjects($category = 0, $orderby = 'name', $limit = 0) {
|
|||
}
|
||||
|
||||
/**
|
||||
* get_linksbyname_withrating() - Gets the links associated with category 'cat_name' and display rating stars/chars.
|
||||
* Gets the links associated with category 'cat_name' and display rating stars/chars.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use get_bookmarks()
|
||||
|
|
@ -604,7 +604,7 @@ function get_linksbyname_withrating($cat_name = "noname", $before = '', $after =
|
|||
}
|
||||
|
||||
/**
|
||||
* get_links_withrating() - Gets the links associated with category n and display rating stars/chars.
|
||||
* Gets the links associated with category n and display rating stars/chars.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use get_bookmarks()
|
||||
|
|
@ -631,7 +631,7 @@ function get_links_withrating($category = -1, $before = '', $after = '<br />', $
|
|||
}
|
||||
|
||||
/**
|
||||
* get_autotoggle() - Gets the auto_toggle setting
|
||||
* Gets the auto_toggle setting.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated No alternative function available
|
||||
|
|
@ -793,7 +793,7 @@ function wp_get_post_cats($blogid = '1', $post_ID = 0) {
|
|||
}
|
||||
|
||||
/**
|
||||
* wp_set_post_cats() - Sets the categories that the post id belongs to.
|
||||
* Sets the categories that the post id belongs to.
|
||||
*
|
||||
* @since 1.0.1
|
||||
* @deprecated Use wp_set_post_categories()
|
||||
|
|
@ -829,7 +829,7 @@ function get_archives($type='', $limit='', $format='html', $before = '', $after
|
|||
}
|
||||
|
||||
/**
|
||||
* get_author_link() - Returns or Prints link to the author's posts
|
||||
* Returns or Prints link to the author's posts.
|
||||
*
|
||||
* @since 1.2
|
||||
* @deprecated Use get_author_posts_url()
|
||||
|
|
@ -851,7 +851,7 @@ function get_author_link($echo = false, $author_id, $author_nicename = '') {
|
|||
}
|
||||
|
||||
/**
|
||||
* link_pages() - Print list of pages based on arguments
|
||||
* Print list of pages based on arguments.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use wp_link_pages()
|
||||
|
|
@ -875,7 +875,7 @@ function link_pages($before='<br />', $after='<br />', $next_or_number='number',
|
|||
}
|
||||
|
||||
/**
|
||||
* get_settings() - Get value based on option
|
||||
* Get value based on option.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use get_option()
|
||||
|
|
@ -891,7 +891,7 @@ function get_settings($option) {
|
|||
}
|
||||
|
||||
/**
|
||||
* permalink_link() - Print the permalink of the current post in the loop
|
||||
* Print the permalink of the current post in the loop.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use the_permalink()
|
||||
|
|
@ -903,7 +903,7 @@ function permalink_link() {
|
|||
}
|
||||
|
||||
/**
|
||||
* permalink_single_rss() - Print the permalink to the RSS feed
|
||||
* Print the permalink to the RSS feed.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use the_permalink_rss()
|
||||
|
|
@ -917,7 +917,7 @@ function permalink_single_rss($deprecated = '') {
|
|||
}
|
||||
|
||||
/**
|
||||
* wp_get_links() - Gets the links associated with category.
|
||||
* Gets the links associated with category.
|
||||
*
|
||||
* @see get_links() for argument information that can be used in $args
|
||||
* @since 1.0.1
|
||||
|
|
@ -951,7 +951,7 @@ function wp_get_links($args = '') {
|
|||
}
|
||||
|
||||
/**
|
||||
* get_links() - Gets the links associated with category by id.
|
||||
* Gets the links associated with category by id.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use get_bookmarks()
|
||||
|
|
@ -1056,11 +1056,10 @@ function get_links($category = -1, $before = '', $after = '<br />', $between = '
|
|||
}
|
||||
|
||||
/**
|
||||
* get_links_list() - Output entire list of links by category
|
||||
* Output entire list of links by category.
|
||||
*
|
||||
* Output a list of all links, listed by category, using the
|
||||
* settings in $wpdb->linkcategories and output it as a nested
|
||||
* HTML unordered list.
|
||||
* Output a list of all links, listed by category, using the settings in
|
||||
* $wpdb->linkcategories and output it as a nested HTML unordered list.
|
||||
*
|
||||
* @author Dougal
|
||||
* @since 1.0.1
|
||||
|
|
@ -1104,7 +1103,7 @@ function get_links_list($order = 'name', $deprecated = '') {
|
|||
}
|
||||
|
||||
/**
|
||||
* links_popup_script() - Show the link to the links popup and the number of links
|
||||
* Show the link to the links popup and the number of links.
|
||||
*
|
||||
* @author Fullo
|
||||
* @link http://sprite.csr.unibo.it/fullo/
|
||||
|
|
@ -1148,7 +1147,7 @@ function get_linkrating($link) {
|
|||
}
|
||||
|
||||
/**
|
||||
* get_linkcatname() - Gets the name of category by id.
|
||||
* Gets the name of category by id.
|
||||
*
|
||||
* @since 0.71
|
||||
* @deprecated Use get_category()
|
||||
|
|
@ -1177,7 +1176,7 @@ function get_linkcatname($id = 0) {
|
|||
}
|
||||
|
||||
/**
|
||||
* comment_rss_link() - Print RSS comment feed link
|
||||
* Print RSS comment feed link.
|
||||
*
|
||||
* @since 1.0.1
|
||||
* @deprecated Use post_comments_feed_link()
|
||||
|
|
@ -1192,7 +1191,7 @@ function comments_rss_link($link_text = 'Comments RSS', $deprecated = '') {
|
|||
}
|
||||
|
||||
/**
|
||||
* get_category_rss_link() - Print/Return link to category RSS2 feed
|
||||
* Print/Return link to category RSS2 feed.
|
||||
*
|
||||
* @since 1.2
|
||||
* @deprecated Use get_category_feed_link()
|
||||
|
|
@ -1214,7 +1213,7 @@ function get_category_rss_link($echo = false, $cat_ID = 1, $deprecated = '') {
|
|||
}
|
||||
|
||||
/**
|
||||
* get_author_rss_link() - Print/Return link to author RSS feed
|
||||
* Print/Return link to author RSS feed.
|
||||
*
|
||||
* @since 1.2
|
||||
* @deprecated Use get_author_feed_link()
|
||||
|
|
@ -1235,7 +1234,7 @@ function get_author_rss_link($echo = false, $author_id = 1, $deprecated = '') {
|
|||
}
|
||||
|
||||
/**
|
||||
* comments_rss() - Return link to the post RSS feed
|
||||
* Return link to the post RSS feed.
|
||||
*
|
||||
* @since 1.5
|
||||
* @deprecated Use get_post_comments_feed_link()
|
||||
|
|
@ -1250,7 +1249,8 @@ function comments_rss($deprecated = '') {
|
|||
}
|
||||
|
||||
/**
|
||||
* create_user() - An alias of wp_create_user().
|
||||
* An alias of wp_create_user().
|
||||
*
|
||||
* @param string $username The user's username.
|
||||
* @param string $password The user's password.
|
||||
* @param string $email The user's email (optional).
|
||||
|
|
@ -1264,7 +1264,8 @@ function create_user($username, $password, $email) {
|
|||
}
|
||||
|
||||
/**
|
||||
* documentation_link() - Unused Admin function
|
||||
* Unused Admin function.
|
||||
*
|
||||
* @since 2.0
|
||||
* @param string $deprecated Unknown
|
||||
* @deprecated 2.5
|
||||
|
|
@ -1275,11 +1276,10 @@ function documentation_link( $deprecated = '' ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* gzip_compression() - Unused function
|
||||
* Unused function.
|
||||
*
|
||||
* @deprecated 2.5
|
||||
*/
|
||||
|
||||
function gzip_compression() {
|
||||
return false;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
* isn't installing.
|
||||
*
|
||||
* @package WordPress
|
||||
* @since 2.3
|
||||
* @since 2.3.0
|
||||
* @uses $wp_version Used to check against the newest WordPress version.
|
||||
*
|
||||
* @return mixed Returns null if update is unsupported. Returns false if check is too soon.
|
||||
|
|
@ -88,7 +88,7 @@ add_action( 'init', 'wp_version_check' );
|
|||
* isn't installing.
|
||||
*
|
||||
* @package WordPress
|
||||
* @since 2.3
|
||||
* @since 2.3.0
|
||||
* @uses $wp_version Used to notidy the WordPress version.
|
||||
*
|
||||
* @return mixed Returns null if update is unsupported. Returns false if check is too soon.
|
||||
|
|
|
|||
Loading…
Reference in New Issue