gcn-add-page-icon.php: Updated header annotation with description and more docs.

Author: veryspry

gc-notion/gcn-add-page-emoji-icon.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Gravity Connect // Notion // Add Page Emoji Icon
+ *
+ * This snippet demonstrates how to add an emoji icon to a Notion page
+ * when a form entry is being added to or edited in Notion.
+ *
+ * Instructions:
+ *   1. Modify the filter name to scope as needed. (see filter reference https://gravitywiz.com/documentation/gcn_notion_page_data/)
+ *   2. Update the $emoji variable to change the icon.
+ *
+ * Installation:
+ *   1. Install per https://gravitywiz.com/documentation/how-do-i-install-a-snippet/
+ *
+ * References:
+ *   * GC Notion: https://gravitywiz.com/documentation/gravity-connect-notion/
+ *   * Notion page POST reference: https://developers.notion.com/reference/post-page
+ *
+ * @since 1.0-beta-1.9
+ */
+
+/**
+ * Alternatively, you can use the `gcn_notion_page_data_add` or `gcn_notion_page_data_update` filters
+ * separately to add/change the icon only when adding or updating a page.
+ *
+ * The filter also supports FORM_ID and FEED_ID modifiers to allow easy scoping to specific forms and feeds.
+ */
+add_filter( 'gcn_notion_page_data', function( $page_data, $form, $entry, $feed ) {
+	/**
+	 * Modify the $emoji variable to change the icon.
+	 * Note that the Notion API requires a single emoji character.
+	 */
+	$emoji = '🦚';
+
+	$page_data['icon'] = array(
+		'type'  => 'emoji',
+		'emoji' => $emoji,
+	);
+
+	return $page_data;
+}, 10, 4 );