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

来自WordPress中文文档
跳转至: 导航搜索
(1个修订)
(Fixed inpage links)
第3行: 第3行:
  
 
== Usage ==
 
== Usage ==
%%%?php get_comment_link( $comment, $args ) ?%%%
+
%%%<?php get_comment_link( $comment, $args ) ?>%%%
  
 
== Parameters ==
 
== Parameters ==
{{Parameter|$comment|object#124;string#124;integer|Comment to retrieve.|optional|null}}
+
{{Parameter|$comment|object&#124;string&#124;integer|Comment to retrieve.|optional|null}}
{{Parameter|$args|array|Optional args.|optional|array}}
+
{{Parameter|$args|mixed|Optional arguments (see [[Function_Reference/get_comment_link#Default_Arguments|Default Arguments]].)|optional|array (see [[Function_Reference/get_comment_link#Default_Arguments|Default Arguments]])}}
  
 
== Return Values ==
 
== Return Values ==
第13行: 第13行:
  
 
== Examples ==
 
== Examples ==
!-- Need creative examples. Feel free to link to external examples. --
+
<!-- Need creative examples. Feel free to link to external examples. -->
 +
 
 +
== Default Arguments ==
 +
The following default arguments are used unless found in the optional <tt>$args</tt> argument:
 +
 
 +
;page : The zero-based index for the page where the comment should appear. Defaults to <tt>0</tt>. '''Note''': for backward compatibility the entire <tt>$args</tt> argument is treated as an integer and used for this argument if it is not found to be an array.
 +
 
 +
;type : The type of comment (not used directly). Defaults to <tt>'all'</tt>.
 +
 
 +
;per_page : Number of comments per page. Defaults to <tt>0</tt>.
 +
 
 +
;max_depth : Maximum depth to be considered for comments, when threaded (not used directly). Defaults to <tt><nowiki>''</nowiki></tt>
 +
 
 +
== Filters ==
 +
* <tt>get_comment_link</tt>
  
 
== Notes ==
 
== Notes ==
* Uses: [[Function_Reference/get_comment|ttget_comment()/tt]] to retrieve tt$comment/tt.
+
* Uses: [[Function_Reference/get_comment|<tt>get_comment()</tt>]] to retrieve <tt>$comment</tt>.
* Uses global: (ttunknown/tt) tt$wp_rewrite/tt
+
* Uses global: (<tt>unknown</tt>) <tt>$wp_rewrite</tt>
* Uses global: (ttunknown/tt) tt$in_comment_loop/tt
+
* Uses global: (<tt>unknown</tt>) <tt>$in_comment_loop</tt>
  
 
== Change Log ==
 
== Change Log ==
第24行: 第38行:
  
 
== Source File ==
 
== Source File ==
!-- Need links to current source code files --
+
<tt>get_comment_link()</tt> is located in {{Trac|wp-includes/comment-template.php}}.
ttget_comment_link()/tt is located in ttwp-includes/comment-template.php/tt.
 
  
 
== Related ==
 
== Related ==
!--
+
<!--
 
     To Do:
 
     To Do:
 
     Need to find related functions.
 
     Need to find related functions.
 
     Need to create groups of functions and create templates to add them to a page quickly.
 
     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.
 
     Some functions may be related to many groups of functions.
--
+
-->
 +
 
 +
{{Tag Footer}}
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:New_page_created]]
 
[[Category:New_page_created]]

2011年1月30日 (日) 01:44的版本

Description

Retrieve the link to a given comment.

Usage

%%%<?php get_comment_link( $comment, $args ) ?>%%%

Parameters

tt$comment/tt
(object|string|integer) (optional) Comment to retrieve.
Default: nullnoinclude

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$args/tt
(mixed) (optional) Optional arguments (see Default Arguments.)
Default: array (see Default Arguments)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) 
The permalink to the current comment

Examples

Default Arguments

The following default arguments are used unless found in the optional $args argument:

page 
The zero-based index for the page where the comment should appear. Defaults to 0. Note: for backward compatibility the entire $args argument is treated as an integer and used for this argument if it is not found to be an array.
type 
The type of comment (not used directly). Defaults to 'all'.
per_page 
Number of comments per page. Defaults to 0.
max_depth 
Maximum depth to be considered for comments, when threaded (not used directly). Defaults to ''

Filters

  • get_comment_link

Notes

  • Uses: get_comment() to retrieve $comment.
  • Uses global: (unknown) $wp_rewrite
  • Uses global: (unknown) $in_comment_loop

Change Log

Since: 1.5.0

Source File

get_comment_link() is located in onlyincludecodewp-includes/comment-template.php/code/onlyinclude

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

Template Description

Link to the source code on http://core.trac.wordpress.org/browser/.

Parameters

  1. filename
  2. (option) path to codetag/code (version) or codetrunk/code. This option is only used for a new function.br /Default: codetrunk/code -- trunk is the latest bleeding edge development version of WordPress.

Usage

Link to the stable version: pre检查到模板循环:模板:Trac/pre

Link to trunk: pre检查到模板循环:模板:Trac/pre

/div

wordpress.org.cn.

Related

includeonlydiv style=clear:both; background-color:#F7F7F7; border:1px solid #CCCCCC; color:#000000; padding:7px; margin:0.5em auto 0.5em auto; vertical-align:middle;See also index of Function Reference and index of Template Tags./div/includeonlynoinclude

Description

This Template is used by Codex:Template Messages.

Usage

pre 检查到模板循环:模板:Message /pre

Result

检查到模板循环:模板:Message

/noinclude