“Function Reference/get author feed link”的版本间的差异

来自WordPress中文文档
跳转至: 导航搜索
(1个修订)
(Categorized page and added other information sections.)
第1行: 第1行:
 
== Description ==
 
== Description ==
Returns a link to the feed for all posts by the specified author. A particular feed can be requested, but if the feed parameter is left blank, it returns the 'rss2' feed link.
+
Retrieve the feed link for a given author.
 +
 
 +
Returns a link to the feed for all posts by a given author. A specific feed can be requested or left blank to get the default feed.
  
 
== Usage ==
 
== Usage ==
 +
%%%?php get_author_feed_link( $author_id, $feed ) ?%%%
  
%%% ?php get_author_feed_link('author_id', 'feed'); ? %%%
+
== Parameters ==
 +
{{Parameter|$author_id|integer|ID of an author.}}
 +
{{Parameter|$feed|string|Feed type.|optional|#39;#39;}}
 +
 
 +
== Return Values ==
 +
; (string) : Link to the feed for the author specified by tt$author_id/tt.
  
 
== Examples ==
 
== Examples ==
 
 
=== Default Usage ===
 
=== Default Usage ===
Returns the rss2 feed link for post by author 2  
+
Returns the rss2 feed link for post by author 2.
  
 
pre ?php get_author_feed_link('2', ''); ?/pre
 
pre ?php get_author_feed_link('2', ''); ?/pre
  
== Parameters ==
+
== Note ==
 +
* Currently the parameter 'ttfeed/tt' is not evaluated by the function.
 +
 
 +
== Change Log ==
 +
Since: 2.5.0
 +
 
 +
== Source File ==
 +
!-- Need links to current source code files --
 +
ttget_author_feed_link()/tt is located in ttwp-includes/link-template.php/tt.
  
; author_id : (''string'') Author ID of feed link to return.
+
== Related ==
; feed : (''string'') Type of feed; possible values: rss, atom, rdf. Default: blank (returns rss2)
+
!--
 +
    To Do:
 +
    Need to find related functions.
 +
    Need to create groups of functions and create templates to add them to a page quickly.
 +
    Some functions may be related to many groups of functions.
 +
--
  
== Note ==
+
[[Category:Functions]]
Currently the parameter 'feed' is not evaluted by the function.
 

2009年3月24日 (二) 06:18的版本

Description

Retrieve the feed link for a given author.

Returns a link to the feed for all posts by a given author. A specific feed can be requested or left blank to get the default feed.

Usage

%%%?php get_author_feed_link( $author_id, $feed ) ?%%%

Parameters

tt$author_id/tt
(integer) (required) ID of an author.
Default: Nonenoinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Notes

This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called: prenowiki检查到模板循环:模板:Parameter/nowiki/pre 检查到模板循环:模板:Parameter

The usage of this template is below: prenowiki检查到模板循环:模板:Parameter/nowiki/pre Let's take a closer look at the parameters..

name
The name of the parameter.
datatype
The datatype that should be given for this parameter when called.
  • string
  • integer
  • boolean
  • mixed
description
A short description of the parameter.
importance
Set this parameter to optional if the parameter is optional. Otherwise, do not declare this parameter—it defaults to required.
  • required
  • optional
default
If this parameter is optional, ttdefault/tt is the value that will be used if the parameter is not declared.

wordpress.org.cn /div /noinclude

tt$feed/tt
(string) (optional) Feed type.
Default: #39;#39;noinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Notes

This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called: prenowiki检查到模板循环:模板:Parameter/nowiki/pre 检查到模板循环:模板:Parameter

The usage of this template is below: prenowiki检查到模板循环:模板:Parameter/nowiki/pre Let's take a closer look at the parameters..

name
The name of the parameter.
datatype
The datatype that should be given for this parameter when called.
  • string
  • integer
  • boolean
  • mixed
description
A short description of the parameter.
importance
Set this parameter to optional if the parameter is optional. Otherwise, do not declare this parameter—it defaults to required.
  • required
  • optional
default
If this parameter is optional, ttdefault/tt is the value that will be used if the parameter is not declared.

wordpress.org.cn /div /noinclude

Return Values

(string) 
Link to the feed for the author specified by tt$author_id/tt.

Examples

Default Usage

Returns the rss2 feed link for post by author 2.

pre ?php get_author_feed_link('2', ); ?/pre

Note

  • Currently the parameter 'ttfeed/tt' is not evaluated by the function.

Change Log

Since: 2.5.0

Source File

!-- Need links to current source code files -- ttget_author_feed_link()/tt is located in ttwp-includes/link-template.php/tt.

Related

!--

   To Do:
   Need to find related functions.
   Need to create groups of functions and create templates to add them to a page quickly.
   Some functions may be related to many groups of functions.

--