Merge branch 'marked-hook' into 'master'

add plugin hooks invoked when articles get un/marked or un/published

See merge request tt-rss/tt-rss!123

1 files changed, 22 insertions, 0 deletions

diff --git a/classes/Plugin.php b/classes/Plugin.php
index 62211f338..3165d62f4 100644
--- a/classes/Plugin.php
+++ b/classes/Plugin.php
@@ -713,4 +713,26 @@ abstract class Plugin {
 		return false;
 	}
 
+	/** Invoked after passed article IDs were either marked (i.e. starred) or unmarked.
+	 *
+	 * **Note** resulting state of the articles is not passed to this function (because
+	 * tt-rss may do invert operation on ID range), you will need to get this from the database.
+	 * @param array<int> $article_ids ref_ids
+	 * @return void
+	 */
+	function hook_articles_mark_toggled(array $article_ids) {
+		user_error("Dummy method invoked.", E_USER_ERROR);
+	}
+
+	/** Invoked after passed article IDs were either published or unpublished.
+	 *
+	 * **Note** resulting state of the articles is not passed to this function (because
+	 * tt-rss may do invert operation on ID range), you will need to get this from the database.
+	 *
+	 * @param array<int> $article_ids ref_ids
+	 * @return void
+	 */
+	function hook_articles_publish_toggled(array $article_ids) {
+		user_error("Dummy method invoked.", E_USER_ERROR);
+	}
 }