summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjustauser <[email protected]>2013-06-28 10:50:30 -0400
committerjustauser <[email protected]>2013-06-28 10:50:30 -0400
commit48c8e72008c01513985b53135297366b80b5b1f4 (patch)
tree269bfec1e48fa6cf6a6bb0fd78378947bff19b54
parent67631438353273ea260be518e627bc25500e01f2 (diff)
Add some explanaiton in the example about the content_preview field
-rw-r--r--plugins/query_headlines/init.php3
1 files changed, 3 insertions, 0 deletions
diff --git a/plugins/query_headlines/init.php b/plugins/query_headlines/init.php
index 2c8a402c2..5d71d0356 100644
--- a/plugins/query_headlines/init.php
+++ b/plugins/query_headlines/init.php
@@ -6,6 +6,9 @@ class Query_Headlines extends Plugin {
// - the array of elements that are returned by queryFeedHeadlines
// - the length that the caller wants to truncate the content preview to
// - a boolean that indicates if the caller is from an API call
+ // The field content_preview has been shortened and sanitized, as appropriate
+ // before the plugin is called. If you want to do your own preview handling
+ // use the content field and create the preview from that
//NOTE:**** You have to make this a system plugin if you want it to also work
// on API calls. If you just make it a user plugin it will work on web page output
// but not on API calls