index.js 4.93 KB
/**
 * LearnDash Block ld-usermeta
 *
 * @since 2.5.9
 * @package LearnDash
 */

/**
 * LearnDash block functions
 */
 import {
	ldlms_get_post_edit_meta
} from '../ldlms.js';

/**
 * Internal block libraries
 */
import { __, _x, sprintf } from '@wordpress/i18n';
import { registerBlockType } from '@wordpress/blocks';
import { InspectorControls } from '@wordpress/block-editor';
import { PanelBody, PanelRow, SelectControl, TextControl, ToggleControl } from '@wordpress/components';
import ServerSideRender from '@wordpress/server-side-render';
import { useMemo } from "@wordpress/element";

const block_key   = 'learndash/ld-usermeta';
const block_title = __('LearnDash User meta', 'learndash');

registerBlockType(block_key, {
	title: block_title,
	description: __("This block displays User meta field", "learndash"),
	icon: "id",
	category: "learndash-blocks",
	example: {
		attributes: {
			example_show: 1,
		},
	},
	supports: {
		customClassName: false,
	},
	attributes: {
		field: {
			type: "string",
			default: "user_login",
		},
		user_id: {
			type: "string",
			default: "",
		},
		preview_show: {
			type: "boolean",
			default: 1,
		},
		preview_user_id: {
			type: "string",
			default: "",
		},
		editing_post_meta: {
			type: "object",
		},
	},
	edit: (props) => {
		const {
			attributes: { field, user_id, preview_show, preview_user_id },
			setAttributes,
		} = props;

		const field_field = (
			<SelectControl
				key="field"
				value={field}
				label={__("Field", "learndash")}
				options={[
					{
						label: __("User Login", "learndash"),
						value: "user_login",
					},
					{
						label: __("User First Name", "learndash"),
						value: "first_name",
					},
					{
						label: __("User Last Name", "learndash"),
						value: "last_name",
					},
					{
						label: __("User First and Last Name", "learndash"),
						value: "first_last_name",
					},
					{
						label: __("User Display Name", "learndash"),
						value: "display_name",
					},
					{
						label: __("User Nicename", "learndash"),
						value: "user_nicename",
					},
					{
						label: __("User Nickname", "learndash"),
						value: "nickname",
					},
					{
						label: __("User Email", "learndash"),
						value: "user_email",
					},
					{
						label: __("User URL", "learndash"),
						value: "user_url",
					},
					{
						label: __("User Description", "learndash"),
						value: "description",
					},
				]}
				onChange={(field) => setAttributes({ field })}
			/>
		);

		const field_user_id = (
			<TextControl
				label={__("User ID", "learndash")}
				help={__(
					"Enter specific User ID. Leave blank for current User.",
					"learndash"
				)}
				value={user_id || ""}
				type={"number"}
				onChange={function (new_user_id) {
					if (new_user_id != "" && new_user_id < 0) {
						setAttributes({ user_id: "0" });
					} else {
						setAttributes({ user_id: new_user_id });
					}
				}}
			/>
		);

		const panel_preview = (
			<PanelBody title={__("Preview", "learndash")} initialOpen={false}>
				<ToggleControl
					label={__("Show Preview", "learndash")}
					checked={!!preview_show}
					onChange={(preview_show) => setAttributes({ preview_show })}
				/>
				<PanelRow className="learndash-block-error-message">
					{__("Preview settings are not saved.", "learndash")}
				</PanelRow>
				<TextControl
					label={__("Preview User ID", "learndash")}
					help={__("Enter a User ID to test preview", "learndash")}
					value={preview_user_id || ""}
					type={"number"}
					onChange={function (preview_new_user_id) {
						if (preview_new_user_id != "" && preview_new_user_id < 0) {
							setAttributes({ preview_user_id: "0" });
						} else {
							setAttributes({ preview_user_id: preview_new_user_id });
						}
					}}
				/>
			</PanelBody>
		);

		const inspectorControls = (
			<InspectorControls key="controls">
				<PanelBody title={__("Settings", "learndash")}>
					{field_user_id}
					{field_field}
				</PanelBody>
				{panel_preview}
			</InspectorControls>
		);

		function get_default_message() {
			return sprintf(
				// translators: placeholder: block_title.
				_x(
					"%s block output shown here",
					"placeholder: block_title",
					"learndash"
				),
				block_title
			);
		}

		function empty_response_placeholder_function(props) {
			return get_default_message();
		}

		function do_serverside_render(attributes) {
			if (attributes.preview_show == true) {
				// We add the meta so the server knowns what is being edited.
				attributes.editing_post_meta = ldlms_get_post_edit_meta();

				return (
					<ServerSideRender
						block={block_key}
						attributes={attributes}
						key={block_key}
						EmptyResponsePlaceholder={empty_response_placeholder_function}
					/>
				);
			} else {
				return get_default_message();
			}
		}

		return [
			inspectorControls,
			useMemo(() => do_serverside_render(props.attributes), [props.attributes]),
		];
	},

	save: (props) => {
		delete props.attributes.example_show;
		delete props.attributes.editing_post_meta;
	},
});