* blog is not set to have them.
*
* @since 2.2.0
- * @uses $wp_rewrite
+ * @global WP_Rewrite $wp_rewrite
*
* @param string $string URL with or without a trailing slash.
* @param string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter.
* 'single_feed', 'single_paged', 'feed', 'category', 'page', 'year',
* 'month', 'day', 'paged', 'post_type_archive'.
*/
- $string = apply_filters( 'user_trailingslashit', $string, $type_of_url );
- return $string;
+ return apply_filters( 'user_trailingslashit', $string, $type_of_url );
}
/**
*
* @param int|WP_Post $id Optional. Post ID or post object. Default is the current post.
* @param bool $leavename Optional. Whether to keep post name or page name. Default false.
- * @return string|bool The permalink URL or false if post does not exist.
+ * @return string|false The permalink URL or false if post does not exist.
*/
function get_the_permalink( $id = 0, $leavename = false ) {
return get_permalink( $id, $leavename );
*
* @param int|WP_Post $id Optional. Post ID or post object. Default current post.
* @param bool $leavename Optional. Whether to keep post name or page name. Default false.
- * @return string|bool The permalink URL or false if post does not exist.
+ * @return string|false The permalink URL or false if post does not exist.
*/
function get_permalink( $id = 0, $leavename = false ) {
$rewritecode = array(
*
* @since 3.0.0
*
- * @param int $id Optional. Post ID.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int $id Optional. Post ID.
* @param bool $leavename Optional, defaults to false. Whether to keep post name.
- * @param bool $sample Optional, defaults to false. Is it a sample permalink.
- * @return string The post permalink.
+ * @param bool $sample Optional, defaults to false. Is it a sample permalink.
+ * @return string|WP_Error The post permalink.
*/
function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
global $wp_rewrite;
*
* @since 1.0.0
*
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
- * @param mixed $deprecated Not used.
- * @return string
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
+ * @param mixed $deprecated Not used.
+ * @return string|false
*/
function post_permalink( $post_id = 0, $deprecated = '' ) {
if ( !empty( $deprecated ) )
*
* @since 1.5.0
*
- * @param int|object $post Optional. Post ID or object.
- * @param bool $leavename Optional, defaults to false. Whether to keep page name.
- * @param bool $sample Optional, defaults to false. Is it a sample permalink.
+ * @param int|object $post Optional. Post ID or object.
+ * @param bool $leavename Optional, defaults to false. Whether to keep page name.
+ * @param bool $sample Optional, defaults to false. Is it a sample permalink.
* @return string The page permalink.
*/
function get_page_link( $post = false, $leavename = false, $sample = false ) {
* @since 2.1.0
* @access private
*
- * @param int|object $post Optional. Post ID or object.
- * @param bool $leavename Optional. Leave name.
- * @param bool $sample Optional. Sample permalink.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int|object $post Optional. Post ID or object.
+ * @param bool $leavename Optional. Leave name.
+ * @param bool $sample Optional. Sample permalink.
* @return string The page permalink.
*/
function _get_page_link( $post = false, $leavename = false, $sample = false ) {
*
* @since 2.0.0
*
- * @param int|object $post Optional. Post ID or object.
- * @param bool $leavename Optional. Leave name.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int|object $post Optional. Post ID or object.
+ * @param bool $leavename Optional. Leave name.
* @return string The attachment permalink.
*/
function get_attachment_link( $post = null, $leavename = false ) {
*
* @since 1.5.0
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @param int|bool $year False for current year or year for permalink.
* @return string The permalink for the specified year archive.
*/
*
* @since 1.0.0
*
- * @param bool|int $year False for current year. Integer of year.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param bool|int $year False for current year. Integer of year.
* @param bool|int $month False for current month. Integer of month.
* @return string The permalink for the specified month and year archive.
*/
*
* @since 1.0.0
*
- * @param bool|int $year False for current year. Integer of year.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param bool|int $year False for current year. Integer of year.
* @param bool|int $month False for current month. Integer of month.
- * @param bool|int $day False for current day. Integer of day.
+ * @param bool|int $day False for current day. Integer of day.
* @return string The permalink for the specified day, month, and year archive.
*/
function get_day_link($year, $month, $day) {
* @since 3.0.0
*
* @param string $anchor The link's anchor text.
- * @param string $feed Optional, defaults to default feed. Feed type.
+ * @param string $feed Optional, defaults to default feed. Feed type.
*/
function the_feed_link( $anchor, $feed = '' ) {
$link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>';
*
* @since 1.5.0
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @param string $feed Optional, defaults to default feed. Feed type.
* @return string The feed permalink.
*/
*
* @since 2.2.0
*
- * @param int $post_id Optional. Post ID.
- * @param string $feed Optional. Feed type.
+ * @param int $post_id Optional. Post ID.
+ * @param string $feed Optional. Feed type.
* @return string The permalink for the comments feed for the given post.
*/
function get_post_comments_feed_link($post_id = 0, $feed = '') {
* @since 2.5.0
*
* @param string $link_text Descriptive text.
- * @param int $post_id Optional post ID. Default to current post.
- * @param string $feed Optional. Feed format.
- * @return string Link to the comment feed for the current post.
+ * @param int $post_id Optional post ID. Default to current post.
+ * @param string $feed Optional. Feed format.
*/
function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
$url = esc_url( get_post_comments_feed_link( $post_id, $feed ) );
*
* @since 2.5.0
*
- * @param int $author_id ID of an author.
- * @param string $feed Optional. Feed type.
+ * @param int $author_id ID of an author.
+ * @param string $feed Optional. Feed type.
* @return string Link to the feed for the author specified by $author_id.
*/
function get_author_feed_link( $author_id, $feed = '' ) {
*
* @since 2.5.0
*
- * @param int $cat_id ID of a category.
- * @param string $feed Optional. Feed type.
+ * @param int $cat_id ID of a category.
+ * @param string $feed Optional. Feed type.
* @return string Link to the feed for the category specified by $cat_id.
*/
-function get_category_feed_link($cat_id, $feed = '') {
- return get_term_feed_link($cat_id, 'category', $feed);
+function get_category_feed_link( $cat_id, $feed = '' ) {
+ return get_term_feed_link( $cat_id, 'category', $feed );
}
/**
*
* @since 3.0.0
*
- * @param int $term_id ID of a category.
+ * @param int $term_id ID of a category.
* @param string $taxonomy Optional. Taxonomy of $term_id
- * @param string $feed Optional. Feed type.
- * @return string Link to the feed for the term specified by $term_id and $taxonomy.
+ * @param string $feed Optional. Feed type.
+ * @return string|false Link to the feed for the term specified by $term_id and $taxonomy.
*/
function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
$term_id = ( int ) $term_id;
*
* @since 2.3.0
*
- * @param int $tag_id Tag ID.
- * @param string $feed Optional. Feed type.
+ * @param int $tag_id Tag ID.
+ * @param string $feed Optional. Feed type.
* @return string The feed permalink for the given tag.
*/
-function get_tag_feed_link($tag_id, $feed = '') {
- return get_term_feed_link($tag_id, 'post_tag', $feed);
+function get_tag_feed_link( $tag_id, $feed = '' ) {
+ return get_term_feed_link( $tag_id, 'post_tag', $feed );
}
/**
*
* @since 2.7.0
*
- * @param int $tag_id Tag ID
+ * @param int $tag_id Tag ID
* @param string $taxonomy Taxonomy
* @return string The edit tag link URL for the given tag.
*/
*
* @since 2.7.0
*
- * @param string $link Optional. Anchor text.
+ * @param string $link Optional. Anchor text.
* @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
- * @param object $tag Tag object.
- * @return string HTML content.
+ * @param string $after Optional. Display after edit link.
+ * @param object $tag Tag object.
*/
function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
$link = edit_term_link( $link, '', '', $tag, false );
* @param string $taxonomy Taxonomy.
* @param string $object_type The object type. Used to highlight the proper post type menu on the linked page.
* Defaults to the first object_type associated with the taxonomy.
- * @return string The edit term link URL for the given term.
+ * @return string|null The edit term link URL for the given term, or null on failure.
*/
function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
$tax = get_taxonomy( $taxonomy );
- if ( !current_user_can( $tax->cap->edit_terms ) )
+ if ( ! $tax || ! current_user_can( $tax->cap->edit_terms ) ) {
return;
+ }
$term = get_term( $term_id, $taxonomy );
+ if ( ! $term || is_wp_error( $term ) ) {
+ return;
+ }
$args = array(
'action' => 'edit',
if ( $object_type ) {
$args['post_type'] = $object_type;
- } else if ( ! empty( $tax->object_type ) ) {
+ } elseif ( ! empty( $tax->object_type ) ) {
$args['post_type'] = reset( $tax->object_type );
}
*
* @since 3.1.0
*
- * @param string $link Optional. Anchor text.
- * @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
- * @param object $term Term object.
- * @return string HTML content.
+ * @param string $link Optional. Anchor text. Default empty.
+ * @param string $before Optional. Display before edit link. Default empty.
+ * @param string $after Optional. Display after edit link. Default empty.
+ * @param object $term Optional. Term object. If null, the queried object will be inspected. Default null.
+ * @param bool $echo Optional. Whether or not to echo the return. Default true.
+ * @return string|void HTML content.
*/
function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) {
if ( is_null( $term ) )
*
* @since 3.0.0
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @param string $query Optional. The query string to use. If empty the current query is used.
* @return string The search permalink.
*/
*
* @since 2.5.0
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @param string $search_query Optional. Search query.
- * @param string $feed Optional. Feed type.
+ * @param string $feed Optional. Feed type.
* @return string The search results feed permalink.
*/
function get_search_feed_link($search_query = '', $feed = '') {
* @param string $feed Feed type.
* @param string $type The search type. One of 'posts' or 'comments'.
*/
- $link = apply_filters( 'search_feed_link', $link, $feed, 'posts' );
-
- return $link;
+ return apply_filters( 'search_feed_link', $link, $feed, 'posts' );
}
/**
*
* @since 2.5.0
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @param string $search_query Optional. Search query.
- * @param string $feed Optional. Feed type.
+ * @param string $feed Optional. Feed type.
* @return string The comments feed search results permalink.
*/
function get_search_comments_feed_link($search_query = '', $feed = '') {
$link = add_query_arg('withcomments', 1, $link);
/** This filter is documented in wp-includes/link-template.php */
- $link = apply_filters('search_feed_link', $link, $feed, 'comments');
-
- return $link;
+ return apply_filters( 'search_feed_link', $link, $feed, 'comments' );
}
/**
*
* @since 3.1.0
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @param string $post_type Post type
- * @return string The post type archive permalink.
+ * @return string|false The post type archive permalink.
*/
function get_post_type_archive_link( $post_type ) {
global $wp_rewrite;
* @since 3.1.0
*
* @param string $post_type Post type
- * @param string $feed Optional. Feed type
- * @return string The post type feed permalink.
+ * @param string $feed Optional. Feed type
+ * @return string|false The post type feed permalink.
*/
function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
$default_feed = get_default_feed();
*
* @since 2.3.0
*
- * @param int $id Optional. Post ID.
+ * @param int $id Optional. Post ID.
* @param string $context Optional, defaults to display. How to write the '&', defaults to '&'.
- * @return string The edit post link for the given post.
+ * @return string|void The edit post link for the given post.
*/
function get_edit_post_link( $id = 0, $context = 'display' ) {
if ( ! $post = get_post( $id ) )
*
* @since 1.0.0
*
- * @param string $text Optional. Anchor text.
+ * @param string $text Optional. Anchor text.
* @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
- * @param int $id Optional. Post ID.
+ * @param string $after Optional. Display after edit link.
+ * @param int $id Optional. Post ID.
*/
function edit_post_link( $text = null, $before = '', $after = '', $id = 0 ) {
if ( ! $post = get_post( $id ) ) {
*
* @since 2.9.0
*
- * @param int $id Optional. Post ID.
- * @param string $deprecated Not used.
- * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
- * @return string The delete post link URL for the given post.
+ * @param int $id Optional. Post ID.
+ * @param string $deprecated Not used.
+ * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
+ * @return string|void The delete post link URL for the given post.
*/
function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false ) {
if ( ! empty( $deprecated ) )
* @since 2.3.0
*
* @param int $comment_id Optional. Comment ID.
- * @return string The edit comment link URL for the given comment.
+ * @return string|void The edit comment link URL for the given comment.
*/
function get_edit_comment_link( $comment_id = 0 ) {
$comment = get_comment( $comment_id );
*
* @since 1.0.0
*
- * @param string $text Optional. Anchor text.
+ * @global object $comment
+ *
+ * @param string $text Optional. Anchor text.
* @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
+ * @param string $after Optional. Display after edit link.
*/
function edit_comment_link( $text = null, $before = '', $after = '' ) {
global $comment;
* @since 2.7.0
*
* @param int|stdClass $link Optional. Bookmark ID.
- * @return string The edit bookmark link URL.
+ * @return string|void The edit bookmark link URL.
*/
function get_edit_bookmark_link( $link = 0 ) {
$link = get_bookmark( $link );
*
* @since 2.7.0
*
- * @param string $link Optional. Anchor text.
- * @param string $before Optional. Display before edit link.
- * @param string $after Optional. Display after edit link.
- * @param int $bookmark Optional. Bookmark ID.
+ * @param string $link Optional. Anchor text.
+ * @param string $before Optional. Display before edit link.
+ * @param string $after Optional. Display after edit link.
+ * @param int $bookmark Optional. Bookmark ID.
*/
function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = null ) {
$bookmark = get_bookmark($bookmark);
* @param bool $in_same_term Optional. Whether post should be in a same taxonomy term.
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
+ * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
*/
function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy );
* @param bool $in_same_term Optional. Whether post should be in a same taxonomy term.
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
+ * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
*/
function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
return get_adjacent_post( $in_same_term, $excluded_terms, false, $taxonomy );
*
* @since 2.5.0
*
+ * @global wpdb $wpdb
+ *
* @param bool $in_same_term Optional. Whether post should be in a same taxonomy term.
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
* @param bool $previous Optional. Whether to retrieve previous post.
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
+ * @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
*/
function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
global $wpdb;
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
* @param bool $previous Optional. Whether to display link to previous or next post. Default true.
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return string The adjacent post relational link URL.
+ * @return string|void The adjacent post relational link URL.
*/
function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
if ( $previous && is_attachment() && $post = get_post() )
* @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
* @param bool $start Optional. Whether to retrieve first or last post.
* @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return mixed Array containing the boundary post object if successful, null otherwise.
+ * @return null|array Array containing the boundary post object if successful, null otherwise.
*/
function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {
$post = get_post();
*
* @since 1.5.0
*
- * @param int $pagenum Optional. Page ID.
- * @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
-* Otherwise, prepares the URL with esc_url_raw().
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int $pagenum Optional. Page ID.
+ * @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
+* Otherwise, prepares the URL with esc_url_raw().
* @return string The link URL for the given page number.
*/
function get_pagenum_link($pagenum = 1, $escape = true ) {
*
* @since 2.0.10
*
+ * @global int $paged
+ *
* @param int $max_page Optional. Max pages.
- * @return string The link URL for next posts page.
+ * @return string|void The link URL for next posts page.
*/
function get_next_posts_page_link($max_page = 0) {
global $paged;
*
* @since 0.71
*
- * @param int $max_page Optional. Max pages.
- * @param boolean $echo Optional. Echo or return;
- * @return string The link URL for next posts page if `$echo = false`.
+ * @param int $max_page Optional. Max pages.
+ * @param bool $echo Optional. Echo or return;
+ * @return string|void The link URL for next posts page if `$echo = false`.
*/
function next_posts( $max_page = 0, $echo = true ) {
$output = esc_url( get_next_posts_page_link( $max_page ) );
*
* @since 2.7.0
*
- * @param string $label Content for link text.
- * @param int $max_page Optional. Max pages.
- * @return string|null HTML-formatted next posts page link.
+ * @global int $paged
+ * @global WP_Query $wp_query
+ *
+ * @param string $label Content for link text.
+ * @param int $max_page Optional. Max pages.
+ * @return string|void HTML-formatted next posts page link.
*/
function get_next_posts_link( $label = null, $max_page = 0 ) {
global $paged, $wp_query;
*
* @since 0.71
*
- * @param string $label Content for link text.
- * @param int $max_page Optional. Max pages.
+ * @param string $label Content for link text.
+ * @param int $max_page Optional. Max pages.
*/
function next_posts_link( $label = null, $max_page = 0 ) {
echo get_next_posts_link( $label, $max_page );
*
* @since 2.0.10
*
- * @return string|null The link for the previous posts page.
+ * @global int $paged
+ *
+ * @return string|void The link for the previous posts page.
*/
function get_previous_posts_page_link() {
global $paged;
*
* @since 0.71
*
- * @param boolean $echo Optional. Echo or return;
- * @return string The previous posts page link if `$echo = false`.
+ * @param bool $echo Optional. Echo or return;
+ * @return string|void The previous posts page link if `$echo = false`.
*/
function previous_posts( $echo = true ) {
$output = esc_url( get_previous_posts_page_link() );
*
* @since 2.7.0
*
+ * @global int $paged
+ *
* @param string $label Optional. Previous page link text.
- * @return string|null HTML-formatted previous page link.
+ * @return string|void HTML-formatted previous page link.
*/
function get_previous_posts_link( $label = null ) {
global $paged;
*
* @since 2.8.0
*
+ * @global WP_Query $wp_query
+ *
* @param string|array $args Optional args.
* @return string The posts link navigation.
*/
*
* @since 0.71
*
- * @param string $sep Optional. Separator for posts navigation links.
+ * @param string $sep Optional. Separator for posts navigation links.
* @param string $prelabel Optional. Label for previous pages.
* @param string $nxtlabel Optional Label for next pages.
*/
*
* @since 2.7.0
*
- * @param int $pagenum Optional. Page number.
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param int $pagenum Optional. Page number.
* @param int $max_page Optional. The maximum number of comment pages.
* @return string The comments page number link URL.
*/
*
* @param string $result The comments page number link.
*/
- $result = apply_filters( 'get_comments_pagenum_link', $result );
-
- return $result;
+ return apply_filters( 'get_comments_pagenum_link', $result );
}
/**
*
* @since 2.7.1
*
- * @param string $label Optional. Label for link text.
- * @param int $max_page Optional. Max page.
- * @return string|null HTML-formatted link for the next page of comments.
+ * @global WP_Query $wp_query
+ *
+ * @param string $label Optional. Label for link text.
+ * @param int $max_page Optional. Max page.
+ * @return string|void HTML-formatted link for the next page of comments.
*/
function get_next_comments_link( $label = '', $max_page = 0 ) {
global $wp_query;
*
* @since 2.7.0
*
- * @param string $label Optional. Label for link text.
- * @param int $max_page Optional. Max page.
+ * @param string $label Optional. Label for link text.
+ * @param int $max_page Optional. Max page.
*/
function next_comments_link( $label = '', $max_page = 0 ) {
echo get_next_comments_link( $label, $max_page );
* @since 2.7.1
*
* @param string $label Optional. Label for comments link text.
- * @return string|null HTML-formatted link for the previous page of comments.
+ * @return string|void HTML-formatted link for the previous page of comments.
*/
function get_previous_comments_link( $label = '' ) {
if ( !is_singular() || !get_option('page_comments') )
* @see paginate_links()
* @since 2.7.0
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @param string|array $args Optional args. See paginate_links().
- * @return string Markup for pagination links.
+ * @return string|void Markup for pagination links.
*/
function paginate_comments_links($args = array()) {
global $wp_rewrite;
*
* @since 2.6.0
*
+ * @global bool $is_IE
+ * @global string $wp_version
+ * @global WP_Press_This $wp_press_this
+ *
* @return string The Press This bookmarklet link URL.
*/
function get_shortcut_link() {
*
* @since 3.0.0
*
+ * @global string $pagenow
+ *
* @param int $blog_id Optional. Blog ID. Default null (current blog).
* @param string $path Optional. Path relative to the home URL. Default empty.
* @param string|null $orig_scheme Optional. Scheme to give the home URL context. Accepts
*
* @since 3.0.0
*
- * @param string $path Optional. Path relative to the site url.
+ * @param string $path Optional. Path relative to the site url.
* @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
* @return string Site url link with optional path appended.
*/
*
* @since 2.6.0
*
- * @param string $path Optional path relative to the admin url.
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended.
*/
*
* @since 2.6.0
*
- * @param string $path Optional. Path relative to the includes url.
+ * @param string $path Optional. Path relative to the includes url.
* @param string $scheme Optional. Scheme to give the includes url context.
* @return string Includes url link with optional path appended.
*/
*
* @since 3.0.0
*
- * @param string $path Optional. Path relative to the site url.
+ * @param string $path Optional. Path relative to the site url.
* @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
* @return string Site url link with optional path appended.
*/
*
* @since 3.0.0
*
- * @param string $path Optional path relative to the admin url.
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended.
*/
*
* @since 3.0.0
*
- * @param string $path Optional path relative to the admin url.
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended.
*/
*
* @since 3.1.0
*
- * @param string $path Optional path relative to the admin url.
+ * @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended.
*/
*
* @since 3.4.0
*
- * @param string $url Absolute url that includes a scheme
+ * @param string $url Absolute url that includes a scheme
* @param string $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
* @return string $url URL with chosen scheme.
*/
*
* @since 3.1.0
*
- * @param int $user_id Optional. User ID. Defaults to current user.
- * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
- * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
+ * @param int $user_id Optional. User ID. Defaults to current user.
+ * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
+ * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Dashboard url link with optional path appended.
*/
function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) {
* Output rel=canonical for singular queries.
*
* @since 2.9.0
+ *
+ * @global WP_Query $wp_the_query
*/
function rel_canonical() {
if ( !is_singular() )
*
* @since 3.0.0.
*
- * @param int $id A post or blog id. Default is 0, which means the current post or blog.
- * @param string $context Whether the id is a 'blog' id, 'post' id, or 'media' id. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'.
- * @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
+ * @global WP_Query $wp_query
+ *
+ * @param int $id A post or blog id. Default is 0, which means the current post or blog.
+ * @param string $context Whether the id is a 'blog' id, 'post' id, or 'media' id.
+ * If 'post', the post_type of the post is consulted.
+ * If 'query', the current query is consulted to determine the id and context.
+ * Default is 'post'.
+ * @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
* @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
*/
function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
*
* @since 3.0.0
*
- * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
- * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
+ * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
+ * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
* @param string $before Optional HTML to display before the link.
- * @param string $after Optional HTML to display after the link.
+ * @param string $after Optional HTML to display after the link.
*/
function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
$post = get_post();
'r' => $args['rating'],
);
- $url = sprintf( 'http://%d.gravatar.com/avatar/%s', $gravatar_server, $email_hash );
+ if ( is_ssl() ) {
+ $url = 'https://secure.gravatar.com/avatar/' . $email_hash;
+ } else {
+ $url = sprintf( 'http://%d.gravatar.com/avatar/%s', $gravatar_server, $email_hash );
+ }
$url = add_query_arg(
rawurlencode_deep( array_filter( $url_args ) ),
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff