]> git.wh0rd.org Git - tt-rss.git/commitdiff
Add some explanaiton in the example about the content_preview field
authorjustauser <justausr@hotmail.com>
Fri, 28 Jun 2013 14:50:30 +0000 (10:50 -0400)
committerjustauser <justausr@hotmail.com>
Fri, 28 Jun 2013 14:50:30 +0000 (10:50 -0400)
plugins/query_headlines/init.php

index 2c8a402c2933443cb96991c7f5943187b7902479..5d71d0356eed697b5457d4f808f3ea96655c81b3 100644 (file)
@@ -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